onlinepayments-sdk-ruby 4.23.0 → 5.0.0

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

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

data/lib/onlinepayments/sdk/merchant/payouts/payouts_client.rb

@@ -1,84 +1,86 @@
 #
-# 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_payout_request'
+require 'onlinepayments/sdk/exception_factory'
+require 'onlinepayments/sdk/communication/response_exception'
 require 'onlinepayments/sdk/domain/error_response'
 require 'onlinepayments/sdk/domain/payout_error_response'
 require 'onlinepayments/sdk/domain/payout_response'
 
-module OnlinePayments::SDK
-  module Merchant
-    module Payouts
+module OnlinePayments
+  module SDK
+    module Merchant
+      module Payouts
+        # Payouts client. Thread-safe.
+        class PayoutsClient < OnlinePayments::SDK::ApiResource
 
-      # Payouts client. Thread-safe.
-      class PayoutsClient < 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}/payouts
-        # @param body    [OnlinePayments::SDK::Domain::CreatePayoutRequest]
-        # @param context [OnlinePayments::SDK::CallContext]
-        # @return [OnlinePayments::SDK::Domain::PayoutResponse]
-        # @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_payout(body, context = nil)
-          uri = instantiate_uri('/v2/{merchantId}/payouts')
-          @communicator.post(
-            uri,
-            client_headers,
-            nil,
-            body,
-            OnlinePayments::SDK::Domain::PayoutResponse,
-            context
-          )
-        rescue ResponseException => e
-          error_type = OnlinePayments::SDK::Domain::PayoutErrorResponse
-          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
-          raise create_exception(e.status_code, e.body, error_object, context)
-        end
+          # Resource /v2/!{merchantId}/payouts/!{payoutId} - Get payout
+          #
+          # @param payout_id [String]
+          # @param context   [OnlinePayments::SDK::CallContext, nil]
+          # @return [OnlinePayments::SDK::Domain::PayoutResponse]
+          # @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_payout(payout_id, context = nil)
+            path_context = {
+              'payoutId'.freeze => payout_id,
+            }
+            uri = instantiate_uri('/v2/{merchantId}/payouts/{payoutId}', path_context)
+            @communicator.get(
+              uri,
+              client_headers,
+              nil,
+              OnlinePayments::SDK::Domain::PayoutResponse,
+              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}/payouts/!{payoutId}
-        # @param payout_id [String]
-        # @param context   [OnlinePayments::SDK::CallContext]
-        # @return [OnlinePayments::SDK::Domain::PayoutResponse]
-        # @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_payout(payout_id, context = nil)
-          path_context = {
-            'payoutId'.freeze => payout_id,
-          }
-          uri = instantiate_uri('/v2/{merchantId}/payouts/{payoutId}', path_context)
-          @communicator.get(
-            uri,
-            client_headers,
-            nil,
-            OnlinePayments::SDK::Domain::PayoutResponse,
-            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}/payouts - Create payout
+          #
+          # @param body    [OnlinePayments::SDK::Domain::CreatePayoutRequest]
+          # @param context [OnlinePayments::SDK::CallContext, nil]
+          # @return [OnlinePayments::SDK::Domain::PayoutResponse]
+          # @raise [OnlinePayments::SDK::DeclinedPayoutException] if the payment platform declined / rejected the payout. The payout result will be available from the exception.
+          # @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_payout(body, context = nil)
+            uri = instantiate_uri('/v2/{merchantId}/payouts', nil)
+            @communicator.post(
+              uri,
+              client_headers,
+              nil,
+              body,
+              OnlinePayments::SDK::Domain::PayoutResponse,
+              context)
+          rescue OnlinePayments::SDK::Communication::ResponseException => e
+            error_type = OnlinePayments::SDK::Domain::PayoutErrorResponse
+            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/payouts.rb

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

data/lib/onlinepayments/sdk/merchant/privacypolicy/get_privacy_policy_params.rb

@@ -0,0 +1,32 @@
+#
+# This file was automatically generated.
+#
+require 'onlinepayments/sdk/communication/param_request'
+require 'onlinepayments/sdk/communication/request_param'
+
+module OnlinePayments
+  module SDK
+    module Merchant
+      module PrivacyPolicy
+        # Query parameters for Get Privacy Policy (/v2/{merchantId}/services/privacypolicy)
+        #
+        # @attr [String] locale
+        # @attr [Integer] payment_product_id
+        class GetPrivacyPolicyParams < OnlinePayments::SDK::Communication::ParamRequest
+
+          attr_accessor :locale
+
+          attr_accessor :payment_product_id
+
+          # @return [Array<OnlinePayments::SDK::Communication::RequestParam>] representing the attributes of this class
+          def to_request_parameters
+            result = []
+            result << RequestParam.new('locale', @locale) unless @locale.nil?
+            result << RequestParam.new('paymentProductId', @payment_product_id.to_s) unless @payment_product_id.nil?
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/merchant/privacypolicy/privacy_policy_client.rb

@@ -0,0 +1,54 @@
+#
+# This file was automatically generated.
+#
+require 'onlinepayments/sdk/api_resource'
+require 'onlinepayments/sdk/exception_factory'
+require 'onlinepayments/sdk/communication/response_exception'
+require 'onlinepayments/sdk/domain/error_response'
+require 'onlinepayments/sdk/domain/get_privacy_policy_response'
+
+module OnlinePayments
+  module SDK
+    module Merchant
+      module PrivacyPolicy
+        # PrivacyPolicy client. Thread-safe.
+        class PrivacyPolicyClient < 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
+
+          # Resource /v2/!{merchantId}/services/privacypolicy - Get Privacy Policy
+          #
+          # @param query   [OnlinePayments::SDK::Merchant::PrivacyPolicy::GetPrivacyPolicyParams]
+          # @param context [OnlinePayments::SDK::CallContext, nil]
+          # @return [OnlinePayments::SDK::Domain::GetPrivacyPolicyResponse]
+          # @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_privacy_policy(query, context = nil)
+            uri = instantiate_uri('/v2/{merchantId}/services/privacypolicy', nil)
+            @communicator.get(
+              uri,
+              client_headers,
+              query,
+              OnlinePayments::SDK::Domain::GetPrivacyPolicyResponse,
+              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
+  end
+end

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

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

data/lib/onlinepayments/sdk/merchant/productgroups/get_product_group_params.rb

@@ -1,55 +1,58 @@
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-require 'onlinepayments/sdk/param_request'
-require 'onlinepayments/sdk/request_param'
-
-module OnlinePayments::SDK
-  module Merchant
-    module ProductGroups
-
-      # Query parameters for 'Get product group'.
-      # @attr [String] country_code
-      # @attr [String] currency_code
-      # @attr [String] locale
-      # @attr [Integer] amount
-      # @attr [true/false] is_recurring
-      # @attr [Array<String>] hide
-      class GetProductGroupParams < OnlinePayments::SDK::ParamRequest
-
-        attr_accessor :country_code
-
-        attr_accessor :currency_code
-
-        attr_accessor :locale
-
-        attr_accessor :amount
-
-        attr_accessor :is_recurring
-
-        attr_accessor :hide
-
-        # Adds the parameter _value_ to the _hide_ Array
-        # @param value [String]
-        def add_hide(value)
-          unless @hide
-            @hide = []
+require 'onlinepayments/sdk/communication/param_request'
+require 'onlinepayments/sdk/communication/request_param'
+
+module OnlinePayments
+  module SDK
+    module Merchant
+      module ProductGroups
+        # Query parameters for Get product group (/v2/{merchantId}/productgroups/{paymentProductGroupId})
+        #
+        # @attr [String] country_code
+        # @attr [String] currency_code
+        # @attr [String] locale
+        # @attr [Integer] amount
+        # @attr [true/false] is_recurring
+        # @attr [Array<String>] hide
+        class GetProductGroupParams < OnlinePayments::SDK::Communication::ParamRequest
+
+          attr_accessor :country_code
+
+          attr_accessor :currency_code
+
+          attr_accessor :locale
+
+          attr_accessor :amount
+
+          attr_accessor :is_recurring
+
+          attr_accessor :hide
+
+          # Adds the parameter _value_ to the _hide_ Array
+          #
+          # @param value [String]
+          def add_hide(value)
+            unless @hide
+              @hide = []
+            end
+            @hide << value
           end
-          @hide << value
-        end
 
-        # @return [Array<OnlinePayments::SDK::RequestParam>] representing the attributes of this class
-        def to_request_parameters
-          result = []
-          result << RequestParam.new('countryCode', @country_code) unless @country_code.nil?
-          result << RequestParam.new('currencyCode', @currency_code) unless @currency_code.nil?
-          result << RequestParam.new('locale', @locale) unless @locale.nil?
-          result << RequestParam.new('amount', @amount.to_s) unless @amount.nil?
-          result << RequestParam.new('isRecurring', @is_recurring.to_s) unless @is_recurring.nil?
-          unless @hide.nil?
-            @hide.each { |e| result << RequestParam.new('hide', e) }
+          # @return [Array<OnlinePayments::SDK::Communication::RequestParam>] representing the attributes of this class
+          def to_request_parameters
+            result = []
+            result << RequestParam.new('countryCode', @country_code) unless @country_code.nil?
+            result << RequestParam.new('currencyCode', @currency_code) unless @currency_code.nil?
+            result << RequestParam.new('locale', @locale) unless @locale.nil?
+            result << RequestParam.new('amount', @amount.to_s) unless @amount.nil?
+            result << RequestParam.new('isRecurring', @is_recurring.to_s) unless @is_recurring.nil?
+            unless @hide.nil?
+              @hide.each {|e| result << RequestParam.new('hide', e)}
+            end
+            result
           end
-          result
         end
       end
     end

data/lib/onlinepayments/sdk/merchant/productgroups/get_product_groups_params.rb

@@ -1,55 +1,58 @@
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-require 'onlinepayments/sdk/param_request'
-require 'onlinepayments/sdk/request_param'
-
-module OnlinePayments::SDK
-  module Merchant
-    module ProductGroups
-
-      # Query parameters for 'Get product groups'.
-      # @attr [String] country_code
-      # @attr [String] currency_code
-      # @attr [String] locale
-      # @attr [Integer] amount
-      # @attr [true/false] is_recurring
-      # @attr [Array<String>] hide
-      class GetProductGroupsParams < OnlinePayments::SDK::ParamRequest
-
-        attr_accessor :country_code
-
-        attr_accessor :currency_code
-
-        attr_accessor :locale
-
-        attr_accessor :amount
-
-        attr_accessor :is_recurring
-
-        attr_accessor :hide
-
-        # Adds the parameter _value_ to the _hide_ Array
-        # @param value [String]
-        def add_hide(value)
-          unless @hide
-            @hide = []
+require 'onlinepayments/sdk/communication/param_request'
+require 'onlinepayments/sdk/communication/request_param'
+
+module OnlinePayments
+  module SDK
+    module Merchant
+      module ProductGroups
+        # Query parameters for Get product groups (/v2/{merchantId}/productgroups)
+        #
+        # @attr [String] country_code
+        # @attr [String] currency_code
+        # @attr [String] locale
+        # @attr [Integer] amount
+        # @attr [true/false] is_recurring
+        # @attr [Array<String>] hide
+        class GetProductGroupsParams < OnlinePayments::SDK::Communication::ParamRequest
+
+          attr_accessor :country_code
+
+          attr_accessor :currency_code
+
+          attr_accessor :locale
+
+          attr_accessor :amount
+
+          attr_accessor :is_recurring
+
+          attr_accessor :hide
+
+          # Adds the parameter _value_ to the _hide_ Array
+          #
+          # @param value [String]
+          def add_hide(value)
+            unless @hide
+              @hide = []
+            end
+            @hide << value
           end
-          @hide << value
-        end
 
-        # @return [Array<OnlinePayments::SDK::RequestParam>] representing the attributes of this class
-        def to_request_parameters
-          result = []
-          result << RequestParam.new('countryCode', @country_code) unless @country_code.nil?
-          result << RequestParam.new('currencyCode', @currency_code) unless @currency_code.nil?
-          result << RequestParam.new('locale', @locale) unless @locale.nil?
-          result << RequestParam.new('amount', @amount.to_s) unless @amount.nil?
-          result << RequestParam.new('isRecurring', @is_recurring.to_s) unless @is_recurring.nil?
-          unless @hide.nil?
-            @hide.each { |e| result << RequestParam.new('hide', e) }
+          # @return [Array<OnlinePayments::SDK::Communication::RequestParam>] representing the attributes of this class
+          def to_request_parameters
+            result = []
+            result << RequestParam.new('countryCode', @country_code) unless @country_code.nil?
+            result << RequestParam.new('currencyCode', @currency_code) unless @currency_code.nil?
+            result << RequestParam.new('locale', @locale) unless @locale.nil?
+            result << RequestParam.new('amount', @amount.to_s) unless @amount.nil?
+            result << RequestParam.new('isRecurring', @is_recurring.to_s) unless @is_recurring.nil?
+            unless @hide.nil?
+              @hide.each {|e| result << RequestParam.new('hide', e)}
+            end
+            result
           end
-          result
         end
       end
     end