onlinepayments-sdk-ruby 4.23.0 → 5.1.0

data/lib/onlinepayments/sdk/merchant/paymentlinks/payment_links_client.rb

@@ -1,114 +1,115 @@
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
 require 'onlinepayments/sdk/api_resource'
-require 'onlinepayments/sdk/response_exception'
-require 'onlinepayments/sdk/domain/create_payment_link_request'
+require 'onlinepayments/sdk/exception_factory'
+require 'onlinepayments/sdk/communication/response_exception'
 require 'onlinepayments/sdk/domain/error_response'
 require 'onlinepayments/sdk/domain/payment_link_response'
 
-module OnlinePayments::SDK
-  module Merchant
-    module PaymentLinks
+module OnlinePayments
+  module SDK
+    module Merchant
+      module PaymentLinks
+        # PaymentLinks client. Thread-safe.
+        class PaymentLinksClient < OnlinePayments::SDK::ApiResource
 
-      # PaymentLinks client. Thread-safe.
-      class PaymentLinksClient < OnlinePayments::SDK::ApiResource
+          # @param parent       [OnlinePayments::SDK::ApiResource]
+          # @param path_context [Hash, nil]
+          def initialize(parent, path_context)
+            super(parent: parent, path_context: path_context)
+          end
 
-        # @param parent        [OnlinePayments::SDK::ApiResource]
-        # @param path_context  [Hash, nil]
-        def initialize(parent, path_context = nil)
-          super(parent, path_context)
-        end
-
-        # Resource /v2/!{merchantId}/paymentlinks
-        # @param body    [OnlinePayments::SDK::Domain::CreatePaymentLinkRequest]
-        # @param context [OnlinePayments::SDK::CallContext]
-        # @return [OnlinePayments::SDK::Domain::PaymentLinkResponse]
-        # @raise [OnlinePayments::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
-        # @raise [OnlinePayments::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
-        # @raise [OnlinePayments::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
-        # @raise [OnlinePayments::SDK::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
-        #        or there was a conflict (HTTP status code 404, 409 or 410)
-        # @raise [OnlinePayments::SDK::PaymentPlatformException] if something went wrong at the payment platform,
-        #        the payment platform was unable to process a message from a downstream partner/acquirer,
-        #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-        # @raise [OnlinePayments::SDK::ApiException]if the payment platform returned any other error
-        def create_payment_link(body, context = nil)
-          uri = instantiate_uri('/v2/{merchantId}/paymentlinks')
-          @communicator.post(
-            uri,
-            client_headers,
-            nil,
-            body,
-            OnlinePayments::SDK::Domain::PaymentLinkResponse,
-            context
-          )
-        rescue ResponseException => e
-          error_type = OnlinePayments::SDK::Domain::ErrorResponse
-          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
-          raise create_exception(e.status_code, e.body, error_object, context)
-        end
+          # Resource /v2/!{merchantId}/paymentlinks - Create payment link
+          #
+          # @param body    [OnlinePayments::SDK::Domain::CreatePaymentLinkRequest]
+          # @param context [OnlinePayments::SDK::CallContext, nil]
+          # @return [OnlinePayments::SDK::Domain::PaymentLinkResponse]
+          # @raise [OnlinePayments::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+          # @raise [OnlinePayments::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+          # @raise [OnlinePayments::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+          # @raise [OnlinePayments::SDK::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
+          #        or there was a conflict (HTTP status code 404, 409 or 410)
+          # @raise [OnlinePayments::SDK::PlatformException] if something went wrong at the payment platform,
+          #        the payment platform was unable to process a message from a downstream partner/acquirer,
+          #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+          # @raise [OnlinePayments::SDK::ApiException] if the payment platform returned any other error
+          def create_payment_link(body, context = nil)
+            uri = instantiate_uri('/v2/{merchantId}/paymentlinks', nil)
+            @communicator.post(
+              uri,
+              client_headers,
+              nil,
+              body,
+              OnlinePayments::SDK::Domain::PaymentLinkResponse,
+              context)
+          rescue OnlinePayments::SDK::Communication::ResponseException => e
+            error_type = OnlinePayments::SDK::Domain::ErrorResponse
+            error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+            raise OnlinePayments::SDK.create_exception(e.status_code, e.body, error_object, context)
+          end
 
-        # Resource /v2/!{merchantId}/paymentlinks/!{paymentLinkId}
-        # @param payment_link_id [String]
-        # @param context         [OnlinePayments::SDK::CallContext]
-        # @return [OnlinePayments::SDK::Domain::PaymentLinkResponse]
-        # @raise [OnlinePayments::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
-        # @raise [OnlinePayments::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
-        # @raise [OnlinePayments::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
-        # @raise [OnlinePayments::SDK::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
-        #        or there was a conflict (HTTP status code 404, 409 or 410)
-        # @raise [OnlinePayments::SDK::PaymentPlatformException] if something went wrong at the payment platform,
-        #        the payment platform was unable to process a message from a downstream partner/acquirer,
-        #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-        # @raise [OnlinePayments::SDK::ApiException]if the payment platform returned any other error
-        def get_payment_link_by_id(payment_link_id, context = nil)
-          path_context = {
-            'paymentLinkId'.freeze => payment_link_id,
-          }
-          uri = instantiate_uri('/v2/{merchantId}/paymentlinks/{paymentLinkId}', path_context)
-          @communicator.get(
-            uri,
-            client_headers,
-            nil,
-            OnlinePayments::SDK::Domain::PaymentLinkResponse,
-            context
-          )
-        rescue ResponseException => e
-          error_type = OnlinePayments::SDK::Domain::ErrorResponse
-          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
-          raise create_exception(e.status_code, e.body, error_object, context)
-        end
+          # Resource /v2/!{merchantId}/paymentlinks/!{paymentLinkId} - Get payment link by ID
+          #
+          # @param payment_link_id [String]
+          # @param context         [OnlinePayments::SDK::CallContext, nil]
+          # @return [OnlinePayments::SDK::Domain::PaymentLinkResponse]
+          # @raise [OnlinePayments::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+          # @raise [OnlinePayments::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+          # @raise [OnlinePayments::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+          # @raise [OnlinePayments::SDK::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
+          #        or there was a conflict (HTTP status code 404, 409 or 410)
+          # @raise [OnlinePayments::SDK::PlatformException] if something went wrong at the payment platform,
+          #        the payment platform was unable to process a message from a downstream partner/acquirer,
+          #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+          # @raise [OnlinePayments::SDK::ApiException] if the payment platform returned any other error
+          def get_payment_link_by_id(payment_link_id, context = nil)
+            path_context = {
+              'paymentLinkId'.freeze => payment_link_id,
+            }
+            uri = instantiate_uri('/v2/{merchantId}/paymentlinks/{paymentLinkId}', path_context)
+            @communicator.get(
+              uri,
+              client_headers,
+              nil,
+              OnlinePayments::SDK::Domain::PaymentLinkResponse,
+              context)
+          rescue OnlinePayments::SDK::Communication::ResponseException => e
+            error_type = OnlinePayments::SDK::Domain::ErrorResponse
+            error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+            raise OnlinePayments::SDK.create_exception(e.status_code, e.body, error_object, context)
+          end
 
-        # Resource /v2/!{merchantId}/paymentlinks/!{paymentLinkId}/cancel
-        # @param payment_link_id [String]
-        # @param context         [OnlinePayments::SDK::CallContext]
-        # @raise [OnlinePayments::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
-        # @raise [OnlinePayments::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
-        # @raise [OnlinePayments::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
-        # @raise [OnlinePayments::SDK::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
-        #        or there was a conflict (HTTP status code 404, 409 or 410)
-        # @raise [OnlinePayments::SDK::PaymentPlatformException] if something went wrong at the payment platform,
-        #        the payment platform was unable to process a message from a downstream partner/acquirer,
-        #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-        # @raise [OnlinePayments::SDK::ApiException]if the payment platform returned any other error
-        def cancel_payment_link_by_id(payment_link_id, context = nil)
-          path_context = {
-            'paymentLinkId'.freeze => payment_link_id,
-          }
-          uri = instantiate_uri('/v2/{merchantId}/paymentlinks/{paymentLinkId}/cancel', path_context)
-          @communicator.post(
-            uri,
-            client_headers,
-            nil,
-            nil,
-            nil,
-            context
-          )
-        rescue ResponseException => e
-          error_type = OnlinePayments::SDK::Domain::ErrorResponse
-          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
-          raise create_exception(e.status_code, e.body, error_object, context)
+          # Resource /v2/!{merchantId}/paymentlinks/!{paymentLinkId}/cancel - Cancel PaymentLink by ID
+          #
+          # @param payment_link_id [String]
+          # @param context         [OnlinePayments::SDK::CallContext, nil]
+          # @raise [OnlinePayments::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+          # @raise [OnlinePayments::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+          # @raise [OnlinePayments::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+          # @raise [OnlinePayments::SDK::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
+          #        or there was a conflict (HTTP status code 404, 409 or 410)
+          # @raise [OnlinePayments::SDK::PlatformException] if something went wrong at the payment platform,
+          #        the payment platform was unable to process a message from a downstream partner/acquirer,
+          #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+          # @raise [OnlinePayments::SDK::ApiException] if the payment platform returned any other error
+          def cancel_payment_link_by_id(payment_link_id, context = nil)
+            path_context = {
+              'paymentLinkId'.freeze => payment_link_id,
+            }
+            uri = instantiate_uri('/v2/{merchantId}/paymentlinks/{paymentLinkId}/cancel', path_context)
+            @communicator.post(
+              uri,
+              client_headers,
+              nil,
+              nil,
+              nil,
+              context)
+          rescue OnlinePayments::SDK::Communication::ResponseException => e
+            error_type = OnlinePayments::SDK::Domain::ErrorResponse
+            error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+            raise OnlinePayments::SDK.create_exception(e.status_code, e.body, error_object, context)
+          end
         end
       end
     end

data/lib/onlinepayments/sdk/merchant/paymentlinks.rb

@@ -0,0 +1,4 @@
+#
+# This file was automatically generated.
+#
+Dir[File.join(__dir__, 'paymentlinks', '*.rb')].each { |f| require f }