univapay-apimatic-sdk 0.0.1

data/lib/univapay_client_sdk/models/cancel.rb

@@ -0,0 +1,183 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Represents a cancellation request for a charge.
+  class Cancel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the cancel.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # ID of the charge this cancel is associated with.
+    # @return [UUID | String]
+    attr_accessor :charge_id
+
+    # ID of the store.
+    # @return [UUID | String]
+    attr_accessor :store_id
+
+    # Current status of the cancel operation.
+    # @return [CancelStatus]
+    attr_accessor :status
+
+    # 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 cancel was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # Timestamp when the cancel 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['charge_id'] = 'charge_id'
+      @_hash['store_id'] = 'store_id'
+      @_hash['status'] = 'status'
+      @_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
+        charge_id
+        store_id
+        status
+        error
+        metadata
+        mode
+        created_on
+        updated_on
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        error
+      ]
+    end
+
+    def initialize(id: SKIP, charge_id: SKIP, store_id: SKIP, status: 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
+      @charge_id = charge_id unless charge_id == SKIP
+      @store_id = store_id unless store_id == SKIP
+      @status = status unless status == 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
+      charge_id = hash.key?('charge_id') ? hash['charge_id'] : SKIP
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+      status = hash.key?('status') ? hash['status'] : 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.
+      Cancel.new(id: id,
+                 charge_id: charge_id,
+                 store_id: store_id,
+                 status: status,
+                 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 [Cancel | 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}, charge_id: #{@charge_id}, store_id: #{@store_id}, status:"\
+      " #{@status}, 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}, charge_id: #{@charge_id.inspect}, store_id:"\
+      " #{@store_id.inspect}, status: #{@status.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/cancel_create_request.rb

@@ -0,0 +1,77 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Request body to create a cancel for a charge. Only `metadata` is accepted;
+  # all other fields are determined server-side. The charge must be in a
+  # cancellable state.
+  class CancelCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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.
+      CancelCreateRequest.new(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} 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} metadata: #{@metadata.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/cancel_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 `cancel_finished` for this callback.
+  class CancelEvent
+    CANCEL_EVENT = [
+      # TODO: Write general description for CANCEL_FINISHED
+      CANCEL_FINISHED = 'cancel_finished'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CANCEL_EVENT.include?(value)
+    end
+
+    def self.from_value(value, default_value = CANCEL_FINISHED)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/univapay_client_sdk/models/cancel_list.rb

@@ -0,0 +1,94 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Paginated list of cancels.
+  class CancelList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of resources.
+    # @return [Array[Cancel]]
+    attr_accessor :items
+
+    # Whether more results are available.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+        has_more
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items: SKIP, has_more: 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
+      @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 << (Cancel.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      has_more = hash.key?('has_more') ? hash['has_more'] : 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.
+      CancelList.new(items: items,
+                     has_more: has_more,
+                     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}, 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},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/cancel_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
+  # Current status of the cancel operation.
+  class CancelStatus
+    CANCEL_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?
+
+      CANCEL_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/cancel_update_request.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
+  # Request body for updating a cancel. Only `metadata` is settable by
+  # merchants. All fields are optional; omitted fields are left unchanged.
+  class CancelUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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.
+      CancelUpdateRequest.new(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} 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} metadata: #{@metadata.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/cancel_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 whose `data` payload is a Cancel resource.
+  class CancelWebhookCallback < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Event type discriminator — always `cancel_finished` for this callback.
+    # @return [CancelEvent]
+    attr_accessor :event
+
+    # Unique ID of this webhook delivery.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Timestamp when the event was fired.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # Represents a cancellation request for a charge.
+    # @return [Cancel]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event'] = 'event'
+      @_hash['id'] = 'id'
+      @_hash['created_on'] = 'created_on'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        event
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, created_on:, event: SKIP, data: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @event = event unless event == SKIP
+      @id = id
+      @created_on = created_on
+      @data = data unless data == 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'] : nil
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   end
+      event = hash.key?('event') ? hash['event'] : SKIP
+      data = Cancel.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.
+      CancelWebhookCallback.new(id: id,
+                                created_on: created_on,
+                                event: event,
+                                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 [CancelWebhookCallback | 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.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['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} event: #{@event}, id: #{@id}, created_on: #{@created_on}, data: #{@data},"\
+      " 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} event: #{@event.inspect}, id: #{@id.inspect}, created_on:"\
+      " #{@created_on.inspect}, data: #{@data.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end