subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/payment_related_events.rb

@@ -0,0 +1,79 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PaymentRelatedEvents Model.
+  class PaymentRelatedEvents < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :account_transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'product_id'
+      @_hash['account_transaction_id'] = 'account_transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id = nil, account_transaction_id = nil)
+      @product_id = product_id
+      @account_transaction_id = account_transaction_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      account_transaction_id =
+        hash.key?('account_transaction_id') ? hash['account_transaction_id'] : nil
+
+      # Create object from extracted values.
+      PaymentRelatedEvents.new(product_id,
+                               account_transaction_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentRelatedEvents | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.product_id,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.account_transaction_id,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['product_id'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['account_transaction_id'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/payment_response.rb

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

data/lib/advanced_billing/models/payment_type.rb

@@ -0,0 +1,26 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Payment Type.
+  class PaymentType
+    PAYMENT_TYPE = [
+      # TODO: Write general description for CREDIT_CARD
+      CREDIT_CARD = 'credit_card'.freeze,
+
+      # TODO: Write general description for BANK_ACCOUNT
+      BANK_ACCOUNT = 'bank_account'.freeze,
+
+      # TODO: Write general description for PAYPAL_ACCOUNT
+      PAYPAL_ACCOUNT = 'paypal_account'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/pending_cancellation_change.rb

@@ -0,0 +1,79 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PendingCancellationChange Model.
+  class PendingCancellationChange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cancellation_state
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cancels_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cancellation_state'] = 'cancellation_state'
+      @_hash['cancels_at'] = 'cancels_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cancellation_state = nil, cancels_at = nil)
+      @cancellation_state = cancellation_state
+      @cancels_at = cancels_at
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      cancellation_state =
+        hash.key?('cancellation_state') ? hash['cancellation_state'] : nil
+      cancels_at = hash.key?('cancels_at') ? hash['cancels_at'] : nil
+
+      # Create object from extracted values.
+      PendingCancellationChange.new(cancellation_state,
+                                    cancels_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PendingCancellationChange | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.cancellation_state,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.cancels_at,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['cancellation_state'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['cancels_at'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/portal_management_link.rb

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

data/lib/advanced_billing/models/pre_payment.rb

@@ -0,0 +1,74 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PrePayment Model.
+  class PrePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The subscription id for the prepayment account
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # The amount in cents of the prepayment that was created as a result of this
+    # payment.
+    # @return [String]
+    attr_accessor :amount_in_cents
+
+    # The total balance of the prepayment account for this subscription
+    # including any prior prepayments
+    # @return [String]
+    attr_accessor :ending_balance_in_cents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['ending_balance_in_cents'] = 'ending_balance_in_cents'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subscription_id
+        amount_in_cents
+        ending_balance_in_cents
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subscription_id = SKIP, amount_in_cents = SKIP,
+                   ending_balance_in_cents = SKIP)
+      @subscription_id = subscription_id unless subscription_id == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @ending_balance_in_cents = ending_balance_in_cents unless ending_balance_in_cents == 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.
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      ending_balance_in_cents =
+        hash.key?('ending_balance_in_cents') ? hash['ending_balance_in_cents'] : SKIP
+
+      # Create object from extracted values.
+      PrePayment.new(subscription_id,
+                     amount_in_cents,
+                     ending_balance_in_cents)
+    end
+  end
+end

data/lib/advanced_billing/models/prepaid_component_price_point.rb

@@ -0,0 +1,108 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PrepaidComponentPricePoint Model.
+  class PrepaidComponentPricePoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handle
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :pricing_scheme
+
+    # TODO: Write general description for this method
+    # @return [Array[Price]]
+    attr_accessor :prices
+
+    # TODO: Write general description for this method
+    # @return [OveragePricing]
+    attr_accessor :overage_pricing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash['overage_pricing'] = 'overage_pricing'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        handle
+        pricing_scheme
+        prices
+        overage_pricing
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, handle = SKIP, pricing_scheme = SKIP,
+                   prices = SKIP, overage_pricing = SKIP)
+      @name = name unless name == SKIP
+      @handle = handle unless handle == SKIP
+      @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
+      @prices = prices unless prices == SKIP
+      @overage_pricing = overage_pricing unless overage_pricing == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (Price.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+      overage_pricing = OveragePricing.from_hash(hash['overage_pricing']) if
+        hash['overage_pricing']
+
+      # Create object from extracted values.
+      PrepaidComponentPricePoint.new(name,
+                                     handle,
+                                     pricing_scheme,
+                                     prices,
+                                     overage_pricing)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PrepaidComponentPricePoint | 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/prepaid_configuration.rb

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

data/lib/advanced_billing/models/prepaid_configuration_response.rb

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