univapay-apimatic-sdk 0.0.1

data/lib/univapay_client_sdk/models/subscription_patch_payment_request.rb

@@ -0,0 +1,117 @@
+# 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 scheduled payment. All fields are optional.
+  # Omitted fields are left unchanged.
+  class SubscriptionPatchPaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # New due date for this payment (YYYY-MM-DD).  Only available to merchants
+    # with permission to edit payment dates.
+    # @return [Date]
+    attr_accessor :due_date
+
+    # Mark this payment as paid. Setting to `true` will trigger scheduling  of
+    # the next payment in the cycle.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_paid
+
+    # 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
+
+    # ISO-8601 Duration override for the retry interval on a scheduled payment
+    # (for example `P3D`). Send `null` to clear.
+    # @return [String]
+    attr_accessor :retry_interval
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['due_date'] = 'due_date'
+      @_hash['is_paid'] = 'is_paid'
+      @_hash['terminate_with_status'] = 'terminate_with_status'
+      @_hash['retry_interval'] = 'retry_interval'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        due_date
+        is_paid
+        terminate_with_status
+        retry_interval
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        terminate_with_status
+        retry_interval
+      ]
+    end
+
+    def initialize(due_date: SKIP, is_paid: SKIP, terminate_with_status: SKIP,
+                   retry_interval: 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
+      @is_paid = is_paid unless is_paid == SKIP
+      @terminate_with_status = terminate_with_status unless terminate_with_status == 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.
+      due_date = hash.key?('due_date') ? hash['due_date'] : SKIP
+      is_paid = hash.key?('is_paid') ? hash['is_paid'] : SKIP
+      terminate_with_status =
+        hash.key?('terminate_with_status') ? hash['terminate_with_status'] : SKIP
+      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.
+      SubscriptionPatchPaymentRequest.new(due_date: due_date,
+                                          is_paid: is_paid,
+                                          terminate_with_status: terminate_with_status,
+                                          retry_interval: retry_interval,
+                                          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}, is_paid: #{@is_paid}, terminate_with_status:"\
+      " #{@terminate_with_status}, 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} due_date: #{@due_date.inspect}, is_paid: #{@is_paid.inspect},"\
+      " terminate_with_status: #{@terminate_with_status.inspect}, retry_interval:"\
+      " #{@retry_interval.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_patch_token_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 updating the payment method (transaction token) of a
+  # subscription. The new token must belong to the same store, be active, and
+  # match the subscription's mode.
+  class SubscriptionPatchTokenRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the new transaction token to use for future subscription
+    # payments. Must be a recurring or subscription-type token for the same
+    # store.
+    # @return [UUID | String]
+    attr_accessor :transaction_token_id
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_token_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction_token_id = transaction_token_id
+      @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'] : 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.
+      SubscriptionPatchTokenRequest.new(transaction_token_id: transaction_token_id,
+                                        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}, 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},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_payment.rb

@@ -0,0 +1,185 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Represents a single scheduled or historical payment for a subscription.
+  class SubscriptionPayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Scheduled due date.
+    # @return [Date]
+    attr_accessor :due_date
+
+    # IANA Timezone ID.
+    # @return [String]
+    attr_accessor :zone_id
+
+    # Amount in the smallest currency unit.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # ISO-4217 currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # Amount formatted for display.
+    # @return [Float]
+    attr_accessor :amount_formatted
+
+    # Indicates whether this specific payment cycle has been successfully
+    # charged.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_paid
+
+    # Indicates if this is the final payment in a limited-cycle subscription.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_last_payment
+
+    # 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['due_date'] = 'due_date'
+      @_hash['zone_id'] = 'zone_id'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['amount_formatted'] = 'amount_formatted'
+      @_hash['is_paid'] = 'is_paid'
+      @_hash['is_last_payment'] = 'is_last_payment'
+      @_hash['created_on'] = 'created_on'
+      @_hash['updated_on'] = 'updated_on'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        due_date
+        zone_id
+        amount
+        currency
+        amount_formatted
+        is_paid
+        is_last_payment
+        created_on
+        updated_on
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, due_date: SKIP, zone_id: SKIP, amount: SKIP,
+                   currency: SKIP, amount_formatted: SKIP, is_paid: SKIP,
+                   is_last_payment: 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
+      @due_date = due_date unless due_date == SKIP
+      @zone_id = zone_id unless zone_id == SKIP
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @amount_formatted = amount_formatted unless amount_formatted == SKIP
+      @is_paid = is_paid unless is_paid == SKIP
+      @is_last_payment = is_last_payment unless is_last_payment == 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
+      due_date = hash.key?('due_date') ? hash['due_date'] : SKIP
+      zone_id = hash.key?('zone_id') ? hash['zone_id'] : 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
+      is_paid = hash.key?('is_paid') ? hash['is_paid'] : SKIP
+      is_last_payment =
+        hash.key?('is_last_payment') ? hash['is_last_payment'] : 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.
+      SubscriptionPayment.new(id: id,
+                              due_date: due_date,
+                              zone_id: zone_id,
+                              amount: amount,
+                              currency: currency,
+                              amount_formatted: amount_formatted,
+                              is_paid: is_paid,
+                              is_last_payment: is_last_payment,
+                              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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, due_date: #{@due_date}, zone_id: #{@zone_id}, amount:"\
+      " #{@amount}, currency: #{@currency}, amount_formatted: #{@amount_formatted}, is_paid:"\
+      " #{@is_paid}, is_last_payment: #{@is_last_payment}, 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}, due_date: #{@due_date.inspect}, zone_id:"\
+      " #{@zone_id.inspect}, amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
+      " amount_formatted: #{@amount_formatted.inspect}, is_paid: #{@is_paid.inspect},"\
+      " is_last_payment: #{@is_last_payment.inspect}, created_on: #{@created_on.inspect},"\
+      " updated_on: #{@updated_on.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/subscription_payment_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 subscription payments.
+  class SubscriptionPaymentList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of resources.
+    # @return [Array[SubscriptionPayment]]
+    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 << (SubscriptionPayment.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.
+      SubscriptionPaymentList.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/subscription_payment_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_payment event.
+  class SubscriptionPaymentWebhookCallback < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID of this webhook delivery.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Event type discriminator — always `subscription_payment` 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_payment'
+      @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.
+      SubscriptionPaymentWebhookCallback.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 [SubscriptionPaymentWebhookCallback | 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_period.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 Period schema.
+  class SubscriptionPeriod
+    SUBSCRIPTION_PERIOD = [
+      # TODO: Write general description for DAILY
+      DAILY = 'daily'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'weekly'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'biweekly'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'monthly'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'quarterly'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'semiannually'.freeze,
+
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'annually'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_PERIOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = DAILY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'daily' then DAILY
+      when 'weekly' then WEEKLY
+      when 'biweekly' then BIWEEKLY
+      when 'monthly' then MONTHLY
+      when 'quarterly' then QUARTERLY
+      when 'semiannually' then SEMIANNUALLY
+      when 'annually' then ANNUALLY
+      else
+        default_value
+      end
+    end
+  end
+end