payrix-api-sdk 1.0.0

data/lib/payrix/controllers/vendors_controller.rb

@@ -0,0 +1,201 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # VendorsController
+  class VendorsController < BaseController
+    # Querying a Vendor resource represents a third-party vendor who interacts
+    # with the API, for example, a referral platform.
+    # @param [String] id Required parameter: The ID of this resource, The Vendor
+    # ID.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [VendorsResponseResult] Response from the API call.
+    def get_vendors_id(id,
+                       token: nil,
+                       request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/vendors/{id}',
+                                     Server::PAYRIX)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(VendorsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Manage a Vendor resource.
+    # Details:
+    # Update a Vendor resource. A Vendor resource represents a third-party
+    # vendor who interacts with the API, for example, a referral platform.
+    # Query a Vendor resource.
+    # @param [String] id Required parameter: The ID of this resource and The
+    # Vendor ID.
+    # @param [VendorsPutRequest] body Required parameter: Update Vendor
+    # Request
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [VendorsResponseResult] Response from the API call.
+    def put_vendors_id(id,
+                       body,
+                       token: nil,
+                       request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/vendors/{id}',
+                                     Server::PAYRIX)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(VendorsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Delete a Vendor or Vendors resource that represents a third-party vendor
+    # who interacts with the API, for example, a referral platform.
+    # @param [String] id Required parameter: The ID of this resource, The Vendor
+    # ID.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @return [VendorsResponseResult] Response from the API call.
+    def delete_vendors_id(id,
+                          token: nil,
+                          request_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/vendors/{id}',
+                                     Server::PAYRIX)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(VendorsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+
+    # Query a Vendor resource. A Vendor resource represents a third-party vendor
+    # who interacts with the API, for example, a referral platform.
+    # @param [String] token Optional parameter: A single-use, limited
+    # authentication layer in addition to an API Key or Session Key to authorize
+    # sensitive operations. <a
+    # href="/apis/payrix/dev-int-guide/references/authentication/auth-tokens"
+    # target="_blank">Auth Tokens</a> add security by requiring one-time
+    # approval for specific actions.
+    # @param [String] request_token Optional parameter: A custom, one-time
+    # identifier for any API request (GET, PUT, POST, or DELETE). Blocks future
+    # requests with the same token for 48 hours, ensuring only the first request
+    # is processed. Valid values can contain 1-100 alphanumeric and special
+    # characters. See <a
+    # href="/apis/payrix/dev-int-guide/references/request-tokens"
+    # target="_blank">Request Tokens</a>  for more information.
+    # @param [String] search Optional parameter: Set this header to filter or
+    # sort the list of resources that the method returns.  See
+    # [Searches](page:welcome#searches) for detailed information and examples on
+    # how to use search header.
+    # @param [String] totals Optional parameter: To configure a request to
+    # return a total for all instances of a field in a result set,  use the
+    # totals header in the format `totals={operator}[]={key}`.  This will
+    # calculate the desired total and return it in the `details > totals` object
+    # of the response.  For instance, if you want to sum the `total` field of
+    # all transactions,  you would use the `sum` operator. The response will
+    # include the result set,  along with the calculated total in the `details`
+    # section. See [Collection Operators](page:welcome#collection-operators) for
+    # detailed information and examples on how to use totals header.
+    # @param [Integer] page_number Optional parameter: Set this path parameter
+    # to request a specific page of records.  For example, set `?page[number]=2`
+    # to retrieve the second page of records for this request.
+    # @param [Integer] page_limit Optional parameter: Set this path parameter to
+    # request up to a specific amount of records. By default 30 records are
+    # retrieved per page. The maximum limit that can be set is 100. For example,
+    # set `?page[limit]=50` to retrieve up to 50 records for this request.
+    # @return [VendorsResponseResult] Response from the API call.
+    def get_vendors(token: nil,
+                    request_token: nil,
+                    search: nil,
+                    totals: nil,
+                    page_number: nil,
+                    page_limit: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/vendors',
+                                     Server::PAYRIX)
+                   .header_param(new_parameter(token, key: 'token'))
+                   .header_param(new_parameter(request_token, key: 'request-token'))
+                   .header_param(new_parameter(search, key: 'search'))
+                   .header_param(new_parameter(totals, key: 'totals'))
+                   .query_param(new_parameter(page_number, key: 'page[number]'))
+                   .query_param(new_parameter(page_limit, key: 'page[limit]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('apiKey', 'sessionKey', 'txnSessionKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(VendorsResponseResult.method(:from_hash))
+                    .local_error('400',
+                                 'Error',
+                                 ErrorFourHundredException))
+        .execute
+    end
+  end
+end

data/lib/payrix/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/payrix/exceptions/error_four_hundred_exception.rb

@@ -0,0 +1,56 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # error-four-hundred class.
+  class ErrorFourHundredException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of zero or more errors that occurred when the API processed the
+    # request.
+    # @return [Array[ErrorFourHundredProperties]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['errors'].nil?
+        @errors = []
+        hash['errors'].each do |structure|
+          @errors << (ErrorFourHundredProperties.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('errors')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} errors: #{@errors.inspect}>"
+    end
+  end
+end

data/lib/payrix/http/auth/api_key.rb

@@ -0,0 +1,42 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # Utility class for custom header authorization.
+  class ApiKey < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'ApiKey: apikey is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(api_key_credentials)
+      auth_params = {}
+      auth_params['APIKEY'] = api_key_credentials.apikey unless
+        api_key_credentials.nil? || api_key_credentials.apikey.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for ApiKeyCredentials.
+  # Data class for ApiKeyCredentials.
+  class ApiKeyCredentials
+    attr_reader :apikey
+
+    def initialize(apikey:)
+      raise ArgumentError, 'apikey cannot be nil' if apikey.nil?
+
+      @apikey = apikey
+    end
+
+    def clone_with(apikey: nil)
+      apikey ||= self.apikey
+
+      ApiKeyCredentials.new(apikey: apikey)
+    end
+  end
+end

data/lib/payrix/http/auth/password.rb

@@ -0,0 +1,42 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # Utility class for custom header authorization.
+  class Password < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'Password: password is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(password_credentials)
+      auth_params = {}
+      auth_params['PASSWORD'] = password_credentials.password unless
+        password_credentials.nil? || password_credentials.password.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for PasswordCredentials.
+  # Data class for PasswordCredentials.
+  class PasswordCredentials
+    attr_reader :password
+
+    def initialize(password:)
+      raise ArgumentError, 'password cannot be nil' if password.nil?
+
+      @password = password
+    end
+
+    def clone_with(password: nil)
+      password ||= self.password
+
+      PasswordCredentials.new(password: password)
+    end
+  end
+end

data/lib/payrix/http/auth/session_key.rb

@@ -0,0 +1,42 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # Utility class for custom header authorization.
+  class SessionKey < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'SessionKey: sessionkey is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(session_key_credentials)
+      auth_params = {}
+      auth_params['SESSIONKEY'] = session_key_credentials.sessionkey unless
+        session_key_credentials.nil? || session_key_credentials.sessionkey.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for SessionKeyCredentials.
+  # Data class for SessionKeyCredentials.
+  class SessionKeyCredentials
+    attr_reader :sessionkey
+
+    def initialize(sessionkey:)
+      raise ArgumentError, 'sessionkey cannot be nil' if sessionkey.nil?
+
+      @sessionkey = sessionkey
+    end
+
+    def clone_with(sessionkey: nil)
+      sessionkey ||= self.sessionkey
+
+      SessionKeyCredentials.new(sessionkey: sessionkey)
+    end
+  end
+end

data/lib/payrix/http/auth/txn_session_key.rb

@@ -0,0 +1,42 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # Utility class for custom header authorization.
+  class TxnSessionKey < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'TxnSessionKey: txnsessionkey is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(txn_session_key_credentials)
+      auth_params = {}
+      auth_params['TXNSESSIONKEY'] = txn_session_key_credentials.txnsessionkey unless
+        txn_session_key_credentials.nil? || txn_session_key_credentials.txnsessionkey.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for TxnSessionKeyCredentials.
+  # Data class for TxnSessionKeyCredentials.
+  class TxnSessionKeyCredentials
+    attr_reader :txnsessionkey
+
+    def initialize(txnsessionkey:)
+      raise ArgumentError, 'txnsessionkey cannot be nil' if txnsessionkey.nil?
+
+      @txnsessionkey = txnsessionkey
+    end
+
+    def clone_with(txnsessionkey: nil)
+      txnsessionkey ||= self.txnsessionkey
+
+      TxnSessionKeyCredentials.new(txnsessionkey: txnsessionkey)
+    end
+  end
+end

data/lib/payrix/http/auth/username.rb

@@ -0,0 +1,42 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # Utility class for custom header authorization.
+  class Username < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'Username: username is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(username_credentials)
+      auth_params = {}
+      auth_params['USERNAME'] = username_credentials.username unless
+        username_credentials.nil? || username_credentials.username.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for UsernameCredentials.
+  # Data class for UsernameCredentials.
+  class UsernameCredentials
+    attr_reader :username
+
+    def initialize(username:)
+      raise ArgumentError, 'username cannot be nil' if username.nil?
+
+      @username = username
+    end
+
+    def clone_with(username: nil)
+      username ||= self.username
+
+      UsernameCredentials.new(username: username)
+    end
+  end
+end

data/lib/payrix/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/payrix/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/payrix/http/http_request.rb

@@ -0,0 +1,10 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/payrix/http/http_response.rb

@@ -0,0 +1,10 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/payrix/http/proxy_settings.rb

@@ -0,0 +1,13 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+  end
+end

data/lib/payrix/models/account_check_stage_enum.rb

@@ -0,0 +1,20 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # accountCheckStage.
+  class AccountCheckStageEnum
+    ACCOUNT_CHECK_STAGE_ENUM = [
+      # Create Account
+      CREATEACCOUNT = 'createAccount'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_CHECK_STAGE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/account_method_enum.rb

@@ -0,0 +1,29 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # accountMethod.
+  class AccountMethodEnum
+    ACCOUNT_METHOD_ENUM = [
+      # Checking
+      CHECKING = 8,
+
+      # Savings
+      SAVINGS = 9,
+
+      # Corporate Checking
+      CORPORATECHECKING = 10,
+
+      # Corporate Savings
+      CORPORATESAVINGS = 11
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_METHOD_ENUM.include?(value)
+    end
+  end
+end