univapay-apimatic-sdk 0.0.1

data/lib/univapay_client_sdk/models/subscription_update_request.rb

@@ -0,0 +1,134 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Request payload for updating a subscription.
+  class SubscriptionUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction token ID used for the subscription.  Can be changed to update
+    # the payment method (e.g., when a card expires).  Allowed only when the
+    # status is `unconfirmed`, `unpaid`, `current`, or `suspended`.
+    # @return [UUID | String]
+    attr_accessor :transaction_token_id
+
+    # The recurring charge amount (applied to the cycle after the next one).
+    # Not available for limited-cycle subscriptions.  To change the immediate
+    # next payment amount, update `next_payment.amount` instead.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # A free-form dictionary for custom metadata.
+    # @return [GenericMetadata]
+    attr_accessor :metadata
+
+    # Update the subscription status.  `suspended`: Pause the subscription.
+    # `unpaid`: Resume a suspended subscription.
+    # @return [SubscriptionUpdateStatus]
+    attr_accessor :status
+
+    # Schedule settings that can be updated on a subscription.
+    # @return [SubscriptionUpdateScheduleSettings]
+    attr_accessor :schedule_settings
+
+    # Fields that can be updated on the next scheduled payment.
+    # @return [SubscriptionUpdateNextPayment]
+    attr_accessor :next_payment
+
+    # 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['metadata'] = 'metadata'
+      @_hash['status'] = 'status'
+      @_hash['schedule_settings'] = 'schedule_settings'
+      @_hash['next_payment'] = 'next_payment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_token_id
+        amount
+        metadata
+        status
+        schedule_settings
+        next_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_token_id: SKIP, amount: SKIP, metadata: SKIP,
+                   status: SKIP, schedule_settings: SKIP, next_payment: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction_token_id = transaction_token_id unless transaction_token_id == SKIP
+      @amount = amount unless amount == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @status = status unless status == SKIP
+      @schedule_settings = schedule_settings unless schedule_settings == SKIP
+      @next_payment = next_payment unless next_payment == 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'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      metadata = GenericMetadata.from_hash(hash['metadata']) if hash['metadata']
+      status = hash.key?('status') ? hash['status'] : SKIP
+      schedule_settings = SubscriptionUpdateScheduleSettings.from_hash(hash['schedule_settings']) if
+        hash['schedule_settings']
+      next_payment = SubscriptionUpdateNextPayment.from_hash(hash['next_payment']) if
+        hash['next_payment']
+
+      # 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.
+      SubscriptionUpdateRequest.new(transaction_token_id: transaction_token_id,
+                                    amount: amount,
+                                    metadata: metadata,
+                                    status: status,
+                                    schedule_settings: schedule_settings,
+                                    next_payment: next_payment,
+                                    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} transaction_token_id: #{@transaction_token_id}, amount: #{@amount},"\
+      " metadata: #{@metadata}, status: #{@status}, schedule_settings: #{@schedule_settings},"\
+      " next_payment: #{@next_payment}, 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}, metadata: #{@metadata.inspect}, status: #{@status.inspect},"\
+      " schedule_settings: #{@schedule_settings.inspect}, next_payment: #{@next_payment.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_update_schedule_settings.rb

@@ -0,0 +1,110 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Schedule settings that can be updated on a subscription.
+  class SubscriptionUpdateScheduleSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Subscription Termination Mode schema.
+    # @return [SubscriptionTerminationMode]
+    attr_accessor :termination_mode
+
+    # Subscription start date. Used to change the first actual charge date  for
+    # subscriptions that initially only registered a payment method.
+    # @return [DateTime]
+    attr_accessor :start_on
+
+    # ISO-8601 Duration for retry interval if payment fails  (e.g., P3D for 3
+    # days, PT48H for 48 hours).
+    # @return [String]
+    attr_accessor :retry_interval
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['termination_mode'] = 'termination_mode'
+      @_hash['start_on'] = 'start_on'
+      @_hash['retry_interval'] = 'retry_interval'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        termination_mode
+        start_on
+        retry_interval
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(termination_mode: SubscriptionTerminationMode::IMMEDIATE,
+                   start_on: SKIP, retry_interval: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @termination_mode = termination_mode unless termination_mode == SKIP
+      @start_on = start_on unless start_on == SKIP
+      @retry_interval = retry_interval unless retry_interval == 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.
+      termination_mode =
+        hash['termination_mode'] ||= SubscriptionTerminationMode::IMMEDIATE
+      start_on = if hash.key?('start_on')
+                   (DateTimeHelper.from_rfc3339(hash['start_on']) if hash['start_on'])
+                 else
+                   SKIP
+                 end
+      retry_interval =
+        hash.key?('retry_interval') ? hash['retry_interval'] : 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.
+      SubscriptionUpdateScheduleSettings.new(termination_mode: termination_mode,
+                                             start_on: start_on,
+                                             retry_interval: retry_interval,
+                                             additional_properties: additional_properties)
+    end
+
+    def to_custom_start_on
+      DateTimeHelper.to_rfc3339(start_on)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} termination_mode: #{@termination_mode}, start_on: #{@start_on},"\
+      " retry_interval: #{@retry_interval}, 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} termination_mode: #{@termination_mode.inspect}, start_on:"\
+      " #{@start_on.inspect}, retry_interval: #{@retry_interval.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_update_status.rb

@@ -0,0 +1,37 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Update the subscription status.  `suspended`: Pause the subscription.
+  # `unpaid`: Resume a suspended subscription.
+  class SubscriptionUpdateStatus
+    SUBSCRIPTION_UPDATE_STATUS = [
+      # TODO: Write general description for SUSPENDED
+      SUSPENDED = 'suspended'.freeze,
+
+      # TODO: Write general description for UNPAID
+      UNPAID = 'unpaid'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_UPDATE_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = SUSPENDED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'suspended' then SUSPENDED
+      when 'unpaid' then UNPAID
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_user_data.rb

@@ -0,0 +1,134 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Customer-facing payment method summary data.
+  class SubscriptionUserData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of the resource.
+    # @return [String]
+    attr_accessor :type
+
+    # Cardholder name value.
+    # @return [String]
+    attr_accessor :cardholder_name
+
+    # Customer email address.
+    # @return [String]
+    attr_accessor :email
+
+    # Brand or network name.
+    # @return [String]
+    attr_accessor :brand
+
+    # Gateway identifier.
+    # @return [String]
+    attr_accessor :gateway
+
+    # Service provider identifier.
+    # @return [String]
+    attr_accessor :service_provider
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['cardholder_name'] = 'cardholder_name'
+      @_hash['email'] = 'email'
+      @_hash['brand'] = 'brand'
+      @_hash['gateway'] = 'gateway'
+      @_hash['service_provider'] = 'service_provider'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        cardholder_name
+        email
+        brand
+        gateway
+        service_provider
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cardholder_name
+        email
+        brand
+        gateway
+        service_provider
+      ]
+    end
+
+    def initialize(type: SKIP, cardholder_name: SKIP, email: SKIP, brand: SKIP,
+                   gateway: SKIP, service_provider: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @cardholder_name = cardholder_name unless cardholder_name == SKIP
+      @email = email unless email == SKIP
+      @brand = brand unless brand == SKIP
+      @gateway = gateway unless gateway == SKIP
+      @service_provider = service_provider unless service_provider == 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
+      cardholder_name =
+        hash.key?('cardholder_name') ? hash['cardholder_name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      gateway = hash.key?('gateway') ? hash['gateway'] : SKIP
+      service_provider =
+        hash.key?('service_provider') ? hash['service_provider'] : 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.
+      SubscriptionUserData.new(type: type,
+                               cardholder_name: cardholder_name,
+                               email: email,
+                               brand: brand,
+                               gateway: gateway,
+                               service_provider: service_provider,
+                               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} type: #{@type}, cardholder_name: #{@cardholder_name}, email: #{@email},"\
+      " brand: #{@brand}, gateway: #{@gateway}, service_provider: #{@service_provider},"\
+      " 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}, cardholder_name: #{@cardholder_name.inspect},"\
+      " email: #{@email.inspect}, brand: #{@brand.inspect}, gateway: #{@gateway.inspect},"\
+      " service_provider: #{@service_provider.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/suspend_schedule_settings.rb

@@ -0,0 +1,78 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Schedule-related settings.
+  class SuspendScheduleSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Subscription Termination Mode schema.
+    # @return [SubscriptionTerminationMode]
+    attr_accessor :termination_mode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['termination_mode'] = 'termination_mode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        termination_mode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(termination_mode: SubscriptionTerminationMode::IMMEDIATE,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @termination_mode = termination_mode unless termination_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.
+      termination_mode =
+        hash['termination_mode'] ||= SubscriptionTerminationMode::IMMEDIATE
+
+      # 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.
+      SuspendScheduleSettings.new(termination_mode: termination_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} termination_mode: #{@termination_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} termination_mode: #{@termination_mode.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/three_ds_issuer_token.rb

@@ -0,0 +1,116 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # 3-D Secure issuer token payload.
+  class ThreeDsIssuerToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Only 'card' is supported for 3-D Secure issuer tokens.
+    # @return [String]
+    attr_reader :payment_type
+
+    # The 3-D Secure authentication URL to which the client must send the
+    # request.
+    # @return [String]
+    attr_accessor :issuer_token
+
+    # Execution method. Currently, only 'http_post' is supported.
+    # @return [String]
+    attr_reader :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
+
+    # The expected content type of the payload required by the card issuer's
+    # endpoint  (e.g., 'application/x-www-form-urlencoded; charset=UTF-8').
+    # @return [String]
+    attr_accessor :content_type
+
+    # 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['content_type'] = 'content_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payload
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payload
+      ]
+    end
+
+    def initialize(issuer_token:, content_type:, payload: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_type = 'card'
+      @issuer_token = issuer_token
+      @call_method = 'http_post'
+      @payload = payload unless payload == SKIP
+      @content_type = content_type
+      @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.
+      issuer_token = hash.key?('issuer_token') ? hash['issuer_token'] : nil
+      content_type = hash.key?('content_type') ? hash['content_type'] : nil
+      payload = IssuerTokenPayload.from_hash(hash['payload']) if hash['payload']
+
+      # 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.
+      ThreeDsIssuerToken.new(issuer_token: issuer_token,
+                             content_type: content_type,
+                             payload: payload,
+                             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}, content_type: #{@content_type},"\
+      " 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}, content_type: #{@content_type.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/three_ds_issuer_token_call_method.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
+  # Execution method. Currently, only 'http_post' is supported.
+  class ThreeDsIssuerTokenCallMethod
+    THREE_DS_ISSUER_TOKEN_CALL_METHOD = [
+      # TODO: Write general description for HTTP_POST
+      HTTP_POST = 'http_post'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      THREE_DS_ISSUER_TOKEN_CALL_METHOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = HTTP_POST)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/univapay_client_sdk/models/three_ds_issuer_token_payment_type.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
+  # Only 'card' is supported for 3-D Secure issuer tokens.
+  class ThreeDsIssuerTokenPaymentType
+    THREE_DS_ISSUER_TOKEN_PAYMENT_TYPE = [
+      # TODO: Write general description for CARD
+      CARD = 'card'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      THREE_DS_ISSUER_TOKEN_PAYMENT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = CARD)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end