paypal-server-sdk 1.1.0 → 2.0.0

data/lib/paypal_server_sdk/controllers/payments_controller.rb

@@ -1,11 +1,62 @@
 # 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
   # PaymentsController
   class PaymentsController < BaseController
+    # Shows details for an authorized payment, by ID.
+    # @param [String] authorization_id Required parameter: The ID of the
+    # authorized payment for which to show details.
+    # @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
+    # transactions that include the merchant.
+    # @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](/docs/api/reference/api-requests/#paypal-auth-asse
+    # rtion). Note:For three party transactions in which a partner is managing
+    # the API calls on behalf of a merchant, the partner must identify the
+    # merchant using either a PayPal-Auth-Assertion header or an access token
+    # with target_subject.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_authorized_payment(options = {})
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/payments/authorizations/{authorization_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(options['authorization_id'], key: 'authorization_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(options['paypal_mock_response'], key: 'PayPal-Mock-Response'))
+                   .header_param(new_parameter(options['paypal_auth_assertion'], key: 'PayPal-Auth-Assertion'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Oauth2')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentAuthorization.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Authentication failed due to missing authorization header, or'\
+                                  ' invalid authentication credentials.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The request failed because the caller has insufficient'\
+                                  ' permissions.',
+                                 ErrorException)
+                    .local_error('404',
+                                 'The request failed because the resource does not exist.',
+                                 ErrorException)
+                    .local_error('500',
+                                 'The request failed because an internal server error occurred.',
+                                 APIException)
+                    .local_error('default',
+                                 'The error response.',
+                                 ErrorException))
+        .execute
+    end
+
     # Captures an authorized payment, by ID.
     # @param [String] authorization_id Required parameter: The PayPal-generated
     # ID for the authorized payment to capture.
@@ -31,9 +82,9 @@ module PaypalServerSdk
     # with target_subject.
     # @param [CaptureRequest] body Optional parameter: TODO: type description
     # here
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def capture_authorized_payment(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v2/payments/authorizations/{authorization_id}/capture',
                                      Server::DEFAULT)
@@ -84,48 +135,6 @@ module PaypalServerSdk
         .execute
     end
 
-    # Shows details for a captured payment, by ID.
-    # @param [String] capture_id Required parameter: The PayPal-generated ID for
-    # the captured payment for which to show details.
-    # @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
-    # transactions that include the merchant.
-    # @return [ApiResponse]  the complete http response with raw body and status code.
-    def get_captured_payment(options = {})
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/v2/payments/captures/{capture_id}',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(options['capture_id'], key: 'capture_id')
-                                    .should_encode(true))
-                   .header_param(new_parameter(options['paypal_mock_response'], key: 'PayPal-Mock-Response'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('Oauth2')))
-        .response(new_response_handler
-                    .deserializer(APIHelper.method(:custom_type_deserializer))
-                    .deserialize_into(CapturedPayment.method(:from_hash))
-                    .is_api_response(true)
-                    .local_error('401',
-                                 'Authentication failed due to missing authorization header, or'\
-                                  ' invalid authentication credentials.',
-                                 ErrorException)
-                    .local_error('403',
-                                 'The request failed because the caller has insufficient'\
-                                  ' permissions.',
-                                 ErrorException)
-                    .local_error('404',
-                                 'The request failed because the resource does not exist.',
-                                 ErrorException)
-                    .local_error('500',
-                                 'The request failed because an internal server error occurred.',
-                                 APIException)
-                    .local_error('default',
-                                 'The error response.',
-                                 ErrorException))
-        .execute
-    end
-
     # Reauthorizes an authorized PayPal account payment, by ID. To ensure that
     # funds are still available, reauthorize a payment after its initial
     # three-day honor period expires. Within the 29-day authorization period,
@@ -137,8 +146,7 @@ module PaypalServerSdk
     # 29 days after the 3-day honor period. The allowed amount depends on
     # context and geography, for example in US it is up to 115% of the original
     # authorized amount, not to exceed an increase of $75 USD. Supports only the
-    # `amount` request parameter. Note: This request is currently not supported
-    # for Partner use cases.
+    # `amount` request parameter.
     # @param [String] authorization_id Required parameter: The PayPal-generated
     # ID for the authorized payment to reauthorize.
     # @param [String] paypal_request_id Optional parameter: The server stores
@@ -159,9 +167,9 @@ module PaypalServerSdk
     # with target_subject.
     # @param [ReauthorizeRequest] body Optional parameter: TODO: type
     # description here
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def reauthorize_payment(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v2/payments/authorizations/{authorization_id}/reauthorize',
                                      Server::DEFAULT)
@@ -187,6 +195,10 @@ module PaypalServerSdk
                                  'Authentication failed due to missing authorization header, or'\
                                   ' invalid authentication credentials.',
                                  ErrorException)
+                    .local_error('403',
+                                 'The request failed because the caller has insufficient'\
+                                  ' permissions.',
+                                 ErrorException)
                     .local_error('404',
                                  'The request failed because the resource does not exist.',
                                  ErrorException)
@@ -227,9 +239,9 @@ 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.
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def void_payment(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v2/payments/authorizations/{authorization_id}/void',
                                      Server::DEFAULT)
@@ -274,6 +286,48 @@ module PaypalServerSdk
         .execute
     end
 
+    # Shows details for a captured payment, by ID.
+    # @param [String] capture_id Required parameter: The PayPal-generated ID for
+    # the captured payment for which to show details.
+    # @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
+    # transactions that include the merchant.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_captured_payment(options = {})
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/payments/captures/{capture_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(options['capture_id'], key: 'capture_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(options['paypal_mock_response'], key: 'PayPal-Mock-Response'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Oauth2')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CapturedPayment.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Authentication failed due to missing authorization header, or'\
+                                  ' invalid authentication credentials.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The request failed because the caller has insufficient'\
+                                  ' permissions.',
+                                 ErrorException)
+                    .local_error('404',
+                                 'The request failed because the resource does not exist.',
+                                 ErrorException)
+                    .local_error('500',
+                                 'The request failed because an internal server error occurred.',
+                                 APIException)
+                    .local_error('default',
+                                 'The error response.',
+                                 ErrorException))
+        .execute
+    end
+
     # Refunds a captured payment, by ID. For a full refund, include an empty
     # payload in the JSON request body. For a partial refund, include an amount
     # object in the JSON request body.
@@ -301,9 +355,9 @@ module PaypalServerSdk
     # with target_subject.
     # @param [RefundRequest] body Optional parameter: TODO: type description
     # here
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def refund_captured_payment(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/v2/payments/captures/{capture_id}/refund',
                                      Server::DEFAULT)
@@ -354,53 +408,6 @@ module PaypalServerSdk
         .execute
     end
 
-    # Shows details for an authorized payment, by ID.
-    # @param [String] authorization_id Required parameter: The ID of the
-    # authorized payment for which to show details.
-    # @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
-    # transactions that include the merchant.
-    # @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](/docs/api/reference/api-requests/#paypal-auth-asse
-    # rtion). Note:For three party transactions in which a partner is managing
-    # the API calls on behalf of a merchant, the partner must identify the
-    # merchant using either a PayPal-Auth-Assertion header or an access token
-    # with target_subject.
-    # @return [ApiResponse]  the complete http response with raw body and status code.
-    def get_authorized_payment(options = {})
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/v2/payments/authorizations/{authorization_id}',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(options['authorization_id'], key: 'authorization_id')
-                                    .should_encode(true))
-                   .header_param(new_parameter(options['paypal_mock_response'], key: 'PayPal-Mock-Response'))
-                   .header_param(new_parameter(options['paypal_auth_assertion'], key: 'PayPal-Auth-Assertion'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('Oauth2')))
-        .response(new_response_handler
-                    .deserializer(APIHelper.method(:custom_type_deserializer))
-                    .deserialize_into(PaymentAuthorization.method(:from_hash))
-                    .is_api_response(true)
-                    .local_error('401',
-                                 'Authentication failed due to missing authorization header, or'\
-                                  ' invalid authentication credentials.',
-                                 ErrorException)
-                    .local_error('404',
-                                 'The request failed because the resource does not exist.',
-                                 ErrorException)
-                    .local_error('500',
-                                 'The request failed because an internal server error occurred.',
-                                 APIException)
-                    .local_error('default',
-                                 'The error response.',
-                                 ErrorException))
-        .execute
-    end
-
     # Shows details for a refund, by ID.
     # @param [String] refund_id Required parameter: The PayPal-generated ID for
     # the refund for which to show details.
@@ -416,9 +423,9 @@ module PaypalServerSdk
     # the API calls on behalf of a merchant, the partner must identify the
     # merchant using either a PayPal-Auth-Assertion header or an access token
     # with target_subject.
-    # @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_refund(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/v2/payments/refunds/{refund_id}',
                                      Server::DEFAULT)