paypal-server-sdk 1.0.0 → 2.0.0

data/lib/paypal_server_sdk/controllers/payments_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
   # PaymentsController
@@ -21,9 +21,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_authorized_payment(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/v2/payments/authorizations/{authorization_id}',
                                      Server::DEFAULT)
@@ -41,6 +41,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)
@@ -76,10 +80,11 @@ 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.
-    # @param [CaptureRequest] body Optional parameter: Example:
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @param [CaptureRequest] body Optional parameter: TODO: type description
+    # here
+    # @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)
@@ -141,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
@@ -161,10 +165,11 @@ 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.
-    # @param [ReauthorizeRequest] body Optional parameter: Example:
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @param [ReauthorizeRequest] body Optional parameter: TODO: type
+    # description here
+    # @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)
@@ -190,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)
@@ -230,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)
@@ -284,9 +293,9 @@ module PaypalServerSdk
     # 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.
+    # @return [ApiResponse] Complete http response with raw body and status code.
     def get_captured_payment(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/v2/payments/captures/{capture_id}',
                                      Server::DEFAULT)
@@ -344,10 +353,11 @@ 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.
-    # @param [RefundRequest] body Optional parameter: Example:
-    # @return [ApiResponse]  the complete http response with raw body and status code.
+    # @param [RefundRequest] body Optional parameter: TODO: type description
+    # here
+    # @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)
@@ -413,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)