univapay-apimatic-sdk 0.0.1

data/lib/univapay_client_sdk/models/charge_create_request.rb

@@ -0,0 +1,179 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Request payload for creating a charge.
+  class ChargeCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction token identifier.
+    # @return [UUID | String]
+    attr_accessor :transaction_token_id
+
+    # The charge amount.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # ISO-4217 currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # If false, creates an Authorization only (Hold).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :capture
+
+    # Auto-capture date for cards, or payment deadline for Konbini/Bank. Note:
+    # Time specification is ignored for 7-Eleven, Seicomart, and PayEasy.
+    # @return [DateTime]
+    attr_accessor :capture_at
+
+    # Unique transaction ID for the merchant.  Required/used by specific brands
+    # like we_chat, we_chat_mpm, and we_chat_online.
+    # @return [String]
+    attr_accessor :merchant_transaction_id
+
+    # A free-form dictionary for custom metadata.
+    # @return [GenericMetadata]
+    attr_accessor :metadata
+
+    # Charge Create Request Client Metadata schema.
+    # @return [ChargeCreateRequestClientMetadata]
+    attr_accessor :client_metadata
+
+    # Charge Create Request Redirect schema.
+    # @return [ChargeCreateRequestRedirect]
+    attr_accessor :redirect
+
+    # Charge Create Request Three Ds schema.
+    # @return [ChargeCreateRequestThreeDs]
+    attr_accessor :three_ds
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_token_id'] = 'transaction_token_id'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['capture'] = 'capture'
+      @_hash['capture_at'] = 'capture_at'
+      @_hash['merchant_transaction_id'] = 'merchant_transaction_id'
+      @_hash['metadata'] = 'metadata'
+      @_hash['client_metadata'] = 'client_metadata'
+      @_hash['redirect'] = 'redirect'
+      @_hash['three_ds'] = 'three_ds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        capture
+        capture_at
+        merchant_transaction_id
+        metadata
+        client_metadata
+        redirect
+        three_ds
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_token_id:, amount:, currency: 'JPY',
+                   capture: true, capture_at: SKIP,
+                   merchant_transaction_id: SKIP, metadata: SKIP,
+                   client_metadata: SKIP, redirect: SKIP, three_ds: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction_token_id = transaction_token_id
+      @amount = amount
+      @currency = currency
+      @capture = capture unless capture == SKIP
+      @capture_at = capture_at unless capture_at == SKIP
+      @merchant_transaction_id = merchant_transaction_id unless merchant_transaction_id == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @client_metadata = client_metadata unless client_metadata == SKIP
+      @redirect = redirect unless redirect == SKIP
+      @three_ds = three_ds unless three_ds == 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.
+      transaction_token_id =
+        hash.key?('transaction_token_id') ? hash['transaction_token_id'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash['currency'] ||= 'JPY'
+      capture = hash['capture'] ||= true
+      capture_at = if hash.key?('capture_at')
+                     (DateTimeHelper.from_rfc3339(hash['capture_at']) if hash['capture_at'])
+                   else
+                     SKIP
+                   end
+      merchant_transaction_id =
+        hash.key?('merchant_transaction_id') ? hash['merchant_transaction_id'] : SKIP
+      metadata = GenericMetadata.from_hash(hash['metadata']) if hash['metadata']
+      client_metadata = ChargeCreateRequestClientMetadata.from_hash(hash['client_metadata']) if
+        hash['client_metadata']
+      redirect = ChargeCreateRequestRedirect.from_hash(hash['redirect']) if hash['redirect']
+      three_ds = ChargeCreateRequestThreeDs.from_hash(hash['three_ds']) if hash['three_ds']
+
+      # 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.
+      ChargeCreateRequest.new(transaction_token_id: transaction_token_id,
+                              amount: amount,
+                              currency: currency,
+                              capture: capture,
+                              capture_at: capture_at,
+                              merchant_transaction_id: merchant_transaction_id,
+                              metadata: metadata,
+                              client_metadata: client_metadata,
+                              redirect: redirect,
+                              three_ds: three_ds,
+                              additional_properties: additional_properties)
+    end
+
+    def to_custom_capture_at
+      DateTimeHelper.to_rfc3339(capture_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_token_id: #{@transaction_token_id}, amount: #{@amount},"\
+      " currency: #{@currency}, capture: #{@capture}, capture_at: #{@capture_at},"\
+      " merchant_transaction_id: #{@merchant_transaction_id}, metadata: #{@metadata},"\
+      " client_metadata: #{@client_metadata}, redirect: #{@redirect}, three_ds: #{@three_ds},"\
+      " 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} transaction_token_id: #{@transaction_token_id.inspect}, amount:"\
+      " #{@amount.inspect}, currency: #{@currency.inspect}, capture: #{@capture.inspect},"\
+      " capture_at: #{@capture_at.inspect}, merchant_transaction_id:"\
+      " #{@merchant_transaction_id.inspect}, metadata: #{@metadata.inspect}, client_metadata:"\
+      " #{@client_metadata.inspect}, redirect: #{@redirect.inspect}, three_ds:"\
+      " #{@three_ds.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/charge_create_request_client_metadata.rb

@@ -0,0 +1,76 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Charge Create Request Client Metadata schema.
+  class ChargeCreateRequestClientMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Consumer's IPv4 address.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ip_address'] = 'ip_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ip_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ip_address: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ip_address = ip_address unless ip_address == 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.
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : 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.
+      ChargeCreateRequestClientMetadata.new(ip_address: ip_address,
+                                            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} ip_address: #{@ip_address}, 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} ip_address: #{@ip_address.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/charge_create_request_redirect.rb

@@ -0,0 +1,75 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Charge Create Request Redirect schema.
+  class ChargeCreateRequestRedirect < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL to redirect the customer to after payment completion.
+    # @return [String]
+    attr_accessor :endpoint
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['endpoint'] = 'endpoint'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        endpoint
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(endpoint: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @endpoint = endpoint unless endpoint == 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.
+      endpoint = hash.key?('endpoint') ? hash['endpoint'] : 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.
+      ChargeCreateRequestRedirect.new(endpoint: endpoint,
+                                      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} endpoint: #{@endpoint}, 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} endpoint: #{@endpoint.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/charge_create_request_three_ds.rb

@@ -0,0 +1,88 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Charge Create Request Three Ds schema.
+  class ChargeCreateRequestThreeDs < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL to redirect the customer to after 3DS authentication.
+    # @return [String]
+    attr_accessor :redirect_endpoint
+
+    # 3D-Secure authentication type. App Token Secret is required to use 'skip'.
+    # @return [ChargeCreateRequestThreeDsMode]
+    attr_accessor :mode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['redirect_endpoint'] = 'redirect_endpoint'
+      @_hash['mode'] = 'mode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        redirect_endpoint
+        mode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(redirect_endpoint: SKIP,
+                   mode: ChargeCreateRequestThreeDsMode::NORMAL,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @redirect_endpoint = redirect_endpoint unless redirect_endpoint == SKIP
+      @mode = mode unless mode == 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.
+      redirect_endpoint =
+        hash.key?('redirect_endpoint') ? hash['redirect_endpoint'] : SKIP
+      mode = hash['mode'] ||= ChargeCreateRequestThreeDsMode::NORMAL
+
+      # 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.
+      ChargeCreateRequestThreeDs.new(redirect_endpoint: redirect_endpoint,
+                                     mode: mode,
+                                     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} redirect_endpoint: #{@redirect_endpoint}, mode: #{@mode},"\
+      " 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} redirect_endpoint: #{@redirect_endpoint.inspect}, mode: #{@mode.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/charge_create_request_three_ds_mode.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
+  # 3D-Secure authentication type. App Token Secret is required to use 'skip'.
+  class ChargeCreateRequestThreeDsMode
+    CHARGE_CREATE_REQUEST_THREE_DS_MODE = [
+      # TODO: Write general description for NORMAL
+      NORMAL = 'normal'.freeze,
+
+      # TODO: Write general description for REQUIRE
+      REQUIRE = 'require'.freeze,
+
+      # TODO: Write general description for FORCE
+      FORCE = 'force'.freeze,
+
+      # TODO: Write general description for SKIP
+      SKIP = 'skip'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHARGE_CREATE_REQUEST_THREE_DS_MODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = NORMAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'normal' then NORMAL
+      when 'require' then REQUIRE
+      when 'force' then FORCE
+      when 'skip' then SKIP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/charge_finished_webhook_callback.rb

@@ -0,0 +1,131 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Webhook envelope for the charge_finished event.
+  class ChargeFinishedWebhookCallback < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID of this webhook delivery.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Event type discriminator — always `charge_finished` for this callback.
+    # @return [String]
+    attr_reader :event
+
+    # Charge resource returned by the payments API.
+    # @return [Charge]
+    attr_accessor :data
+
+    # Timestamp when the event was fired.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['event'] = 'event'
+      @_hash['data'] = 'data'
+      @_hash['created_on'] = 'created_on'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, created_on:, data: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @event = 'charge_finished'
+      @data = data unless data == SKIP
+      @created_on = created_on
+      @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'] : nil
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   end
+      data = Charge.from_hash(hash['data']) if hash['data']
+
+      # 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.
+      ChargeFinishedWebhookCallback.new(id: id,
+                                        created_on: created_on,
+                                        data: data,
+                                        additional_properties: additional_properties)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ChargeFinishedWebhookCallback | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.event,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.created_on,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['event'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['created_on'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, event: #{@event}, data: #{@data}, created_on: #{@created_on},"\
+      " 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}, event: #{@event.inspect}, data: #{@data.inspect},"\
+      " created_on: #{@created_on.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/charge_list.rb

@@ -0,0 +1,104 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Paginated list of charges.
+  class ChargeList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of resources.
+    # @return [Array[Charge]]
+    attr_accessor :items
+
+    # Whether more results are available.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more
+
+    # Total number of matching resources.
+    # @return [Integer]
+    attr_accessor :total_hits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash['has_more'] = 'has_more'
+      @_hash['total_hits'] = 'total_hits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+        has_more
+        total_hits
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items: SKIP, has_more: SKIP, total_hits: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @items = items unless items == SKIP
+      @has_more = has_more unless has_more == SKIP
+      @total_hits = total_hits unless total_hits == 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
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (Charge.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      has_more = hash.key?('has_more') ? hash['has_more'] : SKIP
+      total_hits = hash.key?('total_hits') ? hash['total_hits'] : 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.
+      ChargeList.new(items: items,
+                     has_more: has_more,
+                     total_hits: total_hits,
+                     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} items: #{@items}, has_more: #{@has_more}, total_hits: #{@total_hits},"\
+      " 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} items: #{@items.inspect}, has_more: #{@has_more.inspect}, total_hits:"\
+      " #{@total_hits.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end