subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/subscription_component_allocation_error_item.rb

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

data/lib/advanced_billing/models/subscription_component_response.rb

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

data/lib/advanced_billing/models/subscription_component_subscription.rb

@@ -0,0 +1,70 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # An optional object, will be returned if provided `include=subscription`
+  # query param.
+  class SubscriptionComponentSubscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['state'] = 'state'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        state
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(state = SKIP, updated_at = SKIP)
+      @state = state unless state == SKIP
+      @updated_at = updated_at unless updated_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.
+      state = hash.key?('state') ? hash['state'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionComponentSubscription.new(state,
+                                            updated_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionComponentSubscription | 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/subscription_date_field.rb

@@ -0,0 +1,44 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Date Field.
+  class SubscriptionDateField
+    SUBSCRIPTION_DATE_FIELD = [
+      # TODO: Write general description for CURRENT_PERIOD_ENDS_AT
+      CURRENT_PERIOD_ENDS_AT = 'current_period_ends_at'.freeze,
+
+      # TODO: Write general description for CURRENT_PERIOD_STARTS_AT
+      CURRENT_PERIOD_STARTS_AT = 'current_period_starts_at'.freeze,
+
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze,
+
+      # TODO: Write general description for ACTIVATED_AT
+      ACTIVATED_AT = 'activated_at'.freeze,
+
+      # TODO: Write general description for CANCELED_AT
+      CANCELED_AT = 'canceled_at'.freeze,
+
+      # TODO: Write general description for EXPIRES_AT
+      EXPIRES_AT = 'expires_at'.freeze,
+
+      # TODO: Write general description for TRIAL_STARTED_AT
+      TRIAL_STARTED_AT = 'trial_started_at'.freeze,
+
+      # TODO: Write general description for TRIAL_ENDED_AT
+      TRIAL_ENDED_AT = 'trial_ended_at'.freeze,
+
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SUBSCRIPTION_DATE_FIELD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/subscription_group.rb

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

data/lib/advanced_billing/models/subscription_group_balances.rb

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

data/lib/advanced_billing/models/subscription_group_bank_account.rb

@@ -0,0 +1,228 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionGroupBankAccount Model.
+  class SubscriptionGroupBankAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # (Required when creating a subscription with ACH or GoCardless) The name of
+    # the bank where the customer’s account resides
+    # @return [String]
+    attr_accessor :bank_name
+
+    # (Required when creating a subscription with ACH. Required when creating a
+    # subscription with GoCardless and bank_iban is blank) The customerʼs bank
+    # account number
+    # @return [String]
+    attr_accessor :bank_account_number
+
+    # (Required when creating a subscription with ACH. Optional when creating a
+    # subscription with GoCardless). The routing number of the bank. It becomes
+    # bank_code while passing via GoCardless API
+    # @return [String]
+    attr_accessor :bank_routing_number
+
+    # (Optional when creating a subscription with GoCardless). International
+    # Bank Account Number. Alternatively, local bank details can be provided
+    # @return [String]
+    attr_accessor :bank_iban
+
+    # (Optional when creating a subscription with GoCardless) Branch code.
+    # Alternatively, an IBAN can be provided
+    # @return [String]
+    attr_accessor :bank_branch_code
+
+    # (Optional when creating a subscription with GoCardless) Branch code.
+    # Alternatively, an IBAN can be provided
+    # @return [BankAccountType]
+    attr_accessor :bank_account_type
+
+    # (Optional when creating a subscription with GoCardless) Branch code.
+    # Alternatively, an IBAN can be provided
+    # @return [HolderType]
+    attr_accessor :bank_account_holder_type
+
+    # (Optional when creating a subscription with GoCardless) Branch code.
+    # Alternatively, an IBAN can be provided
+    # @return [String]
+    attr_accessor :payment_type
+
+    # (Optional when creating a subscription with GoCardless) Branch code.
+    # Alternatively, an IBAN can be provided
+    # @return [String]
+    attr_accessor :billing_address
+
+    # (Optional when creating a subscription with GoCardless) Branch code.
+    # Alternatively, an IBAN can be provided
+    # @return [String]
+    attr_accessor :billing_city
+
+    # (Optional when creating a subscription with GoCardless) Branch code.
+    # Alternatively, an IBAN can be provided
+    # @return [String]
+    attr_accessor :billing_state
+
+    # (Optional when creating a subscription with GoCardless) Branch code.
+    # Alternatively, an IBAN can be provided
+    # @return [String]
+    attr_accessor :billing_zip
+
+    # (Optional when creating a subscription with GoCardless) Branch code.
+    # Alternatively, an IBAN can be provided
+    # @return [String]
+    attr_accessor :billing_country
+
+    # (Optional when creating a subscription with GoCardless) Branch code.
+    # Alternatively, an IBAN can be provided
+    # @return [String]
+    attr_accessor :chargify_token
+
+    # The vault that stores the payment profile with the provided vault_token.
+    # @return [BankAccountVault]
+    attr_accessor :current_vault
+
+    # The vault that stores the payment profile with the provided vault_token.
+    # @return [String]
+    attr_accessor :gateway_handle
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bank_name'] = 'bank_name'
+      @_hash['bank_account_number'] = 'bank_account_number'
+      @_hash['bank_routing_number'] = 'bank_routing_number'
+      @_hash['bank_iban'] = 'bank_iban'
+      @_hash['bank_branch_code'] = 'bank_branch_code'
+      @_hash['bank_account_type'] = 'bank_account_type'
+      @_hash['bank_account_holder_type'] = 'bank_account_holder_type'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['billing_city'] = 'billing_city'
+      @_hash['billing_state'] = 'billing_state'
+      @_hash['billing_zip'] = 'billing_zip'
+      @_hash['billing_country'] = 'billing_country'
+      @_hash['chargify_token'] = 'chargify_token'
+      @_hash['current_vault'] = 'current_vault'
+      @_hash['gateway_handle'] = 'gateway_handle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bank_name
+        bank_account_number
+        bank_routing_number
+        bank_iban
+        bank_branch_code
+        bank_account_type
+        bank_account_holder_type
+        payment_type
+        billing_address
+        billing_city
+        billing_state
+        billing_zip
+        billing_country
+        chargify_token
+        current_vault
+        gateway_handle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bank_name = SKIP, bank_account_number = SKIP,
+                   bank_routing_number = SKIP, bank_iban = SKIP,
+                   bank_branch_code = SKIP,
+                   bank_account_type = BankAccountType::CHECKING,
+                   bank_account_holder_type = SKIP, payment_type = SKIP,
+                   billing_address = SKIP, billing_city = SKIP,
+                   billing_state = SKIP, billing_zip = SKIP,
+                   billing_country = SKIP, chargify_token = SKIP,
+                   current_vault = SKIP, gateway_handle = SKIP)
+      @bank_name = bank_name unless bank_name == SKIP
+      @bank_account_number = bank_account_number unless bank_account_number == SKIP
+      @bank_routing_number = bank_routing_number unless bank_routing_number == SKIP
+      @bank_iban = bank_iban unless bank_iban == SKIP
+      @bank_branch_code = bank_branch_code unless bank_branch_code == SKIP
+      @bank_account_type = bank_account_type unless bank_account_type == SKIP
+      @bank_account_holder_type = bank_account_holder_type unless bank_account_holder_type == SKIP
+      @payment_type = payment_type unless payment_type == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @billing_city = billing_city unless billing_city == SKIP
+      @billing_state = billing_state unless billing_state == SKIP
+      @billing_zip = billing_zip unless billing_zip == SKIP
+      @billing_country = billing_country unless billing_country == SKIP
+      @chargify_token = chargify_token unless chargify_token == SKIP
+      @current_vault = current_vault unless current_vault == SKIP
+      @gateway_handle = gateway_handle unless gateway_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.
+      bank_name = hash.key?('bank_name') ? hash['bank_name'] : SKIP
+      bank_account_number =
+        hash.key?('bank_account_number') ? hash['bank_account_number'] : SKIP
+      bank_routing_number =
+        hash.key?('bank_routing_number') ? hash['bank_routing_number'] : SKIP
+      bank_iban = hash.key?('bank_iban') ? hash['bank_iban'] : SKIP
+      bank_branch_code =
+        hash.key?('bank_branch_code') ? hash['bank_branch_code'] : SKIP
+      bank_account_type =
+        hash['bank_account_type'] ||= BankAccountType::CHECKING
+      bank_account_holder_type =
+        hash.key?('bank_account_holder_type') ? hash['bank_account_holder_type'] : SKIP
+      payment_type = hash.key?('payment_type') ? hash['payment_type'] : SKIP
+      billing_address =
+        hash.key?('billing_address') ? hash['billing_address'] : SKIP
+      billing_city = hash.key?('billing_city') ? hash['billing_city'] : SKIP
+      billing_state = hash.key?('billing_state') ? hash['billing_state'] : SKIP
+      billing_zip = hash.key?('billing_zip') ? hash['billing_zip'] : SKIP
+      billing_country =
+        hash.key?('billing_country') ? hash['billing_country'] : SKIP
+      chargify_token =
+        hash.key?('chargify_token') ? hash['chargify_token'] : SKIP
+      current_vault = hash.key?('current_vault') ? hash['current_vault'] : SKIP
+      gateway_handle =
+        hash.key?('gateway_handle') ? hash['gateway_handle'] : SKIP
+
+      # Create object from extracted values.
+      SubscriptionGroupBankAccount.new(bank_name,
+                                       bank_account_number,
+                                       bank_routing_number,
+                                       bank_iban,
+                                       bank_branch_code,
+                                       bank_account_type,
+                                       bank_account_holder_type,
+                                       payment_type,
+                                       billing_address,
+                                       billing_city,
+                                       billing_state,
+                                       billing_zip,
+                                       billing_country,
+                                       chargify_token,
+                                       current_vault,
+                                       gateway_handle)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionGroupBankAccount | 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