univapay-apimatic-sdk 0.0.1

data/lib/univapay_client_sdk/models/subscription_plan_settings.rb

@@ -0,0 +1,98 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Configuration for limited-cycle subscriptions (Univapay side).
+  class SubscriptionPlanSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Plan type selector.
+    # @return [PlanSettingsType]
+    attr_accessor :plan_type
+
+    # Number of cycles for fixed_cycles plan.
+    # @return [Integer]
+    attr_accessor :fixed_cycles
+
+    # Total target amount for fixed_cycle_amount plan.
+    # @return [Integer]
+    attr_accessor :fixed_cycle_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['plan_type'] = 'plan_type'
+      @_hash['fixed_cycles'] = 'fixed_cycles'
+      @_hash['fixed_cycle_amount'] = 'fixed_cycle_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        plan_type
+        fixed_cycles
+        fixed_cycle_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(plan_type: SKIP, fixed_cycles: SKIP,
+                   fixed_cycle_amount: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @plan_type = plan_type unless plan_type == SKIP
+      @fixed_cycles = fixed_cycles unless fixed_cycles == SKIP
+      @fixed_cycle_amount = fixed_cycle_amount unless fixed_cycle_amount == 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.
+      plan_type = hash.key?('plan_type') ? hash['plan_type'] : SKIP
+      fixed_cycles = hash.key?('fixed_cycles') ? hash['fixed_cycles'] : SKIP
+      fixed_cycle_amount =
+        hash.key?('fixed_cycle_amount') ? hash['fixed_cycle_amount'] : 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.
+      SubscriptionPlanSettings.new(plan_type: plan_type,
+                                   fixed_cycles: fixed_cycles,
+                                   fixed_cycle_amount: fixed_cycle_amount,
+                                   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} plan_type: #{@plan_type}, fixed_cycles: #{@fixed_cycles},"\
+      " fixed_cycle_amount: #{@fixed_cycle_amount}, 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} plan_type: #{@plan_type.inspect}, fixed_cycles: #{@fixed_cycles.inspect},"\
+      " fixed_cycle_amount: #{@fixed_cycle_amount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_schedule_settings.rb

@@ -0,0 +1,132 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Schedule settings applied to a subscription.
+  class SubscriptionScheduleSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date when the recurring schedule starts (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :start_on
+
+    # IANA Timezone ID.
+    # @return [String]
+    attr_accessor :zone_id
+
+    # If true, subsequent charges will always occur on the last day of the
+    # month.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :preserve_end_of_month
+
+    # ISO-8601 Duration for retry interval if payment fails (e.g., P5D).
+    # @return [String]
+    attr_accessor :retry_interval
+
+    # 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['start_on'] = 'start_on'
+      @_hash['zone_id'] = 'zone_id'
+      @_hash['preserve_end_of_month'] = 'preserve_end_of_month'
+      @_hash['retry_interval'] = 'retry_interval'
+      @_hash['termination_mode'] = 'termination_mode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_on
+        zone_id
+        preserve_end_of_month
+        retry_interval
+        termination_mode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_on: SKIP, zone_id: SKIP, preserve_end_of_month: SKIP,
+                   retry_interval: SKIP,
+                   termination_mode: SubscriptionTerminationMode::IMMEDIATE,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @start_on = start_on unless start_on == SKIP
+      @zone_id = zone_id unless zone_id == SKIP
+      @preserve_end_of_month = preserve_end_of_month unless preserve_end_of_month == SKIP
+      @retry_interval = retry_interval unless retry_interval == SKIP
+      @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.
+      start_on = hash.key?('start_on') ? hash['start_on'] : SKIP
+      zone_id = hash.key?('zone_id') ? hash['zone_id'] : SKIP
+      preserve_end_of_month =
+        hash.key?('preserve_end_of_month') ? hash['preserve_end_of_month'] : SKIP
+      retry_interval =
+        hash.key?('retry_interval') ? hash['retry_interval'] : SKIP
+      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.
+      SubscriptionScheduleSettings.new(start_on: start_on,
+                                       zone_id: zone_id,
+                                       preserve_end_of_month: preserve_end_of_month,
+                                       retry_interval: retry_interval,
+                                       termination_mode: termination_mode,
+                                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionScheduleSettings | 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} start_on: #{@start_on}, zone_id: #{@zone_id}, preserve_end_of_month:"\
+      " #{@preserve_end_of_month}, retry_interval: #{@retry_interval}, 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} start_on: #{@start_on.inspect}, zone_id: #{@zone_id.inspect},"\
+      " preserve_end_of_month: #{@preserve_end_of_month.inspect}, retry_interval:"\
+      " #{@retry_interval.inspect}, termination_mode: #{@termination_mode.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_status.rb

@@ -0,0 +1,56 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Subscription Status schema.
+  class SubscriptionStatus
+    SUBSCRIPTION_STATUS = [
+      # TODO: Write general description for UNVERIFIED
+      UNVERIFIED = 'unverified'.freeze,
+
+      # TODO: Write general description for UNCONFIRMED
+      UNCONFIRMED = 'unconfirmed'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze,
+
+      # TODO: Write general description for UNPAID
+      UNPAID = 'unpaid'.freeze,
+
+      # TODO: Write general description for CURRENT
+      CURRENT = 'current'.freeze,
+
+      # TODO: Write general description for SUSPENDED
+      SUSPENDED = 'suspended'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNVERIFIED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unverified' then UNVERIFIED
+      when 'unconfirmed' then UNCONFIRMED
+      when 'canceled' then CANCELED
+      when 'unpaid' then UNPAID
+      when 'current' then CURRENT
+      when 'suspended' then SUSPENDED
+      when 'completed' then COMPLETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_suspend_request.rb

@@ -0,0 +1,79 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Request body for suspending a subscription. The
+  # `schedule_settings.termination_mode`  field controls when the suspension
+  # takes effect.
+  class SubscriptionSuspendRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Schedule-related settings.
+    # @return [SuspendScheduleSettings]
+    attr_accessor :schedule_settings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['schedule_settings'] = 'schedule_settings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        schedule_settings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(schedule_settings: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @schedule_settings = schedule_settings unless schedule_settings == 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.
+      schedule_settings = SuspendScheduleSettings.from_hash(hash['schedule_settings']) if
+        hash['schedule_settings']
+
+      # 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.
+      SubscriptionSuspendRequest.new(schedule_settings: schedule_settings,
+                                     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} schedule_settings: #{@schedule_settings}, 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} schedule_settings: #{@schedule_settings.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_suspended_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 subscription_suspended event.
+  class SubscriptionSuspendedWebhookCallback < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID of this webhook delivery.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Event type discriminator — always `subscription_suspended` for this
+    # callback.
+    # @return [String]
+    attr_reader :event
+
+    # The Subscription object represents a recurring payment schedule.
+    # @return [Subscription]
+    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 = 'subscription_suspended'
+      @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 = Subscription.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.
+      SubscriptionSuspendedWebhookCallback.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 [SubscriptionSuspendedWebhookCallback | 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/subscription_terminate_with_status.rb

@@ -0,0 +1,36 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # The status to transition the subscription to on the next payment date.
+  class SubscriptionTerminateWithStatus
+    SUBSCRIPTION_TERMINATE_WITH_STATUS = [
+      # TODO: Write general description for SUSPENDED
+      SUSPENDED = 'suspended'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_TERMINATE_WITH_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 'canceled' then CANCELED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_termination_mode.rb

@@ -0,0 +1,36 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Subscription Termination Mode schema.
+  class SubscriptionTerminationMode
+    SUBSCRIPTION_TERMINATION_MODE = [
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'immediate'.freeze,
+
+      # TODO: Write general description for ON_NEXT_PAYMENT
+      ON_NEXT_PAYMENT = 'on_next_payment'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_TERMINATION_MODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = IMMEDIATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'immediate' then IMMEDIATE
+      when 'on_next_payment' then ON_NEXT_PAYMENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_update_next_payment.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
+  # Fields that can be updated on the next scheduled payment.
+  class SubscriptionUpdateNextPayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Next payment date (YYYY-MM-DD).  Note: Only available for merchants
+    # permitted to edit next payment dates.
+    # @return [Date]
+    attr_accessor :due_date
+
+    # Next payment amount. Not available for limited-cycle subscriptions.  Only
+    # available for permitted merchants.  This does not change subsequent cycle
+    # amounts.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Schedule a status transition on a payment's due date. Set to `suspended`
+    # or `canceled` to schedule termination. Send `null` to cancel a previously
+    # scheduled transition.
+    # @return [SubscriptionTerminateWithStatus]
+    attr_accessor :terminate_with_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['due_date'] = 'due_date'
+      @_hash['amount'] = 'amount'
+      @_hash['terminate_with_status'] = 'terminate_with_status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        due_date
+        amount
+        terminate_with_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        terminate_with_status
+      ]
+    end
+
+    def initialize(due_date: SKIP, amount: SKIP, terminate_with_status: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @due_date = due_date unless due_date == SKIP
+      @amount = amount unless amount == SKIP
+      @terminate_with_status = terminate_with_status unless terminate_with_status == 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.
+      due_date = hash.key?('due_date') ? hash['due_date'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      terminate_with_status =
+        hash.key?('terminate_with_status') ? hash['terminate_with_status'] : 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.
+      SubscriptionUpdateNextPayment.new(due_date: due_date,
+                                        amount: amount,
+                                        terminate_with_status: terminate_with_status,
+                                        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} due_date: #{@due_date}, amount: #{@amount}, terminate_with_status:"\
+      " #{@terminate_with_status}, 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} due_date: #{@due_date.inspect}, amount: #{@amount.inspect},"\
+      " terminate_with_status: #{@terminate_with_status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end