paypal-server-sdk 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57ccf4a802a623251769dc25b3947371457e03c91cf3f40a1644b7073972a09b
-  data.tar.gz: 6f7fa9685e2e524b81e3479b29b3a9c732a13e47d90ccb041d930051d505bf62
+  metadata.gz: 384df7b8cdbd6c07409b2de2c58d791cf3c734063bb265c725533294641dab43
+  data.tar.gz: aa1e3012f01cf06e65da38895a2ce3dc11cf867a1971fe4f1f89401c87706ffd
 SHA512:
-  metadata.gz: e0b73e8c5b558d9ee4d156a56d2c7aa5bb0ad19f0c56c621d9dbe64bacabfa214f3b55508d86b9db2dc554de7d7aacb717d1edc7f284414513f9ae3b3894e24d
-  data.tar.gz: 67f44b93ff99d35c3e6d86776b083dac1060cff1d56216d46e9f49f9a88caf8b2eebe433c414e1e6aa8184217dd914479b4c8e648c10501667eb5495bbb7d6c3
+  metadata.gz: bd7a3566df23ff352223eb346a73a35b5ec5d097ab40bd023d472ae12554b17b3d3bef6a5b2dd308b8b1e89de20f886c1f8c3b7ee2f581eb12e0dd80e99f3afb
+  data.tar.gz: 2e4440a555149afce96d67f99b5adccc8f69b5653edb352d29105cc8b91a70345a537145cf8892879ad7c50127b256d299fa4617d3fef4e5d19b2c0dca32128e

data/README.md

@@ -5,60 +5,63 @@
 
 ### Important Notes
 
-- **Available Features:** This SDK currently contains only 3 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.
-- **API Changes:** Expect potential changes in APIs and features as we finalize the product.
+- **Available Features:** This SDK currently contains only 5 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.
 
 ### Information
 
 The PayPal Server SDK provides integration access to the PayPal REST APIs. The API endpoints are divided into distinct controllers:
 
-- Orders Controller: <a href="https://developer.paypal.com/docs/api/orders/v2/">Orders API v2</a>
-- Payments Controller: <a href="https://developer.paypal.com/docs/api/payments/v2/">Payments API v2</a>
-- Vault Controller: <a href="https://developer.paypal.com/docs/api/payment-tokens/v3/">Payment Method Tokens API v3</a> *Available in the US only.*
-
-Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://developer.paypal.com/docs/api/orders/v2/)
+- Orders Controller: [Orders API v2](https://developer.paypal.com/docs/api/orders/v2/)
+- Payments Controller: [Payments API v2](https://developer.paypal.com/docs/api/payments/v2)
+- Vault Controller: [Payment Method Tokens API v3](https://developer.paypal.com/docs/api/payment-tokens/v3/) *Available in the US only.*
+- Transaction Search Controller: [Transaction Search API v1](https://developer.paypal.com/docs/api/transaction-search/v1/)
+- Subscriptions Controller: [Subscriptions API v1](https://developer.paypal.com/docs/api/subscriptions/v1/)
 
 ## Install the Package
 
 Install the gem from the command line:
 
 ```bash
-gem install paypal-server-sdk -v 1.0.0
+gem install paypal-server-sdk -v 2.0.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'paypal-server-sdk', '1.0.0'
+gem 'paypal-server-sdk', '2.0.0'
 ```
 
-For additional gem details, see the [RubyGems page for the paypal-server-sdk gem](https://rubygems.org/gems/paypal-server-sdk/versions/1.0.0).
+For additional gem details, see the [RubyGems page for the paypal-server-sdk gem](https://rubygems.org/gems/paypal-server-sdk/versions/2.0.0).
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `environment` | `Environment` | The API environment. <br> **Default: `Environment.SANDBOX`** |
-| `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
-| `adapter` | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
-| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
-| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
-| `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
-| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
-| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
-| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
-| `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
-| `logging_configuration` | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
-| `client_credentials_auth_credentials` | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| environment | `Environment` | The API environment. <br> **Default: `Environment.SANDBOX`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
 
 The API client can be initialized as follows:
 
 ```ruby
-client = PaypalServerSdk::Client.new(
+require 'paypal_server_sdk'
+include PaypalServerSdk
+
+client = Client.new(
   client_credentials_auth_credentials: ClientCredentialsAuthCredentials.new(
     o_auth_client_id: 'OAuthClientId',
     o_auth_client_secret: 'OAuthClientSecret'
@@ -91,22 +94,34 @@ The SDK can be configured to use a different environment for making API calls. A
 
 This API uses the following authentication schemes.
 
-* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)
+* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/auth/oauth-2-client-credentials-grant.md)
 
 ## List of APIs
 
-* [Orders](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/controllers/orders.md)
-* [Payments](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/controllers/payments.md)
-* [Vault](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/controllers/vault.md)
+* [Transactionsearch](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/controllers/transactionsearch.md)
+* [Orders](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/controllers/orders.md)
+* [Payments](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/controllers/payments.md)
+* [Vault](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/controllers/vault.md)
+* [Subscriptions](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/controllers/subscriptions.md)
 
-## Classes Documentation
+## SDK Infrastructure
 
-* [Utility Classes](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/utility-classes.md)
-* [HttpResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/http-request.md)
-* [ApiResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/api-response.md)
-* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/logging-configuration.md)
-* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/request-logging-configuration.md)
-* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/response-logging-configuration.md)
-* [Abstract Logger](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/1.0.0/doc/abstract-logger.md)
+### Configuration
+
+* [ProxySettings](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/proxy-settings.md)
+* [AbstractLogger](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/api-response.md)
+* [ApiHelper](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/paypal/PayPal-Ruby-Server-SDK/tree/2.0.0/doc/date-time-helper.md)
 

data/lib/paypal_server_sdk/api_helper.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # API utility class

data/lib/paypal_server_sdk/client.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   #  paypal_server_sdk client class.
@@ -32,6 +32,18 @@ module PaypalServerSdk
       @vault ||= VaultController.new @global_configuration
     end
 
+    # Access to transaction_search controller.
+    # @return [TransactionSearchController] Returns the controller instance.
+    def transaction_search
+      @transaction_search ||= TransactionSearchController.new @global_configuration
+    end
+
+    # Access to subscriptions controller.
+    # @return [SubscriptionsController] Returns the controller instance.
+    def subscriptions
+      @subscriptions ||= SubscriptionsController.new @global_configuration
+    end
+
     # Access to o_auth_authorization controller.
     # @return [OAuthAuthorizationController] Returns the controller instance.
     def o_auth_authorization
@@ -42,7 +54,7 @@ module PaypalServerSdk
       connection: nil, adapter: :net_http_persistent, timeout: 60,
       max_retries: 0, retry_interval: 1, backoff_factor: 2,
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-      retry_methods: %i[get put], http_callback: nil,
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
       logging_configuration: nil, environment: Environment::SANDBOX,
       client_credentials_auth_credentials: nil, config: nil
     )
@@ -53,6 +65,7 @@ module PaypalServerSdk
                     backoff_factor: backoff_factor,
                     retry_statuses: retry_statuses,
                     retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings,
                     logging_configuration: logging_configuration,
                     environment: environment,
                     client_credentials_auth_credentials: client_credentials_auth_credentials

data/lib/paypal_server_sdk/configuration.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # An enum for SDK environments.
@@ -35,15 +35,15 @@ module PaypalServerSdk
       connection: nil, adapter: :net_http_persistent, timeout: 60,
       max_retries: 0, retry_interval: 1, backoff_factor: 2,
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-      retry_methods: %i[get put], http_callback: nil,
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
       logging_configuration: nil, environment: Environment::SANDBOX,
       client_credentials_auth_credentials: nil
     )
-
       super connection: connection, adapter: adapter, timeout: timeout,
             max_retries: max_retries, retry_interval: retry_interval,
             backoff_factor: backoff_factor, retry_statuses: retry_statuses,
             retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
             logging_configuration: logging_configuration
 
       # Current API environment
@@ -53,7 +53,7 @@ module PaypalServerSdk
       @client_credentials_auth_credentials = client_credentials_auth_credentials
 
       # Initializing OAuth 2 Client Credentials Grant credentials with the provided auth parameters
-     @client_credentials_auth_credentials = client_credentials_auth_credentials
+      @client_credentials_auth_credentials = client_credentials_auth_credentials
 
       # The Http Client to use for making requests.
       set_http_client CoreLibrary::FaradayClient.new(self)
@@ -62,8 +62,8 @@ module PaypalServerSdk
     def clone_with(connection: nil, adapter: nil, timeout: nil,
                    max_retries: nil, retry_interval: nil, backoff_factor: nil,
                    retry_statuses: nil, retry_methods: nil, http_callback: nil,
-                   logging_configuration: nil, environment: nil,
-                   client_credentials_auth_credentials: nil)
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, client_credentials_auth_credentials: nil)
       connection ||= self.connection
       adapter ||= self.adapter
       timeout ||= self.timeout
@@ -73,15 +73,17 @@ module PaypalServerSdk
       retry_statuses ||= self.retry_statuses
       retry_methods ||= self.retry_methods
       http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
       logging_configuration ||= self.logging_configuration
       environment ||= self.environment
-      client_credentials_auth_credentials ||= client_credentials_auth_credentials
+      client_credentials_auth_credentials ||= self.client_credentials_auth_credentials
 
       Configuration.new(
         connection: connection, adapter: adapter, timeout: timeout,
         max_retries: max_retries, retry_interval: retry_interval,
         backoff_factor: backoff_factor, retry_statuses: retry_statuses,
         retry_methods: retry_methods, http_callback: http_callback,
+        proxy_settings: proxy_settings,
         logging_configuration: logging_configuration, environment: environment,
         client_credentials_auth_credentials: client_credentials_auth_credentials
       )

data/lib/paypal_server_sdk/controllers/base_controller.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # BaseController.
@@ -10,7 +10,7 @@ module PaypalServerSdk
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'PayPal REST API Ruby SDK, Version: 1.0.0, on OS {os-info}'
+      'PayPal REST API Ruby SDK, Version: 2.0.0, on OS {os-info}'
     end
 
     def self.user_agent_parameters
@@ -31,13 +31,7 @@ module PaypalServerSdk
       @global_configuration = global_configuration
       @config = @global_configuration.client_configuration
       @http_call_back = @config.http_callback
-      @api_call = ApiCall.new(@global_configuration)
-    end
-
-    # Creates a new builder for the Api Call instance.
-    # @return [ApiCall] The instance of ApiCall.
-    def new_api_call_builder
-      @api_call.new_builder
+      @api_call = ApiCall.new(@global_configuration)
     end
 
     # Creates a new instance of the request builder.

data/lib/paypal_server_sdk/controllers/o_auth_authorization_controller.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # OAuthAuthorizationController
@@ -13,10 +13,10 @@ module PaypalServerSdk
     # space-delimited list.
     # @param [Hash] _field_parameters Additional optional form parameters are
     # supported by this endpoint.
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def request_token(options = {},
                       _field_parameters: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v1/oauth2/token',
                                      Server::DEFAULT)

data/lib/paypal_server_sdk/controllers/orders_controller.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # OrdersController
@@ -10,7 +10,8 @@ module PaypalServerSdk
     # payments to reduce risk and payment processing costs. For more information
     # about processing payments, see checkout or multiparty checkout. Note: For
     # error handling and troubleshooting, see Orders v2 errors.
-    # @param [OrderRequest] body Required parameter: Example:
+    # @param [OrderRequest] body Required parameter: TODO: type description
+    # here
     # @param [String] paypal_mock_response Optional parameter: PayPal's REST API
     # uses a request header to invoke negative testing in the sandbox. This
     # header configures the sandbox into a negative testing state for
@@ -21,9 +22,10 @@ module PaypalServerSdk
     # create order calls (E.g. Create Order Request with payment source
     # information like Card, PayPal.vault_id, PayPal.billing_agreement_id,
     # etc).
-    # @param [String] paypal_partner_attribution_id Optional parameter:
-    # Example:
-    # @param [String] paypal_client_metadata_id Optional parameter: Example:
+    # @param [String] paypal_partner_attribution_id Optional parameter: TODO:
+    # type description here
+    # @param [String] paypal_client_metadata_id Optional parameter: TODO: type
+    # description here
     # @param [String] prefer Optional parameter: The preferred server response
     # upon successful completion of the request. Value is: return=minimal. The
     # server returns a minimal response to optimize communication between the
@@ -33,9 +35,9 @@ module PaypalServerSdk
     # @param [String] paypal_auth_assertion Optional parameter: An
     # API-caller-provided JSON Web Token (JWT) assertion that identifies the
     # merchant. For details, see PayPal-Auth-Assertion.
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_order(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v2/checkout/orders',
                                      Server::DEFAULT)
@@ -86,9 +88,9 @@ module PaypalServerSdk
     # @param [String] fields Optional parameter: A comma-separated list of
     # fields that should be returned for the order. Valid filter field is
     # `payment_source`.
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_order(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/v2/checkout/orders/{id}',
                                      Server::DEFAULT)
@@ -117,36 +119,65 @@ module PaypalServerSdk
     end
 
     # Updates an order with a `CREATED` or `APPROVED` status. You cannot update
-    # an order with the `COMPLETED` status. To make an update, you must provide
-    # a `reference_id`. If you omit this value with an order that contains only
-    # one purchase unit, PayPal sets the value to `default` which enables you to
-    # use the path:
-    # \"/purchase_units/@reference_id=='default'/{attribute-or-object}\".
-    # Merchants and partners can add Level 2 and 3 data to payments to reduce
-    # risk and payment processing costs. For more information about processing
-    # payments, see checkout or multiparty checkout. Note: For error handling
-    # and troubleshooting, see Orders v2 errors. Patchable attributes or
-    # objects: Attribute Op Notes intent replace payer replace, add Using
-    # replace op for payer will replace the whole payer object with the value
-    # sent in request. purchase_units replace, add purchase_units[].custom_id
-    # replace, add, remove purchase_units[].description replace, add, remove
-    # purchase_units[].payee.email replace purchase_units[].shipping.name
-    # replace, add purchase_units[].shipping.email_address replace, add
-    # purchase_units[].shipping.phone_number replace, add
-    # purchase_units[].shipping.options replace, add
-    # purchase_units[].shipping.address replace, add
-    # purchase_units[].shipping.type replace, add
-    # purchase_units[].soft_descriptor replace, remove purchase_units[].amount
-    # replace purchase_units[].items replace, add, remove
-    # purchase_units[].invoice_id replace, add, remove
-    # purchase_units[].payment_instruction replace
-    # purchase_units[].payment_instruction.disbursement_mode replace By default,
-    # disbursement_mode is INSTANT.
-    # purchase_units[].payment_instruction.payee_receivable_fx_rate_id replace,
-    # add, remove purchase_units[].payment_instruction.platform_fees replace,
-    # add, remove purchase_units[].supplementary_data.airline replace, add,
-    # remove purchase_units[].supplementary_data.card replace, add, remove
-    # application_context.client_configuration replace, add
+    # an order with the `COMPLETED` status.<br/><br/>To make an update, you must
+    # provide a `reference_id`. If you omit this value with an order that
+    # contains only one purchase unit, PayPal sets the value to `default` which
+    # enables you to use the path:
+    # <code>\"/purchase_units/@reference_id=='default'/{attribute-or-object}\"</
+    # code>. Merchants and partners can add Level 2 and 3 data to payments to
+    # reduce risk and payment processing costs. For more information about
+    # processing payments, see <a
+    # href="https://developer.paypal.com/docs/checkout/advanced/processing/">che
+    # ckout</a> or <a
+    # href="https://developer.paypal.com/docs/multiparty/checkout/advanced/proce
+    # ssing/">multiparty checkout</a>.<blockquote><strong>Note:</strong> For
+    # error handling and troubleshooting, see <a
+    # href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#pa
+    # tch-order">Orders v2 errors</a>.</blockquote>Patchable attributes or
+    # objects:<br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th
+    # ></thead><tbody><tr><td><code>intent</code></td><td>replace</td><td></td><
+    # /tr><tr><td><code>payer</code></td><td>replace, add</td><td>Using replace
+    # op for <code>payer</code> will replace the whole <code>payer</code> object
+    # with the value sent in
+    # request.</td></tr><tr><td><code>purchase_units</code></td><td>replace,
+    # add</td><td></td></tr><tr><td><code>purchase_units[].custom_id</code></td>
+    # <td>replace, add,
+    # remove</td><td></td></tr><tr><td><code>purchase_units[].description</code>
+    # </td><td>replace, add,
+    # remove</td><td></td></tr><tr><td><code>purchase_units[].payee.email</code>
+    # </td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].shipping
+    # .name</code></td><td>replace,
+    # add</td><td></td></tr><tr><td><code>purchase_units[].shipping.email_addres
+    # s</code></td><td>replace,
+    # add</td><td></td></tr><tr><td><code>purchase_units[].shipping.phone_number
+    # </code></td><td>replace,
+    # add</td><td></td></tr><tr><td><code>purchase_units[].shipping.options</cod
+    # e></td><td>replace,
+    # add</td><td></td></tr><tr><td><code>purchase_units[].shipping.address</cod
+    # e></td><td>replace,
+    # add</td><td></td></tr><tr><td><code>purchase_units[].shipping.type</code><
+    # /td><td>replace,
+    # add</td><td></td></tr><tr><td><code>purchase_units[].soft_descriptor</code
+    # ></td><td>replace,
+    # remove</td><td></td></tr><tr><td><code>purchase_units[].amount</code></td>
+    # <td>replace</td><td></td></tr><tr><td><code>purchase_units[].items</code><
+    # /td><td>replace, add,
+    # remove</td><td></td></tr><tr><td><code>purchase_units[].invoice_id</code><
+    # /td><td>replace, add,
+    # remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instructio
+    # n</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].
+    # payment_instruction.disbursement_mode</code></td><td>replace</td><td>By
+    # default, <code>disbursement_mode</code> is
+    # <code>INSTANT</code>.</td></tr><tr><td><code>purchase_units[].payment_inst
+    # ruction.payee_receivable_fx_rate_id</code></td><td>replace, add,
+    # remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instructio
+    # n.platform_fees</code></td><td>replace, add,
+    # remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data
+    # .airline</code></td><td>replace, add,
+    # remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data
+    # .card</code></td><td>replace, add,
+    # remove</td><td></td></tr><tr><td><code>application_context.client_configur
+    # ation</code></td><td>replace, add</td><td></td></tr></tbody></table>
     # @param [String] id Required parameter: The ID of the order to update.
     # @param [String] paypal_mock_response Optional parameter: PayPal's REST API
     # uses a request header to invoke negative testing in the sandbox. This
@@ -155,10 +186,11 @@ module PaypalServerSdk
     # @param [String] paypal_auth_assertion Optional parameter: An
     # API-caller-provided JSON Web Token (JWT) assertion that identifies the
     # merchant. For details, see PayPal-Auth-Assertion.
-    # @param [Array[Patch]] body Optional parameter: Example:
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @param [Array[Patch]] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def patch_order(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PATCH,
                                      '/v2/checkout/orders/{id}',
                                      Server::DEFAULT)
@@ -198,7 +230,8 @@ module PaypalServerSdk
     # payment source.
     # @param [String] id Required parameter: The ID of the order for which the
     # payer confirms their intent to pay.
-    # @param [String] paypal_client_metadata_id Optional parameter: Example:
+    # @param [String] paypal_client_metadata_id Optional parameter: TODO: type
+    # description here
     # @param [String] paypal_auth_assertion Optional parameter: An
     # API-caller-provided JSON Web Token (JWT) assertion that identifies the
     # merchant. For details, see PayPal-Auth-Assertion.
@@ -208,10 +241,11 @@ module PaypalServerSdk
     # API caller and the server. A minimal response includes the id, status and
     # HATEOAS links. return=representation. The server returns a complete
     # resource representation, including the current state of the resource.
-    # @param [ConfirmOrderRequest] body Optional parameter: Example:
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @param [ConfirmOrderRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def confirm_order(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v2/checkout/orders/{id}/confirm-payment-source',
                                      Server::DEFAULT)
@@ -273,14 +307,16 @@ module PaypalServerSdk
     # API caller and the server. A minimal response includes the id, status and
     # HATEOAS links. return=representation. The server returns a complete
     # resource representation, including the current state of the resource.
-    # @param [String] paypal_client_metadata_id Optional parameter: Example:
+    # @param [String] paypal_client_metadata_id Optional parameter: TODO: type
+    # description here
     # @param [String] paypal_auth_assertion Optional parameter: An
     # API-caller-provided JSON Web Token (JWT) assertion that identifies the
     # merchant. For details, see PayPal-Auth-Assertion.
-    # @param [OrderAuthorizeRequest] body Optional parameter: Example:
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @param [OrderAuthorizeRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def authorize_order(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v2/checkout/orders/{id}/authorize',
                                      Server::DEFAULT)
@@ -352,14 +388,16 @@ module PaypalServerSdk
     # API caller and the server. A minimal response includes the id, status and
     # HATEOAS links. return=representation. The server returns a complete
     # resource representation, including the current state of the resource.
-    # @param [String] paypal_client_metadata_id Optional parameter: Example:
+    # @param [String] paypal_client_metadata_id Optional parameter: TODO: type
+    # description here
     # @param [String] paypal_auth_assertion Optional parameter: An
     # API-caller-provided JSON Web Token (JWT) assertion that identifies the
     # merchant. For details, see PayPal-Auth-Assertion.
-    # @param [OrderCaptureRequest] body Optional parameter: Example:
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @param [OrderCaptureRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def capture_order(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v2/checkout/orders/{id}/capture',
                                      Server::DEFAULT)
@@ -410,13 +448,14 @@ module PaypalServerSdk
     # Adds tracking information for an Order.
     # @param [String] id Required parameter: The ID of the order that the
     # tracking information is associated with.
-    # @param [OrderTrackerRequest] body Required parameter: Example:
+    # @param [OrderTrackerRequest] body Required parameter: TODO: type
+    # description here
     # @param [String] paypal_auth_assertion Optional parameter: An
     # API-caller-provided JSON Web Token (JWT) assertion that identifies the
     # merchant. For details, see PayPal-Auth-Assertion.
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def create_order_tracking(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v2/checkout/orders/{id}/track',
                                      Server::DEFAULT)
@@ -466,10 +505,11 @@ module PaypalServerSdk
     # @param [String] paypal_auth_assertion Optional parameter: An
     # API-caller-provided JSON Web Token (JWT) assertion that identifies the
     # merchant. For details, see PayPal-Auth-Assertion.
-    # @param [Array[Patch]] body Optional parameter: Example:
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @param [Array[Patch]] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def update_order_tracking(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PATCH,
                                      '/v2/checkout/orders/{id}/trackers/{tracker_id}',
                                      Server::DEFAULT)