update readme

This commit is contained in:
Alex Pliutau 2021-01-20 10:30:37 +01:00
parent f807b7d046
commit df9918548b

158
README.md
View File

@ -2,88 +2,100 @@
[![Build Status](https://travis-ci.org/plutov/paypal.svg?branch=master)](https://travis-ci.org/plutov/paypal) [![Build Status](https://travis-ci.org/plutov/paypal.svg?branch=master)](https://travis-ci.org/plutov/paypal)
[![Godoc](http://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/plutov/paypal) [![Godoc](http://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/plutov/paypal)
### Go client for PayPal REST API ## Go client for PayPal REST API
### Coverage ## Coverage
* POST /v1/oauth2/token * POST /v1/oauth2/token
* POST /v1/identity/openidconnect/tokenservice * POST /v1/identity/openidconnect/tokenservice
* GET /v1/identity/openidconnect/userinfo/?schema=**SCHEMA** * GET /v1/identity/openidconnect/userinfo/?schema=**SCHEMA**
* POST /v1/payments/payouts * POST /v1/payments/payouts
* GET /v1/payments/payouts/**ID** * GET /v1/payments/payouts/**ID**
* GET /v1/payments/payouts-item/**ID** * GET /v1/payments/payouts-item/**ID**
* POST /v1/payments/payouts-item/**ID**/cancel * POST /v1/payments/payouts-item/**ID**/cancel
* GET /v1/payment-experience/web-profiles * GET /v1/payment-experience/web-profiles
* POST /v1/payment-experience/web-profiles * POST /v1/payment-experience/web-profiles
* GET /v1/payment-experience/web-profiles/**ID** * GET /v1/payment-experience/web-profiles/**ID**
* PUT /v1/payment-experience/web-profiles/**ID** * PUT /v1/payment-experience/web-profiles/**ID**
* DELETE /v1/payment-experience/web-profiles/**ID** * DELETE /v1/payment-experience/web-profiles/**ID**
* GET /v2/payments/authorizations/**ID** * GET /v2/payments/authorizations/**ID**
* POST /v2/payments/authorizations/**ID**/capture * POST /v2/payments/authorizations/**ID**/capture
* POST /v2/payments/authorizations/**ID**/void * POST /v2/payments/authorizations/**ID**/void
* POST /v2/payments/authorizations/**ID**/reauthorize * POST /v2/payments/authorizations/**ID**/reauthorize
* GET /v1/payments/sale/**ID** * GET /v1/payments/sale/**ID**
* POST /v1/payments/sale/**ID**/refund * POST /v1/payments/sale/**ID**/refund
* GET /v2/payments/refund/**ID** * GET /v2/payments/refund/**ID**
* POST /v1/reporting/transactions * POST /v1/reporting/transactions
#Vault
* POST /v1/vault/credit-cards ### Vault
* DELETE /v1/vault/credit-cards/**ID**
* PATCH /v1/vault/credit-cards/**ID** * POST /v1/vault/credit-cards
* GET /v1/vault/credit-cards/**ID** * DELETE /v1/vault/credit-cards/**ID**
* GET /v1/vault/credit-cards * PATCH /v1/vault/credit-cards/**ID**
#Checkout * GET /v1/vault/credit-cards/**ID**
* POST /v2/checkout/orders * GET /v1/vault/credit-cards
* GET /v2/checkout/orders/**ID**
* PATCH /v2/checkout/orders/**ID** ### Checkout
* POST /v2/checkout/orders/**ID**/authorize
* POST /v2/checkout/orders/**ID**/capture * POST /v2/checkout/orders
#Billing plans (payments) * GET /v2/checkout/orders/**ID**
* GET /v1/payments/billing-plans * PATCH /v2/checkout/orders/**ID**
* POST /v1/payments/billing-plans * POST /v2/checkout/orders/**ID**/authorize
* PATCH /v1/payments/billing-plans/***ID*** * POST /v2/checkout/orders/**ID**/capture
* POST /v1/payments/billing-agreements
* POST /v1/payments/billing-agreements/***TOKEN***/agreement-execute ### Billing plans (payments)
#Notifications
* POST /v1/notifications/webhooks * GET /v1/payments/billing-plans
* GET /v1/notifications/webhooks * POST /v1/payments/billing-plans
* GET /v1/notifications/webhooks/**ID** * PATCH /v1/payments/billing-plans/***ID***
* PATCH /v1/notifications/webhooks/**ID** * POST /v1/payments/billing-agreements
* DELETE /v1/notifications/webhooks/**ID** * POST /v1/payments/billing-agreements/***TOKEN***/agreement-execute
* POST /v1/notifications/verify-webhook-signature
#Products (Catalog) ### Notifications
* POST /v1/catalogs/products * POST /v1/notifications/webhooks
* PATCH /v1/catalogs/products/**ID** * GET /v1/notifications/webhooks
* GET /v1/catalogs/products/**ID** * GET /v1/notifications/webhooks/**ID**
* GET /v1/catalogs/products * PATCH /v1/notifications/webhooks/**ID**
#Billing Plans (Subscriptions) * DELETE /v1/notifications/webhooks/**ID**
* POST /v1/billing/plans * POST /v1/notifications/verify-webhook-signature
* PATCH /v1/billing/plans/**ID**
* GET /v1/billing/plans/**ID** ### Products (Catalog)
* GET /v1/billing/plans
* POST /v1/billing/plans/**ID**/activate * POST /v1/catalogs/products
* POST /v1/billing/plans/**ID**/deactivate * PATCH /v1/catalogs/products/**ID**
* POST /v1/billing/plans/**ID**/update-pricing-schemes * GET /v1/catalogs/products/**ID**
#Subscriptions * GET /v1/catalogs/products
* POST /v1/billing/subscriptions
* PATCH /v1/billing/subscriptions/**ID** ### Billing Plans (Subscriptions)
* GET /v1/billing/subscriptions/**ID**
* POST /v1/billing/subscriptions/**ID**/activate * POST /v1/billing/plans
* POST /v1/billing/subscriptions/**ID**/cancel * PATCH /v1/billing/plans/**ID**
* POST /v1/billing/subscriptions/**ID**/revise * GET /v1/billing/plans/**ID**
* POST /v1/billing/subscriptions/**ID**/capture * GET /v1/billing/plans
* POST /v1/billing/subscriptions/**ID**/suspend * POST /v1/billing/plans/**ID**/activate
* GET /v1/billing/subscriptions/**ID**/transactions * POST /v1/billing/plans/**ID**/deactivate
* POST /v1/billing/plans/**ID**/update-pricing-schemes
### Subscriptions
* POST /v1/billing/subscriptions
* PATCH /v1/billing/subscriptions/**ID**
* GET /v1/billing/subscriptions/**ID**
* POST /v1/billing/subscriptions/**ID**/activate
* POST /v1/billing/subscriptions/**ID**/cancel
* POST /v1/billing/subscriptions/**ID**/revise
* POST /v1/billing/subscriptions/**ID**/capture
* POST /v1/billing/subscriptions/**ID**/suspend
* GET /v1/billing/subscriptions/**ID**/transactions
### Missing endpoints ### Missing endpoints
It is possible that some endpoints are missing in this SDK Client, but you can use built-in **paypal** functions to perform a request: **NewClient -> NewRequest -> SendWithAuth** It is possible that some endpoints are missing in this SDK Client, but you can use built-in **paypal** functions to perform a request: **NewClient -> NewRequest -> SendWithAuth**
### Usage ### Usage
```go ```go
// If using Go Modules import "github.com/plutov/paypal/v4"
// import "github.com/plutov/paypal/v4"
import "github.com/plutov/paypal"
// Create a client instance // Create a client instance
c, err := paypal.NewClient("clientID", "secretID", paypal.APIBaseSandBox) c, err := paypal.NewClient("clientID", "secretID", paypal.APIBaseSandBox)