dna-apimatic-sdk 0.0.1

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/merchant_v1.rb

@@ -0,0 +1,85 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # MerchantV1 Model.
+  class MerchantV1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID for the merchant, allocated by DNA Payments.
+    # @return [String]
+    attr_accessor :id
+
+    # Name of the merchant.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MerchantV1.new(id: id,
+                     name: name,
+                     additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, name: #{@name}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/merchant_v2.rb

@@ -0,0 +1,138 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # MerchantV2 Model.
+  class MerchantV2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant descriptor as it appears on the consumer's bank statement for DNA
+    # Acquiring.
+    # @return [String]
+    attr_accessor :descriptor
+
+    # Unique ID for the merchant, allocated by DNA Payments.
+    # @return [String]
+    attr_accessor :id
+
+    # Name of the merchant.
+    # @return [String]
+    attr_accessor :name
+
+    # Whether the merchant is active.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_active
+
+    # Unique ID allocated by DNA Payments to the merchant account; appears on
+    # the merchant bank statement when payments/settlements are made.
+    # @return [String]
+    attr_accessor :reconciliation_id
+
+    # List of all Terminal IDs configured for the merchant.
+    # @return [Array[Terminal]]
+    attr_accessor :terminals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['descriptor'] = 'descriptor'
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['is_active'] = 'isActive'
+      @_hash['reconciliation_id'] = 'reconciliationId'
+      @_hash['terminals'] = 'terminals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        descriptor
+        id
+        name
+        is_active
+        reconciliation_id
+        terminals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(descriptor: SKIP, id: SKIP, name: SKIP, is_active: SKIP,
+                   reconciliation_id: SKIP, terminals: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @descriptor = descriptor unless descriptor == SKIP
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @is_active = is_active unless is_active == SKIP
+      @reconciliation_id = reconciliation_id unless reconciliation_id == SKIP
+      @terminals = terminals unless terminals == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      descriptor = hash.key?('descriptor') ? hash['descriptor'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      is_active = hash.key?('isActive') ? hash['isActive'] : SKIP
+      reconciliation_id =
+        hash.key?('reconciliationId') ? hash['reconciliationId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      terminals = nil
+      unless hash['terminals'].nil?
+        terminals = []
+        hash['terminals'].each do |structure|
+          terminals << (Terminal.from_hash(structure) if structure)
+        end
+      end
+
+      terminals = SKIP unless hash.key?('terminals')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MerchantV2.new(descriptor: descriptor,
+                     id: id,
+                     name: name,
+                     is_active: is_active,
+                     reconciliation_id: reconciliation_id,
+                     terminals: terminals,
+                     additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} descriptor: #{@descriptor}, id: #{@id}, name: #{@name}, is_active:"\
+      " #{@is_active}, reconciliation_id: #{@reconciliation_id}, terminals: #{@terminals},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} descriptor: #{@descriptor.inspect}, id: #{@id.inspect}, name:"\
+      " #{@name.inspect}, is_active: #{@is_active.inspect}, reconciliation_id:"\
+      " #{@reconciliation_id.inspect}, terminals: #{@terminals.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/merchants_v2_response.rb

@@ -0,0 +1,94 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # MerchantsV2Response Model.
+  class MerchantsV2Response < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[MerchantV2]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['total_count'] = 'totalCount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+        total_count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data: SKIP, total_count: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data unless data == SKIP
+      @total_count = total_count unless total_count == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (MerchantV2.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('data')
+      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MerchantsV2Response.new(data: data,
+                              total_count: total_count,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, total_count: #{@total_count}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, total_count: #{@total_count.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/oauth_provider_error.rb

@@ -0,0 +1,62 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # OAuth 2 Authorization error codes
+  class OauthProviderError
+    OAUTH_PROVIDER_ERROR = [
+      # The request is missing a required parameter, includes an unsupported
+      # parameter value (other than grant type), repeats a parameter, includes
+      # multiple credentials, utilizes more than one mechanism for
+      # authenticating the client, or is otherwise malformed.
+      INVALID_REQUEST = 'invalid_request'.freeze,
+
+      # Client authentication failed (e.g., unknown client, no client
+      # authentication included, or unsupported authentication method).
+      INVALID_CLIENT = 'invalid_client'.freeze,
+
+      # The provided authorization grant (e.g., authorization code, resource
+      # owner credentials) or refresh token is invalid, expired, revoked, does
+      # not match the redirection URI used in the authorization request, or was
+      # issued to another client.
+      INVALID_GRANT = 'invalid_grant'.freeze,
+
+      # The authenticated client is not authorized to use this authorization
+      # grant type.
+      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
+
+      # The authorization grant type is not supported by the authorization
+      # server.
+      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
+
+      # The requested scope is invalid, unknown, malformed, or exceeds the scope
+      # granted by the resource owner.
+      INVALID_SCOPE = 'invalid_scope'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OAUTH_PROVIDER_ERROR.include?(value)
+    end
+
+    def self.from_value(value, default_value = INVALID_REQUEST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'invalid_request' then INVALID_REQUEST
+      when 'invalid_client' then INVALID_CLIENT
+      when 'invalid_grant' then INVALID_GRANT
+      when 'unauthorized_client' then UNAUTHORIZED_CLIENT
+      when 'unsupported_grant_type' then UNSUPPORTED_GRANT_TYPE
+      when 'invalid_scope' then INVALID_SCOPE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/oauth_scope.rb

@@ -0,0 +1,26 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # OAuth 2 scopes supported by the API
+  class OauthScope
+    OAUTH_SCOPE = [
+      # Access to the Partner Reporting and Settlement APIs.
+      PARTNERS_REPORTING = 'partners_reporting'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OAUTH_SCOPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = PARTNERS_REPORTING)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/oauth_token.rb

@@ -0,0 +1,96 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # OAuth 2 Authorization endpoint response
+  class OauthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, token_type:, expires_in: SKIP, scope: SKIP,
+                   expiry: SKIP, refresh_token: SKIP)
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+
+      # Create object from extracted values.
+      OauthToken.new(access_token: access_token,
+                     token_type: token_type,
+                     expires_in: expires_in,
+                     scope: scope,
+                     expiry: expiry,
+                     refresh_token: refresh_token)
+    end
+  end
+end

data/lib/dna_payments_partner_reporting_settlement_ap_is/models/operation.rb

@@ -0,0 +1,48 @@
+# dna_payments_partner_reporting_settlement_ap_is
+#
+# This file was
+# automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module DnaPaymentsPartnerReportingSettlementApIs
+  # Confirmation of the operation performed.
+  class Operation
+    OPERATION = [
+      # TODO: Write general description for ADVICE
+      ADVICE = 'advice'.freeze,
+
+      # TODO: Write general description for REVERSAL
+      REVERSAL = 'reversal'.freeze,
+
+      # TODO: Write general description for ADJUSTMENT
+      ADJUSTMENT = 'adjustment'.freeze,
+
+      # TODO: Write general description for REQUEST
+      REQUEST = 'request'.freeze,
+
+      # TODO: Write general description for PARTADVICE
+      PARTADVICE = 'part-advice'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPERATION.include?(value)
+    end
+
+    def self.from_value(value, default_value = ADVICE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'advice' then ADVICE
+      when 'reversal' then REVERSAL
+      when 'adjustment' then ADJUSTMENT
+      when 'request' then REQUEST
+      when 'partadvice' then PARTADVICE
+      else
+        default_value
+      end
+    end
+  end
+end