subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/allocation_payment.rb

@@ -0,0 +1,89 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Information for captured payment, if applicable
+  class AllocationPayment < 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 [Integer]
+    attr_accessor :amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['success'] = 'success'
+      @_hash['memo'] = 'memo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        amount_in_cents
+        success
+        memo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, amount_in_cents = SKIP, success = SKIP,
+                   memo = SKIP)
+      @id = id unless id == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @success = success unless success == SKIP
+      @memo = memo unless memo == 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
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      success = hash.key?('success') ? hash['success'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+
+      # Create object from extracted values.
+      AllocationPayment.new(id,
+                            amount_in_cents,
+                            success,
+                            memo)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AllocationPayment | 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
+  end
+end

data/lib/advanced_billing/models/allocation_preview.rb

@@ -0,0 +1,190 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # AllocationPreview Model.
+  class AllocationPreview < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :start_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :end_date
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :subtotal_in_cents
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_tax_in_cents
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_discount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_in_cents
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :direction
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :proration_scheme
+
+    # TODO: Write general description for this method
+    # @return [Array[AllocationPreviewLineItem]]
+    attr_accessor :line_items
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :accrue_charge
+
+    # TODO: Write general description for this method
+    # @return [Array[AllocationPreviewItem]]
+    attr_accessor :allocations
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :period_type
+
+    # An integer representing the amount of the subscription's current balance
+    # @return [Integer]
+    attr_accessor :existing_balance_in_cents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['subtotal_in_cents'] = 'subtotal_in_cents'
+      @_hash['total_tax_in_cents'] = 'total_tax_in_cents'
+      @_hash['total_discount_in_cents'] = 'total_discount_in_cents'
+      @_hash['total_in_cents'] = 'total_in_cents'
+      @_hash['direction'] = 'direction'
+      @_hash['proration_scheme'] = 'proration_scheme'
+      @_hash['line_items'] = 'line_items'
+      @_hash['accrue_charge'] = 'accrue_charge'
+      @_hash['allocations'] = 'allocations'
+      @_hash['period_type'] = 'period_type'
+      @_hash['existing_balance_in_cents'] = 'existing_balance_in_cents'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+        subtotal_in_cents
+        total_tax_in_cents
+        total_discount_in_cents
+        total_in_cents
+        direction
+        proration_scheme
+        line_items
+        accrue_charge
+        allocations
+        period_type
+        existing_balance_in_cents
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_date = SKIP, end_date = SKIP, subtotal_in_cents = SKIP,
+                   total_tax_in_cents = SKIP, total_discount_in_cents = SKIP,
+                   total_in_cents = SKIP, direction = SKIP,
+                   proration_scheme = SKIP, line_items = SKIP,
+                   accrue_charge = SKIP, allocations = SKIP, period_type = SKIP,
+                   existing_balance_in_cents = SKIP)
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @subtotal_in_cents = subtotal_in_cents unless subtotal_in_cents == SKIP
+      @total_tax_in_cents = total_tax_in_cents unless total_tax_in_cents == SKIP
+      @total_discount_in_cents = total_discount_in_cents unless total_discount_in_cents == SKIP
+      @total_in_cents = total_in_cents unless total_in_cents == SKIP
+      @direction = direction unless direction == SKIP
+      @proration_scheme = proration_scheme unless proration_scheme == SKIP
+      @line_items = line_items unless line_items == SKIP
+      @accrue_charge = accrue_charge unless accrue_charge == SKIP
+      @allocations = allocations unless allocations == SKIP
+      @period_type = period_type unless period_type == SKIP
+      unless existing_balance_in_cents == SKIP
+        @existing_balance_in_cents =
+          existing_balance_in_cents
+      end
+    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_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      subtotal_in_cents =
+        hash.key?('subtotal_in_cents') ? hash['subtotal_in_cents'] : SKIP
+      total_tax_in_cents =
+        hash.key?('total_tax_in_cents') ? hash['total_tax_in_cents'] : SKIP
+      total_discount_in_cents =
+        hash.key?('total_discount_in_cents') ? hash['total_discount_in_cents'] : SKIP
+      total_in_cents =
+        hash.key?('total_in_cents') ? hash['total_in_cents'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+      proration_scheme =
+        hash.key?('proration_scheme') ? hash['proration_scheme'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (AllocationPreviewLineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('line_items')
+      accrue_charge = hash.key?('accrue_charge') ? hash['accrue_charge'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      allocations = nil
+      unless hash['allocations'].nil?
+        allocations = []
+        hash['allocations'].each do |structure|
+          allocations << (AllocationPreviewItem.from_hash(structure) if structure)
+        end
+      end
+
+      allocations = SKIP unless hash.key?('allocations')
+      period_type = hash.key?('period_type') ? hash['period_type'] : SKIP
+      existing_balance_in_cents =
+        hash.key?('existing_balance_in_cents') ? hash['existing_balance_in_cents'] : SKIP
+
+      # Create object from extracted values.
+      AllocationPreview.new(start_date,
+                            end_date,
+                            subtotal_in_cents,
+                            total_tax_in_cents,
+                            total_discount_in_cents,
+                            total_in_cents,
+                            direction,
+                            proration_scheme,
+                            line_items,
+                            accrue_charge,
+                            allocations,
+                            period_type,
+                            existing_balance_in_cents)
+    end
+  end
+end

data/lib/advanced_billing/models/allocation_preview_item.rb

@@ -0,0 +1,187 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # AllocationPreviewItem Model.
+  class AllocationPreviewItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :subscription_id
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :quantity
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :previous_quantity
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :timestamp
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :proration_upgrade_scheme
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :proration_downgrade_scheme
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :accrue_charge
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :upgrade_charge
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :downgrade_credit
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :price_point_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :previous_price_point_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :component_handle
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component_id'] = 'component_id'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['quantity'] = 'quantity'
+      @_hash['previous_quantity'] = 'previous_quantity'
+      @_hash['memo'] = 'memo'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['proration_upgrade_scheme'] = 'proration_upgrade_scheme'
+      @_hash['proration_downgrade_scheme'] = 'proration_downgrade_scheme'
+      @_hash['accrue_charge'] = 'accrue_charge'
+      @_hash['upgrade_charge'] = 'upgrade_charge'
+      @_hash['downgrade_credit'] = 'downgrade_credit'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['previous_price_point_id'] = 'previous_price_point_id'
+      @_hash['component_handle'] = 'component_handle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_id
+        subscription_id
+        quantity
+        previous_quantity
+        memo
+        timestamp
+        proration_upgrade_scheme
+        proration_downgrade_scheme
+        accrue_charge
+        upgrade_charge
+        downgrade_credit
+        price_point_id
+        previous_price_point_id
+        component_handle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        timestamp
+      ]
+    end
+
+    def initialize(component_id = SKIP, subscription_id = SKIP, quantity = SKIP,
+                   previous_quantity = SKIP, memo = SKIP, timestamp = SKIP,
+                   proration_upgrade_scheme = SKIP,
+                   proration_downgrade_scheme = SKIP, accrue_charge = SKIP,
+                   upgrade_charge = SKIP, downgrade_credit = SKIP,
+                   price_point_id = SKIP, previous_price_point_id = SKIP,
+                   component_handle = SKIP)
+      @component_id = component_id unless component_id == SKIP
+      @subscription_id = subscription_id unless subscription_id == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @previous_quantity = previous_quantity unless previous_quantity == SKIP
+      @memo = memo unless memo == SKIP
+      @timestamp = timestamp unless timestamp == SKIP
+      @proration_upgrade_scheme = proration_upgrade_scheme unless proration_upgrade_scheme == SKIP
+      unless proration_downgrade_scheme == SKIP
+        @proration_downgrade_scheme =
+          proration_downgrade_scheme
+      end
+      @accrue_charge = accrue_charge unless accrue_charge == SKIP
+      @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
+      @downgrade_credit = downgrade_credit unless downgrade_credit == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @previous_price_point_id = previous_price_point_id unless previous_price_point_id == SKIP
+      @component_handle = component_handle unless component_handle == 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.
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      previous_quantity =
+        hash.key?('previous_quantity') ? hash['previous_quantity'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      proration_upgrade_scheme =
+        hash.key?('proration_upgrade_scheme') ? hash['proration_upgrade_scheme'] : SKIP
+      proration_downgrade_scheme =
+        hash.key?('proration_downgrade_scheme') ? hash['proration_downgrade_scheme'] : SKIP
+      accrue_charge = hash.key?('accrue_charge') ? hash['accrue_charge'] : SKIP
+      upgrade_charge =
+        hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
+      downgrade_credit =
+        hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
+      previous_price_point_id =
+        hash.key?('previous_price_point_id') ? hash['previous_price_point_id'] : SKIP
+      component_handle =
+        hash.key?('component_handle') ? hash['component_handle'] : SKIP
+
+      # Create object from extracted values.
+      AllocationPreviewItem.new(component_id,
+                                subscription_id,
+                                quantity,
+                                previous_quantity,
+                                memo,
+                                timestamp,
+                                proration_upgrade_scheme,
+                                proration_downgrade_scheme,
+                                accrue_charge,
+                                upgrade_charge,
+                                downgrade_credit,
+                                price_point_id,
+                                previous_price_point_id,
+                                component_handle)
+    end
+  end
+end

data/lib/advanced_billing/models/allocation_preview_line_item.rb

@@ -0,0 +1,130 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # AllocationPreviewLineItem Model.
+  class AllocationPreviewLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :transaction_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :kind
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :discount_amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :taxable_amount_in_cents
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :component_handle
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :direction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash['kind'] = 'kind'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['memo'] = 'memo'
+      @_hash['discount_amount_in_cents'] = 'discount_amount_in_cents'
+      @_hash['taxable_amount_in_cents'] = 'taxable_amount_in_cents'
+      @_hash['component_id'] = 'component_id'
+      @_hash['component_handle'] = 'component_handle'
+      @_hash['direction'] = 'direction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_type
+        kind
+        amount_in_cents
+        memo
+        discount_amount_in_cents
+        taxable_amount_in_cents
+        component_id
+        component_handle
+        direction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_type = SKIP, kind = SKIP, amount_in_cents = SKIP,
+                   memo = SKIP, discount_amount_in_cents = SKIP,
+                   taxable_amount_in_cents = SKIP, component_id = SKIP,
+                   component_handle = SKIP, direction = SKIP)
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @kind = kind unless kind == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @memo = memo unless memo == SKIP
+      @discount_amount_in_cents = discount_amount_in_cents unless discount_amount_in_cents == SKIP
+      @taxable_amount_in_cents = taxable_amount_in_cents unless taxable_amount_in_cents == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @component_handle = component_handle unless component_handle == SKIP
+      @direction = direction unless direction == 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.
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      discount_amount_in_cents =
+        hash.key?('discount_amount_in_cents') ? hash['discount_amount_in_cents'] : SKIP
+      taxable_amount_in_cents =
+        hash.key?('taxable_amount_in_cents') ? hash['taxable_amount_in_cents'] : SKIP
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      component_handle =
+        hash.key?('component_handle') ? hash['component_handle'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+
+      # Create object from extracted values.
+      AllocationPreviewLineItem.new(transaction_type,
+                                    kind,
+                                    amount_in_cents,
+                                    memo,
+                                    discount_amount_in_cents,
+                                    taxable_amount_in_cents,
+                                    component_id,
+                                    component_handle,
+                                    direction)
+    end
+  end
+end

data/lib/advanced_billing/models/allocation_preview_response.rb

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

data/lib/advanced_billing/models/allocation_response.rb

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