univapay-apimatic-sdk 0.0.1

data/lib/univapay_client_sdk/models/recurring_token_deleted_webhook_callback.rb

@@ -0,0 +1,132 @@
+# 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 recurring_token_deleted event.
+  class RecurringTokenDeletedWebhookCallback < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID of this webhook delivery.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Event type discriminator — always `recurring_token_deleted` for this
+    # callback.
+    # @return [String]
+    attr_reader :event
+
+    # Stored transaction token resource.
+    # @return [TransactionToken]
+    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 = 'recurring_token_deleted'
+      @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 = TransactionToken.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.
+      RecurringTokenDeletedWebhookCallback.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 [RecurringTokenDeletedWebhookCallback | 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/refund.rb

@@ -0,0 +1,240 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Represents a refund issued against a charge.
+  class Refund < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Store identifier.
+    # @return [UUID | String]
+    attr_accessor :store_id
+
+    # Charge identifier.
+    # @return [UUID | String]
+    attr_accessor :charge_id
+
+    # Current status of the refund. `pending`: The refund has been created and
+    # is being processed. `successful`: The refund was processed successfully.
+    # `failed`: The refund was rejected by the gateway. `error`: An unexpected
+    # error occurred during processing.
+    # @return [RefundStatus]
+    attr_accessor :status
+
+    # Refund amount in the smallest currency unit (e.g., cents for USD, yen for
+    # JPY).
+    # @return [Integer]
+    attr_accessor :amount
+
+    # ISO-4217 currency code. Must match the charged currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # Refund amount formatted for display.
+    # @return [Float]
+    attr_accessor :amount_formatted
+
+    # Refund reason returned by the API, or `null` when unset.
+    # @return [RefundReasonResponse]
+    attr_accessor :reason
+
+    # Optional free-text note about the refund.
+    # @return [String]
+    attr_accessor :message
+
+    # Payment error details, or null if successful.
+    # @return [PaymentError]
+    attr_accessor :error
+
+    # A free-form dictionary for custom metadata.
+    # @return [GenericMetadata]
+    attr_accessor :metadata
+
+    # Charge Mode schema.
+    # @return [ChargeMode]
+    attr_accessor :mode
+
+    # Timestamp when the resource was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # Timestamp when the resource was last updated.
+    # @return [DateTime]
+    attr_accessor :updated_on
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['store_id'] = 'store_id'
+      @_hash['charge_id'] = 'charge_id'
+      @_hash['status'] = 'status'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['amount_formatted'] = 'amount_formatted'
+      @_hash['reason'] = 'reason'
+      @_hash['message'] = 'message'
+      @_hash['error'] = 'error'
+      @_hash['metadata'] = 'metadata'
+      @_hash['mode'] = 'mode'
+      @_hash['created_on'] = 'created_on'
+      @_hash['updated_on'] = 'updated_on'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        store_id
+        charge_id
+        status
+        amount
+        currency
+        amount_formatted
+        reason
+        message
+        error
+        metadata
+        mode
+        created_on
+        updated_on
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reason
+        message
+        error
+      ]
+    end
+
+    def initialize(id: SKIP, store_id: SKIP, charge_id: SKIP, status: SKIP,
+                   amount: SKIP, currency: SKIP, amount_formatted: SKIP,
+                   reason: SKIP, message: SKIP, error: SKIP, metadata: SKIP,
+                   mode: SKIP, created_on: SKIP, updated_on: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @store_id = store_id unless store_id == SKIP
+      @charge_id = charge_id unless charge_id == SKIP
+      @status = status unless status == SKIP
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @amount_formatted = amount_formatted unless amount_formatted == SKIP
+      @reason = reason unless reason == SKIP
+      @message = message unless message == SKIP
+      @error = error unless error == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @mode = mode unless mode == SKIP
+      @created_on = created_on unless created_on == SKIP
+      @updated_on = updated_on unless updated_on == 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
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+      charge_id = hash.key?('charge_id') ? hash['charge_id'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      amount_formatted =
+        hash.key?('amount_formatted') ? hash['amount_formatted'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      error = PaymentError.from_hash(hash['error']) if hash['error']
+      metadata = GenericMetadata.from_hash(hash['metadata']) if hash['metadata']
+      mode = hash.key?('mode') ? hash['mode'] : SKIP
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   else
+                     SKIP
+                   end
+      updated_on = if hash.key?('updated_on')
+                     (DateTimeHelper.from_rfc3339(hash['updated_on']) if hash['updated_on'])
+                   else
+                     SKIP
+                   end
+
+      # 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.
+      Refund.new(id: id,
+                 store_id: store_id,
+                 charge_id: charge_id,
+                 status: status,
+                 amount: amount,
+                 currency: currency,
+                 amount_formatted: amount_formatted,
+                 reason: reason,
+                 message: message,
+                 error: error,
+                 metadata: metadata,
+                 mode: mode,
+                 created_on: created_on,
+                 updated_on: updated_on,
+                 additional_properties: additional_properties)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    def to_custom_updated_on
+      DateTimeHelper.to_rfc3339(updated_on)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Refund | 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} id: #{@id}, store_id: #{@store_id}, charge_id: #{@charge_id}, status:"\
+      " #{@status}, amount: #{@amount}, currency: #{@currency}, amount_formatted:"\
+      " #{@amount_formatted}, reason: #{@reason}, message: #{@message}, error: #{@error},"\
+      " metadata: #{@metadata}, mode: #{@mode}, created_on: #{@created_on}, updated_on:"\
+      " #{@updated_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}, store_id: #{@store_id.inspect}, charge_id:"\
+      " #{@charge_id.inspect}, status: #{@status.inspect}, amount: #{@amount.inspect}, currency:"\
+      " #{@currency.inspect}, amount_formatted: #{@amount_formatted.inspect}, reason:"\
+      " #{@reason.inspect}, message: #{@message.inspect}, error: #{@error.inspect}, metadata:"\
+      " #{@metadata.inspect}, mode: #{@mode.inspect}, created_on: #{@created_on.inspect},"\
+      " updated_on: #{@updated_on.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/refund_create_request.rb

@@ -0,0 +1,118 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Request body for creating a refund against a successful charge. Konbini and
+  # bank transfer charges cannot be refunded.
+  class RefundCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount to refund in the smallest currency unit. Must be greater than 0 and
+    # not exceed the charged amount. Partial refunds are supported for most
+    # payment methods.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # ISO-4217 currency code. Must exactly match the currency of the original
+    # charge.
+    # @return [String]
+    attr_accessor :currency
+
+    # The reason for the refund (merchant-settable values). `duplicate`: A
+    # duplicate charge was made. `fraud`: The charge is fraudulent.
+    # `customer_request`: The customer requested the refund.
+    # @return [RefundReasonRequest]
+    attr_accessor :reason
+
+    # Optional free-text note about the reason for the refund.
+    # @return [String]
+    attr_accessor :message
+
+    # A free-form dictionary for custom metadata.
+    # @return [GenericMetadata]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['reason'] = 'reason'
+      @_hash['message'] = 'message'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+        message
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency:, reason: SKIP, message: SKIP,
+                   metadata: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency
+      @reason = reason unless reason == SKIP
+      @message = message unless message == SKIP
+      @metadata = metadata unless metadata == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      metadata = GenericMetadata.from_hash(hash['metadata']) if hash['metadata']
+
+      # 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.
+      RefundCreateRequest.new(amount: amount,
+                              currency: currency,
+                              reason: reason,
+                              message: message,
+                              metadata: metadata,
+                              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} amount: #{@amount}, currency: #{@currency}, reason: #{@reason}, message:"\
+      " #{@message}, metadata: #{@metadata}, 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} amount: #{@amount.inspect}, currency: #{@currency.inspect}, reason:"\
+      " #{@reason.inspect}, message: #{@message.inspect}, metadata: #{@metadata.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/refund_event.rb

@@ -0,0 +1,26 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Event type discriminator — always `refund_finished` for this callback.
+  class RefundEvent
+    REFUND_EVENT = [
+      # TODO: Write general description for REFUND_FINISHED
+      REFUND_FINISHED = 'refund_finished'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REFUND_EVENT.include?(value)
+    end
+
+    def self.from_value(value, default_value = REFUND_FINISHED)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/univapay_client_sdk/models/refund_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 refunds.
+  class RefundList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of resources.
+    # @return [Array[Refund]]
+    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 << (Refund.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.
+      RefundList.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

data/lib/univapay_client_sdk/models/refund_reason_request.rb

@@ -0,0 +1,42 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # The reason for the refund (merchant-settable values). `duplicate`: A
+  # duplicate charge was made. `fraud`: The charge is fraudulent.
+  # `customer_request`: The customer requested the refund.
+  class RefundReasonRequest
+    REFUND_REASON_REQUEST = [
+      # TODO: Write general description for DUPLICATE
+      DUPLICATE = 'duplicate'.freeze,
+
+      # TODO: Write general description for FRAUD
+      FRAUD = 'fraud'.freeze,
+
+      # TODO: Write general description for CUSTOMER_REQUEST
+      CUSTOMER_REQUEST = 'customer_request'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REFUND_REASON_REQUEST.include?(value)
+    end
+
+    def self.from_value(value, default_value = DUPLICATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'duplicate' then DUPLICATE
+      when 'fraud' then FRAUD
+      when 'customer_request' then CUSTOMER_REQUEST
+      else
+        default_value
+      end
+    end
+  end
+end