univapay-apimatic-sdk 0.0.1

data/lib/univapay_client_sdk/models/customs_declaration_event.rb

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

data/lib/univapay_client_sdk/models/customs_declaration_patch_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 for updating a customs declaration. Backend patch handling
+  # keeps the original `customs`, `certificate_id`, and `certificate_name`
+  # values and only accepts a new `merchant_customs_no`.
+  class CustomsDeclarationPatchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Updated merchant customs registration number.
+    # @return [String]
+    attr_accessor :merchant_customs_no
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_customs_no'] = 'merchant_customs_no'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_customs_no:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @merchant_customs_no = merchant_customs_no
+      @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.
+      merchant_customs_no =
+        hash.key?('merchant_customs_no') ? hash['merchant_customs_no'] : nil
+
+      # 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.
+      CustomsDeclarationPatchRequest.new(merchant_customs_no: merchant_customs_no,
+                                         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} merchant_customs_no: #{@merchant_customs_no}, 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} merchant_customs_no: #{@merchant_customs_no.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/customs_declaration_webhook_callback.rb

@@ -0,0 +1,135 @@
+# 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 CustomsDeclaration resource.
+  class CustomsDeclarationWebhookCallback < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Event type discriminator — always `customs_declaration_finished` for this
+    # callback.
+    # @return [CustomsDeclarationEvent]
+    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
+
+    # Customs declaration payload delivered in `customs_declaration_finished`
+    # webhooks. Platform-level deliveries may include `platform_id` and
+    # `updated_on`.
+    # @return [CustomsDeclarationWebhookData]
+    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 = CustomsDeclarationWebhookData.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.
+      CustomsDeclarationWebhookCallback.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 [CustomsDeclarationWebhookCallback | 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

data/lib/univapay_client_sdk/models/customs_declaration_webhook_callback_extension.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
+  # Customs-declaration-specific webhook payload extension.
+  class CustomsDeclarationWebhookCallbackExtension < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Customs declaration payload delivered in `customs_declaration_finished`
+    # webhooks. Platform-level deliveries may include `platform_id` and
+    # `updated_on`.
+    # @return [CustomsDeclarationWebhookData]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      data = CustomsDeclarationWebhookData.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.
+      CustomsDeclarationWebhookCallbackExtension.new(data: data,
+                                                     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}, 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}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/customs_declaration_webhook_data.rb

@@ -0,0 +1,232 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Customs declaration payload delivered in `customs_declaration_finished`
+  # webhooks. Platform-level deliveries may include `platform_id` and
+  # `updated_on`.
+  class CustomsDeclarationWebhookData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Customs declaration identifier.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Charge identifier associated with the declaration.
+    # @return [UUID | String]
+    attr_accessor :charge_id
+
+    # Merchant identifier.
+    # @return [UUID | String]
+    attr_accessor :merchant_id
+
+    # Store identifier.
+    # @return [UUID | String]
+    attr_accessor :store_id
+
+    # Platform identifier, included on platform-level deliveries.
+    # @return [UUID | String]
+    attr_accessor :platform_id
+
+    # Processing mode.
+    # @return [String]
+    attr_accessor :mode
+
+    # Gateway that processed the declaration.
+    # @return [String]
+    attr_accessor :gateway
+
+    # WeChat customs declaration payload returned by the backend formatter.
+    # @return [CustomsDeclarationWebhookDeclaration]
+    attr_accessor :declaration
+
+    # Result payload returned by the customs declaration formatter.
+    # @return [CustomsDeclarationWebhookResult]
+    attr_accessor :declaration_result
+
+    # Customs declaration status returned by the backend.
+    # @return [CustomsDeclarationWebhookStatus]
+    attr_accessor :status
+
+    # Error payload returned when customs declaration processing fails.
+    # @return [CustomsDeclarationWebhookError]
+    attr_accessor :error
+
+    # Timestamp when the declaration was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # Timestamp when the declaration was last updated, included on
+    # platform-level deliveries.
+    # @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['merchant_id'] = 'merchant_id'
+      @_hash['store_id'] = 'store_id'
+      @_hash['platform_id'] = 'platform_id'
+      @_hash['mode'] = 'mode'
+      @_hash['gateway'] = 'gateway'
+      @_hash['declaration'] = 'declaration'
+      @_hash['declaration_result'] = 'declaration_result'
+      @_hash['status'] = 'status'
+      @_hash['error'] = 'error'
+      @_hash['created_on'] = 'created_on'
+      @_hash['updated_on'] = 'updated_on'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        charge_id
+        merchant_id
+        store_id
+        platform_id
+        mode
+        gateway
+        declaration
+        declaration_result
+        status
+        error
+        created_on
+        updated_on
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        platform_id
+        declaration_result
+        error
+        updated_on
+      ]
+    end
+
+    def initialize(id: SKIP, charge_id: SKIP, merchant_id: SKIP, store_id: SKIP,
+                   platform_id: SKIP, mode: SKIP, gateway: SKIP,
+                   declaration: SKIP, declaration_result: SKIP, status: SKIP,
+                   error: 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
+      @merchant_id = merchant_id unless merchant_id == SKIP
+      @store_id = store_id unless store_id == SKIP
+      @platform_id = platform_id unless platform_id == SKIP
+      @mode = mode unless mode == SKIP
+      @gateway = gateway unless gateway == SKIP
+      @declaration = declaration unless declaration == SKIP
+      @declaration_result = declaration_result unless declaration_result == SKIP
+      @status = status unless status == SKIP
+      @error = error unless error == 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
+      merchant_id = hash.key?('merchant_id') ? hash['merchant_id'] : SKIP
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+      platform_id = hash.key?('platform_id') ? hash['platform_id'] : SKIP
+      mode = hash.key?('mode') ? hash['mode'] : SKIP
+      gateway = hash.key?('gateway') ? hash['gateway'] : SKIP
+      declaration = CustomsDeclarationWebhookDeclaration.from_hash(hash['declaration']) if
+        hash['declaration']
+      declaration_result = CustomsDeclarationWebhookResult.from_hash(hash['declaration_result']) if
+        hash['declaration_result']
+      status = hash.key?('status') ? hash['status'] : SKIP
+      error = CustomsDeclarationWebhookError.from_hash(hash['error']) if hash['error']
+      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.
+      CustomsDeclarationWebhookData.new(id: id,
+                                        charge_id: charge_id,
+                                        merchant_id: merchant_id,
+                                        store_id: store_id,
+                                        platform_id: platform_id,
+                                        mode: mode,
+                                        gateway: gateway,
+                                        declaration: declaration,
+                                        declaration_result: declaration_result,
+                                        status: status,
+                                        error: error,
+                                        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 [CustomsDeclarationWebhookData | 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}, merchant_id: #{@merchant_id},"\
+      " store_id: #{@store_id}, platform_id: #{@platform_id}, mode: #{@mode}, gateway:"\
+      " #{@gateway}, declaration: #{@declaration}, declaration_result: #{@declaration_result},"\
+      " status: #{@status}, error: #{@error}, 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}, merchant_id:"\
+      " #{@merchant_id.inspect}, store_id: #{@store_id.inspect}, platform_id:"\
+      " #{@platform_id.inspect}, mode: #{@mode.inspect}, gateway: #{@gateway.inspect},"\
+      " declaration: #{@declaration.inspect}, declaration_result: #{@declaration_result.inspect},"\
+      " status: #{@status.inspect}, error: #{@error.inspect}, created_on: #{@created_on.inspect},"\
+      " updated_on: #{@updated_on.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/customs_declaration_webhook_declaration.rb

@@ -0,0 +1,121 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # WeChat customs declaration payload returned by the backend formatter.
+  class CustomsDeclarationWebhookDeclaration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # WeChat customs authority code.
+    # @return [String]
+    attr_accessor :customs
+
+    # Merchant customs registration number.
+    # @return [String]
+    attr_accessor :merchant_customs_no
+
+    # Customer certificate or passport identifier.
+    # @return [String]
+    attr_accessor :certificate_id
+
+    # Customer name as provided to customs.
+    # @return [String]
+    attr_accessor :certificate_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customs'] = 'customs'
+      @_hash['merchant_customs_no'] = 'merchant_customs_no'
+      @_hash['certificate_id'] = 'certificate_id'
+      @_hash['certificate_name'] = 'certificate_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customs
+        merchant_customs_no
+        certificate_id
+        certificate_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customs: SKIP, merchant_customs_no: SKIP,
+                   certificate_id: SKIP, certificate_name: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @customs = customs unless customs == SKIP
+      @merchant_customs_no = merchant_customs_no unless merchant_customs_no == SKIP
+      @certificate_id = certificate_id unless certificate_id == SKIP
+      @certificate_name = certificate_name unless certificate_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.
+      customs = hash.key?('customs') ? hash['customs'] : SKIP
+      merchant_customs_no =
+        hash.key?('merchant_customs_no') ? hash['merchant_customs_no'] : SKIP
+      certificate_id =
+        hash.key?('certificate_id') ? hash['certificate_id'] : SKIP
+      certificate_name =
+        hash.key?('certificate_name') ? hash['certificate_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.
+      CustomsDeclarationWebhookDeclaration.new(customs: customs,
+                                               merchant_customs_no: merchant_customs_no,
+                                               certificate_id: certificate_id,
+                                               certificate_name: certificate_name,
+                                               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomsDeclarationWebhookDeclaration | 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} customs: #{@customs}, merchant_customs_no: #{@merchant_customs_no},"\
+      " certificate_id: #{@certificate_id}, certificate_name: #{@certificate_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} customs: #{@customs.inspect}, merchant_customs_no:"\
+      " #{@merchant_customs_no.inspect}, certificate_id: #{@certificate_id.inspect},"\
+      " certificate_name: #{@certificate_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end