subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/list_segments_response.rb

@@ -0,0 +1,59 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSegmentsResponse Model.
+  class ListSegmentsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Segment]]
+    attr_accessor :segments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['segments'] = 'segments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        segments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(segments = SKIP)
+      @segments = segments unless segments == SKIP
+    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
+      segments = nil
+      unless hash['segments'].nil?
+        segments = []
+        hash['segments'].each do |structure|
+          segments << (Segment.from_hash(structure) if structure)
+        end
+      end
+
+      segments = SKIP unless hash.key?('segments')
+
+      # Create object from extracted values.
+      ListSegmentsResponse.new(segments)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subcription_group_prepayment_item.rb

@@ -0,0 +1,137 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSubcriptionGroupPrepaymentItem Model.
+  class ListSubcriptionGroupPrepaymentItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :subscription_group_uid
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :remaining_amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :details
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :external
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # :- When the `method` specified is `"credit_card_on_file"`, the prepayment
+    # amount will be collected using the default credit card payment profile and
+    # applied to the prepayment account balance. This is especially useful for
+    # manual replenishment of prepaid subscriptions.
+    # @return [PrepaymentMethod]
+    attr_accessor :payment_type
+
+    # :- When the `method` specified is `"credit_card_on_file"`, the prepayment
+    # amount will be collected using the default credit card payment profile and
+    # applied to the prepayment account balance. This is especially useful for
+    # manual replenishment of prepaid subscriptions.
+    # @return [String]
+    attr_accessor :created_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['subscription_group_uid'] = 'subscription_group_uid'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['remaining_amount_in_cents'] = 'remaining_amount_in_cents'
+      @_hash['details'] = 'details'
+      @_hash['external'] = 'external'
+      @_hash['memo'] = 'memo'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['created_at'] = 'created_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        subscription_group_uid
+        amount_in_cents
+        remaining_amount_in_cents
+        details
+        external
+        memo
+        payment_type
+        created_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, subscription_group_uid = SKIP,
+                   amount_in_cents = SKIP, remaining_amount_in_cents = SKIP,
+                   details = SKIP, external = SKIP, memo = SKIP,
+                   payment_type = SKIP, created_at = SKIP)
+      @id = id unless id == SKIP
+      @subscription_group_uid = subscription_group_uid unless subscription_group_uid == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      unless remaining_amount_in_cents == SKIP
+        @remaining_amount_in_cents =
+          remaining_amount_in_cents
+      end
+      @details = details unless details == SKIP
+      @external = external unless external == SKIP
+      @memo = memo unless memo == SKIP
+      @payment_type = payment_type unless payment_type == SKIP
+      @created_at = created_at unless created_at == SKIP
+    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
+      subscription_group_uid =
+        hash.key?('subscription_group_uid') ? hash['subscription_group_uid'] : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      remaining_amount_in_cents =
+        hash.key?('remaining_amount_in_cents') ? hash['remaining_amount_in_cents'] : SKIP
+      details = hash.key?('details') ? hash['details'] : SKIP
+      external = hash.key?('external') ? hash['external'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      payment_type = hash.key?('payment_type') ? hash['payment_type'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+
+      # Create object from extracted values.
+      ListSubcriptionGroupPrepaymentItem.new(id,
+                                             subscription_group_uid,
+                                             amount_in_cents,
+                                             remaining_amount_in_cents,
+                                             details,
+                                             external,
+                                             memo,
+                                             payment_type,
+                                             created_at)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_components_include.rb

@@ -0,0 +1,20 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # List Subscription Components Include.
+  class ListSubscriptionComponentsInclude
+    LIST_SUBSCRIPTION_COMPONENTS_INCLUDE = [
+      # TODO: Write general description for SUBSCRIPTION
+      SUBSCRIPTION = 'subscription'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LIST_SUBSCRIPTION_COMPONENTS_INCLUDE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_components_response.rb

@@ -0,0 +1,57 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSubscriptionComponentsResponse Model.
+  class ListSubscriptionComponentsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[SubscriptionComponent]]
+    attr_accessor :subscriptions_components
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscriptions_components'] = 'subscriptions_components'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscriptions_components = nil)
+      @subscriptions_components = subscriptions_components
+    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
+      subscriptions_components = nil
+      unless hash['subscriptions_components'].nil?
+        subscriptions_components = []
+        hash['subscriptions_components'].each do |structure|
+          subscriptions_components << (SubscriptionComponent.from_hash(structure) if structure)
+        end
+      end
+
+      subscriptions_components = nil unless hash.key?('subscriptions_components')
+
+      # Create object from extracted values.
+      ListSubscriptionComponentsResponse.new(subscriptions_components)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_components_sort.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # List Subscription Components Sort.
+  class ListSubscriptionComponentsSort
+    LIST_SUBSCRIPTION_COMPONENTS_SORT = [
+      # TODO: Write general description for ID
+      ID = 'id'.freeze,
+
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LIST_SUBSCRIPTION_COMPONENTS_SORT.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_group_prepayment.rb

@@ -0,0 +1,49 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSubscriptionGroupPrepayment Model.
+  class ListSubscriptionGroupPrepayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ListSubcriptionGroupPrepaymentItem]
+    attr_accessor :prepayment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prepayment'] = 'prepayment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prepayment = nil)
+      @prepayment = prepayment
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      prepayment = ListSubcriptionGroupPrepaymentItem.from_hash(hash['prepayment']) if
+        hash['prepayment']
+
+      # Create object from extracted values.
+      ListSubscriptionGroupPrepayment.new(prepayment)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_group_prepayment_date_field.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # List Subscription Group Prepayment Date Field.
+  class ListSubscriptionGroupPrepaymentDateField
+    LIST_SUBSCRIPTION_GROUP_PREPAYMENT_DATE_FIELD = [
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze,
+
+      # TODO: Write general description for APPLICATION_AT
+      APPLICATION_AT = 'application_at'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LIST_SUBSCRIPTION_GROUP_PREPAYMENT_DATE_FIELD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_group_prepayment_response.rb

@@ -0,0 +1,57 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSubscriptionGroupPrepaymentResponse Model.
+  class ListSubscriptionGroupPrepaymentResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ListSubscriptionGroupPrepayment]]
+    attr_accessor :prepayments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prepayments'] = 'prepayments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prepayments = nil)
+      @prepayments = prepayments
+    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
+      prepayments = nil
+      unless hash['prepayments'].nil?
+        prepayments = []
+        hash['prepayments'].each do |structure|
+          prepayments << (ListSubscriptionGroupPrepayment.from_hash(structure) if structure)
+        end
+      end
+
+      prepayments = nil unless hash.key?('prepayments')
+
+      # Create object from extracted values.
+      ListSubscriptionGroupPrepaymentResponse.new(prepayments)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_groups_item.rb

@@ -0,0 +1,141 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSubscriptionGroupsItem Model.
+  class ListSubscriptionGroupsItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :uid
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :scheme
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :customer_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :payment_profile_id
+
+    # TODO: Write general description for this method
+    # @return [Array[Integer]]
+    attr_accessor :subscription_ids
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :primary_subscription_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :next_assessment_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cancel_at_end_of_period
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupBalances]
+    attr_accessor :account_balances
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['scheme'] = 'scheme'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['payment_profile_id'] = 'payment_profile_id'
+      @_hash['subscription_ids'] = 'subscription_ids'
+      @_hash['primary_subscription_id'] = 'primary_subscription_id'
+      @_hash['next_assessment_at'] = 'next_assessment_at'
+      @_hash['state'] = 'state'
+      @_hash['cancel_at_end_of_period'] = 'cancel_at_end_of_period'
+      @_hash['account_balances'] = 'account_balances'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        scheme
+        customer_id
+        payment_profile_id
+        subscription_ids
+        primary_subscription_id
+        next_assessment_at
+        state
+        cancel_at_end_of_period
+        account_balances
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP, scheme = SKIP, customer_id = SKIP,
+                   payment_profile_id = SKIP, subscription_ids = SKIP,
+                   primary_subscription_id = SKIP, next_assessment_at = SKIP,
+                   state = SKIP, cancel_at_end_of_period = SKIP,
+                   account_balances = SKIP)
+      @uid = uid unless uid == SKIP
+      @scheme = scheme unless scheme == SKIP
+      @customer_id = customer_id unless customer_id == SKIP
+      @payment_profile_id = payment_profile_id unless payment_profile_id == SKIP
+      @subscription_ids = subscription_ids unless subscription_ids == SKIP
+      @primary_subscription_id = primary_subscription_id unless primary_subscription_id == SKIP
+      @next_assessment_at = next_assessment_at unless next_assessment_at == SKIP
+      @state = state unless state == SKIP
+      @cancel_at_end_of_period = cancel_at_end_of_period unless cancel_at_end_of_period == SKIP
+      @account_balances = account_balances unless account_balances == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      scheme = hash.key?('scheme') ? hash['scheme'] : SKIP
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      payment_profile_id =
+        hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
+      subscription_ids =
+        hash.key?('subscription_ids') ? hash['subscription_ids'] : SKIP
+      primary_subscription_id =
+        hash.key?('primary_subscription_id') ? hash['primary_subscription_id'] : SKIP
+      next_assessment_at =
+        hash.key?('next_assessment_at') ? hash['next_assessment_at'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      cancel_at_end_of_period =
+        hash.key?('cancel_at_end_of_period') ? hash['cancel_at_end_of_period'] : SKIP
+      account_balances = SubscriptionGroupBalances.from_hash(hash['account_balances']) if
+        hash['account_balances']
+
+      # Create object from extracted values.
+      ListSubscriptionGroupsItem.new(uid,
+                                     scheme,
+                                     customer_id,
+                                     payment_profile_id,
+                                     subscription_ids,
+                                     primary_subscription_id,
+                                     next_assessment_at,
+                                     state,
+                                     cancel_at_end_of_period,
+                                     account_balances)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_groups_meta.rb

@@ -0,0 +1,59 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSubscriptionGroupsMeta Model.
+  class ListSubscriptionGroupsMeta < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['current_page'] = 'current_page'
+      @_hash['total_count'] = 'total_count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        current_page
+        total_count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(current_page = SKIP, total_count = SKIP)
+      @current_page = current_page unless current_page == SKIP
+      @total_count = total_count unless total_count == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      current_page = hash.key?('current_page') ? hash['current_page'] : SKIP
+      total_count = hash.key?('total_count') ? hash['total_count'] : SKIP
+
+      # Create object from extracted values.
+      ListSubscriptionGroupsMeta.new(current_page,
+                                     total_count)
+    end
+  end
+end

data/lib/advanced_billing/models/list_subscription_groups_response.rb

@@ -0,0 +1,68 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ListSubscriptionGroupsResponse Model.
+  class ListSubscriptionGroupsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ListSubscriptionGroupsItem]]
+    attr_accessor :subscription_groups
+
+    # TODO: Write general description for this method
+    # @return [ListSubscriptionGroupsMeta]
+    attr_accessor :meta
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscription_groups'] = 'subscription_groups'
+      @_hash['meta'] = 'meta'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subscription_groups
+        meta
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscription_groups = SKIP, meta = SKIP)
+      @subscription_groups = subscription_groups unless subscription_groups == SKIP
+      @meta = meta unless meta == SKIP
+    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
+      subscription_groups = nil
+      unless hash['subscription_groups'].nil?
+        subscription_groups = []
+        hash['subscription_groups'].each do |structure|
+          subscription_groups << (ListSubscriptionGroupsItem.from_hash(structure) if structure)
+        end
+      end
+
+      subscription_groups = SKIP unless hash.key?('subscription_groups')
+      meta = ListSubscriptionGroupsMeta.from_hash(hash['meta']) if hash['meta']
+
+      # Create object from extracted values.
+      ListSubscriptionGroupsResponse.new(subscription_groups,
+                                         meta)
+    end
+  end
+end