univapay-client-sdk 1.0.0

data/lib/univapay_client_sdk/models/customs_declaration_webhook_other_error.rb

@@ -0,0 +1,120 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Nested customs-processing error entry returned in `others`.
+  class CustomsDeclarationWebhookOtherError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Backend other-error type.
+    # @return [String]
+    attr_accessor :type
+
+    # Gateway credentials involved in the error when applicable.
+    # @return [UUID | String]
+    attr_accessor :credentials_id
+
+    # Additional reason values for `not_selected_reasons`.
+    # @return [Array[String]]
+    attr_accessor :message
+
+    # Related item name for `related_item`.
+    # @return [String]
+    attr_accessor :item_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['credentials_id'] = 'credentials_id'
+      @_hash['message'] = 'message'
+      @_hash['item_name'] = 'item_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        credentials_id
+        message
+        item_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        credentials_id
+        message
+        item_name
+      ]
+    end
+
+    def initialize(type: SKIP, credentials_id: SKIP, message: SKIP,
+                   item_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @credentials_id = credentials_id unless credentials_id == SKIP
+      @message = message unless message == SKIP
+      @item_name = item_name unless item_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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      credentials_id =
+        hash.key?('credentials_id') ? hash['credentials_id'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      item_name = hash.key?('item_name') ? hash['item_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.
+      CustomsDeclarationWebhookOtherError.new(type: type,
+                                              credentials_id: credentials_id,
+                                              message: message,
+                                              item_name: item_name,
+                                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomsDeclarationWebhookOtherError | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, credentials_id: #{@credentials_id}, message: #{@message},"\
+      " item_name: #{@item_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} type: #{@type.inspect}, credentials_id: #{@credentials_id.inspect},"\
+      " message: #{@message.inspect}, item_name: #{@item_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/customs_declaration_webhook_result.rb

@@ -0,0 +1,125 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Result payload returned by the customs declaration formatter.
+  class CustomsDeclarationWebhookResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Customs authority that approved the declaration.
+    # @return [String]
+    attr_accessor :approving_authority
+
+    # Gateway trade identifier.
+    # @return [String]
+    attr_accessor :trade_id
+
+    # Gateway transaction identifier for customs.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Gateway charge transaction identifier linked to the declaration.
+    # @return [String]
+    attr_accessor :charge_transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['approving_authority'] = 'approving_authority'
+      @_hash['trade_id'] = 'trade_id'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['charge_transaction_id'] = 'charge_transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        approving_authority
+        trade_id
+        transaction_id
+        charge_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        approving_authority
+        trade_id
+        transaction_id
+        charge_transaction_id
+      ]
+    end
+
+    def initialize(approving_authority: SKIP, trade_id: SKIP,
+                   transaction_id: SKIP, charge_transaction_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @approving_authority = approving_authority unless approving_authority == SKIP
+      @trade_id = trade_id unless trade_id == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @charge_transaction_id = charge_transaction_id unless charge_transaction_id == 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.
+      approving_authority =
+        hash.key?('approving_authority') ? hash['approving_authority'] : SKIP
+      trade_id = hash.key?('trade_id') ? hash['trade_id'] : SKIP
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : SKIP
+      charge_transaction_id =
+        hash.key?('charge_transaction_id') ? hash['charge_transaction_id'] : 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.
+      CustomsDeclarationWebhookResult.new(approving_authority: approving_authority,
+                                          trade_id: trade_id,
+                                          transaction_id: transaction_id,
+                                          charge_transaction_id: charge_transaction_id,
+                                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomsDeclarationWebhookResult | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} approving_authority: #{@approving_authority}, trade_id: #{@trade_id},"\
+      " transaction_id: #{@transaction_id}, charge_transaction_id: #{@charge_transaction_id},"\
+      " 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} approving_authority: #{@approving_authority.inspect}, trade_id:"\
+      " #{@trade_id.inspect}, transaction_id: #{@transaction_id.inspect}, charge_transaction_id:"\
+      " #{@charge_transaction_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/customs_declaration_webhook_status.rb

@@ -0,0 +1,44 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Customs declaration status returned by the backend.
+  class CustomsDeclarationWebhookStatus
+    CUSTOMS_DECLARATION_WEBHOOK_STATUS = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for SUCCESSFUL
+      SUCCESSFUL = 'successful'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for ERROR
+      ERROR = 'error'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CUSTOMS_DECLARATION_WEBHOOK_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'successful' then SUCCESSFUL
+      when 'failed' then FAILED
+      when 'error' then ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/generic_metadata.rb

@@ -0,0 +1,111 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # A free-form dictionary for custom metadata.
+  class GenericMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Example of a custom metadata key.
+    # @return [String]
+    attr_accessor :order_id
+
+    # Consumer name passed to payment processors that require it (e.g., konbini,
+    # bank transfer).
+    # @return [String]
+    attr_accessor :univapay_name
+
+    # Consumer phone number passed to payment processors that require it.
+    # @return [String]
+    attr_accessor :univapay_phone_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'order_id'
+      @_hash['univapay_name'] = 'univapay-name'
+      @_hash['univapay_phone_number'] = 'univapay-phone-number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+        univapay_name
+        univapay_phone_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_id: SKIP, univapay_name: SKIP,
+                   univapay_phone_number: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @order_id = order_id unless order_id == SKIP
+      @univapay_name = univapay_name unless univapay_name == SKIP
+      @univapay_phone_number = univapay_phone_number unless univapay_phone_number == 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.
+      order_id = hash.key?('order_id') ? hash['order_id'] : SKIP
+      univapay_name = hash.key?('univapay-name') ? hash['univapay-name'] : SKIP
+      univapay_phone_number =
+        hash.key?('univapay-phone-number') ? hash['univapay-phone-number'] : 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 { |x|
+                    APIHelper.deserialize_union_type(UnionTypeLookUp.get(:GenericMetadataValue), x)
+                  }
+      )
+
+      # Create object from extracted values.
+      GenericMetadata.new(order_id: order_id,
+                          univapay_name: univapay_name,
+                          univapay_phone_number: univapay_phone_number,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [GenericMetadata | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id}, univapay_name: #{@univapay_name},"\
+      " univapay_phone_number: #{@univapay_phone_number}, 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} order_id: #{@order_id.inspect}, univapay_name: #{@univapay_name.inspect},"\
+      " univapay_phone_number: #{@univapay_phone_number.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/installment_fixed_cycles.rb

@@ -0,0 +1,70 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Required if plan_type is fixed_cycles.
+  class InstallmentFixedCycles
+    INSTALLMENT_FIXED_CYCLES = [
+      # 3 cycles
+      CYCLES_3 = 3,
+
+      # 5 cycles
+      CYCLES_5 = 5,
+
+      # 6 cycles
+      CYCLES_6 = 6,
+
+      # 10 cycles
+      CYCLES_10 = 10,
+
+      # 12 cycles
+      CYCLES_12 = 12,
+
+      # 15 cycles
+      CYCLES_15 = 15,
+
+      # 18 cycles
+      CYCLES_18 = 18,
+
+      # 20 cycles
+      CYCLES_20 = 20,
+
+      # 24 cycles
+      CYCLES_24 = 24
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INSTALLMENT_FIXED_CYCLES.include?(value)
+    end
+
+    def self.from_value(value, default_value = CYCLES_3)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+      if str.match?(/\A\d+\z/)
+        num = str.to_i
+        return num if INSTALLMENT_FIXED_CYCLES.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'cycles_3' then CYCLES_3
+      when 'cycles_5' then CYCLES_5
+      when 'cycles_6' then CYCLES_6
+      when 'cycles_10' then CYCLES_10
+      when 'cycles_12' then CYCLES_12
+      when 'cycles_15' then CYCLES_15
+      when 'cycles_18' then CYCLES_18
+      when 'cycles_20' then CYCLES_20
+      when 'cycles_24' then CYCLES_24
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/installment_plan_type.rb

@@ -0,0 +1,36 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Plan type selector.
+  class InstallmentPlanType
+    INSTALLMENT_PLAN_TYPE = [
+      # TODO: Write general description for REVOLVING
+      REVOLVING = 'revolving'.freeze,
+
+      # TODO: Write general description for FIXED_CYCLES
+      FIXED_CYCLES = 'fixed_cycles'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INSTALLMENT_PLAN_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = REVOLVING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'revolving' then REVOLVING
+      when 'fixed_cycles' then FIXED_CYCLES
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/issuer_token.rb

@@ -0,0 +1,177 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Issuer token or bank transfer instruction payload.
+  class IssuerToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of payment method for the charge.
+    # @return [IssuerTokenPaymentType]
+    attr_accessor :payment_type
+
+    # (Online) The token or payment URL provided by the payment provider for the
+    # consumer to execute.
+    # @return [String]
+    attr_accessor :issuer_token
+
+    # (Online) How the client should execute the token.  - `sdk` / `app`: Direct
+    # use in native app environments/SDKs. - `web`: Direct use in special
+    # extended browser environments. - `http_get` / `http_post`: Execute
+    # directly in a new browser window or iframe.
+    # @return [IssuerTokenCallMethod]
+    attr_accessor :call_method
+
+    # Key-value pairs required to complete the payment action, or null if not
+    # applicable. Used when `call_method` is `http_post`. When present, this
+    # JSON must be converted by the client to match the expected `content_type`
+    # (e.g., transformed into an `application/x-www-form-urlencoded` string)
+    # before sending the POST request.
+    # @return [IssuerTokenPayload]
+    attr_accessor :payload
+
+    # (Bank Transfer) Unique ID of the bank account issued by the connected
+    # system.
+    # @return [String]
+    attr_accessor :account_id
+
+    # (Bank Transfer) Branch code.
+    # @return [String]
+    attr_accessor :branch_code
+
+    # (Bank Transfer) Branch name.
+    # @return [String]
+    attr_accessor :branch_name
+
+    # (Bank Transfer) Account holder name.
+    # @return [String]
+    attr_accessor :account_holder_name
+
+    # (Bank Transfer) Account number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['issuer_token'] = 'issuer_token'
+      @_hash['call_method'] = 'call_method'
+      @_hash['payload'] = 'payload'
+      @_hash['account_id'] = 'account_id'
+      @_hash['branch_code'] = 'branch_code'
+      @_hash['branch_name'] = 'branch_name'
+      @_hash['account_holder_name'] = 'account_holder_name'
+      @_hash['account_number'] = 'account_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        issuer_token
+        call_method
+        payload
+        account_id
+        branch_code
+        branch_name
+        account_holder_name
+        account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        issuer_token
+        call_method
+        payload
+        account_id
+        branch_code
+        branch_name
+        account_holder_name
+        account_number
+      ]
+    end
+
+    def initialize(payment_type:, issuer_token: SKIP, call_method: SKIP,
+                   payload: SKIP, account_id: SKIP, branch_code: SKIP,
+                   branch_name: SKIP, account_holder_name: SKIP,
+                   account_number: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_type = payment_type
+      @issuer_token = issuer_token unless issuer_token == SKIP
+      @call_method = call_method unless call_method == SKIP
+      @payload = payload unless payload == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @branch_code = branch_code unless branch_code == SKIP
+      @branch_name = branch_name unless branch_name == SKIP
+      @account_holder_name = account_holder_name unless account_holder_name == SKIP
+      @account_number = account_number unless account_number == 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.
+      payment_type = hash.key?('payment_type') ? hash['payment_type'] : nil
+      issuer_token = hash.key?('issuer_token') ? hash['issuer_token'] : SKIP
+      call_method = hash.key?('call_method') ? hash['call_method'] : SKIP
+      payload = IssuerTokenPayload.from_hash(hash['payload']) if hash['payload']
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      branch_code = hash.key?('branch_code') ? hash['branch_code'] : SKIP
+      branch_name = hash.key?('branch_name') ? hash['branch_name'] : SKIP
+      account_holder_name =
+        hash.key?('account_holder_name') ? hash['account_holder_name'] : SKIP
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : 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.
+      IssuerToken.new(payment_type: payment_type,
+                      issuer_token: issuer_token,
+                      call_method: call_method,
+                      payload: payload,
+                      account_id: account_id,
+                      branch_code: branch_code,
+                      branch_name: branch_name,
+                      account_holder_name: account_holder_name,
+                      account_number: account_number,
+                      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} payment_type: #{@payment_type}, issuer_token: #{@issuer_token},"\
+      " call_method: #{@call_method}, payload: #{@payload}, account_id: #{@account_id},"\
+      " branch_code: #{@branch_code}, branch_name: #{@branch_name}, account_holder_name:"\
+      " #{@account_holder_name}, account_number: #{@account_number}, 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} payment_type: #{@payment_type.inspect}, issuer_token:"\
+      " #{@issuer_token.inspect}, call_method: #{@call_method.inspect}, payload:"\
+      " #{@payload.inspect}, account_id: #{@account_id.inspect}, branch_code:"\
+      " #{@branch_code.inspect}, branch_name: #{@branch_name.inspect}, account_holder_name:"\
+      " #{@account_holder_name.inspect}, account_number: #{@account_number.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end