maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/bank_account_attributes.rb

@@ -0,0 +1,175 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BankAccountAttributes Model.
+  class BankAccountAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :chargify_token
+
+    # (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. 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
+
+    # (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
+
+    # Defaults to checking
+    # @return [BankAccountType]
+    attr_accessor :bank_account_type
+
+    # (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). International
+    # Bank Account Number. Alternatively, local bank details can be provided
+    # @return [String]
+    attr_accessor :bank_iban
+
+    # Defaults to personal
+    # @return [BankAccountHolderType]
+    attr_accessor :bank_account_holder_type
+
+    # Defaults to personal
+    # @return [PaymentType]
+    attr_accessor :payment_type
+
+    # 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 :vault_token
+
+    # (only for Authorize.Net CIM storage or Square) The customerProfileId for
+    # the owner of the customerPaymentProfileId provided as the vault_token
+    # @return [String]
+    attr_accessor :customer_vault_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['chargify_token'] = 'chargify_token'
+      @_hash['bank_name'] = 'bank_name'
+      @_hash['bank_routing_number'] = 'bank_routing_number'
+      @_hash['bank_account_number'] = 'bank_account_number'
+      @_hash['bank_account_type'] = 'bank_account_type'
+      @_hash['bank_branch_code'] = 'bank_branch_code'
+      @_hash['bank_iban'] = 'bank_iban'
+      @_hash['bank_account_holder_type'] = 'bank_account_holder_type'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['current_vault'] = 'current_vault'
+      @_hash['vault_token'] = 'vault_token'
+      @_hash['customer_vault_token'] = 'customer_vault_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        chargify_token
+        bank_name
+        bank_routing_number
+        bank_account_number
+        bank_account_type
+        bank_branch_code
+        bank_iban
+        bank_account_holder_type
+        payment_type
+        current_vault
+        vault_token
+        customer_vault_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(chargify_token = SKIP,
+                   bank_name = SKIP,
+                   bank_routing_number = SKIP,
+                   bank_account_number = SKIP,
+                   bank_account_type = BankAccountType::CHECKING,
+                   bank_branch_code = SKIP,
+                   bank_iban = SKIP,
+                   bank_account_holder_type = SKIP,
+                   payment_type = SKIP,
+                   current_vault = SKIP,
+                   vault_token = SKIP,
+                   customer_vault_token = SKIP)
+      @chargify_token = chargify_token unless chargify_token == SKIP
+      @bank_name = bank_name unless bank_name == SKIP
+      @bank_routing_number = bank_routing_number unless bank_routing_number == SKIP
+      @bank_account_number = bank_account_number unless bank_account_number == SKIP
+      @bank_account_type = bank_account_type unless bank_account_type == SKIP
+      @bank_branch_code = bank_branch_code unless bank_branch_code == SKIP
+      @bank_iban = bank_iban unless bank_iban == SKIP
+      @bank_account_holder_type = bank_account_holder_type unless bank_account_holder_type == SKIP
+      @payment_type = payment_type unless payment_type == SKIP
+      @current_vault = current_vault unless current_vault == SKIP
+      @vault_token = vault_token unless vault_token == SKIP
+      @customer_vault_token = customer_vault_token unless customer_vault_token == 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.
+      chargify_token =
+        hash.key?('chargify_token') ? hash['chargify_token'] : SKIP
+      bank_name = hash.key?('bank_name') ? hash['bank_name'] : SKIP
+      bank_routing_number =
+        hash.key?('bank_routing_number') ? hash['bank_routing_number'] : SKIP
+      bank_account_number =
+        hash.key?('bank_account_number') ? hash['bank_account_number'] : SKIP
+      bank_account_type =
+        hash['bank_account_type'] ||= BankAccountType::CHECKING
+      bank_branch_code =
+        hash.key?('bank_branch_code') ? hash['bank_branch_code'] : SKIP
+      bank_iban = hash.key?('bank_iban') ? hash['bank_iban'] : SKIP
+      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
+      current_vault = hash.key?('current_vault') ? hash['current_vault'] : SKIP
+      vault_token = hash.key?('vault_token') ? hash['vault_token'] : SKIP
+      customer_vault_token =
+        hash.key?('customer_vault_token') ? hash['customer_vault_token'] : SKIP
+
+      # Create object from extracted values.
+      BankAccountAttributes.new(chargify_token,
+                                bank_name,
+                                bank_routing_number,
+                                bank_account_number,
+                                bank_account_type,
+                                bank_branch_code,
+                                bank_iban,
+                                bank_account_holder_type,
+                                payment_type,
+                                current_vault,
+                                vault_token,
+                                customer_vault_token)
+    end
+  end
+end

data/lib/advanced_billing/models/bank_account_holder_type.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Defaults to personal
+  class BankAccountHolderType
+    BANK_ACCOUNT_HOLDER_TYPE = [
+      # TODO: Write general description for PERSONAL
+      PERSONAL = 'personal'.freeze,
+
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'business'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_ACCOUNT_HOLDER_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/bank_account_payment_profile.rb

@@ -0,0 +1,310 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BankAccountPaymentProfile Model.
+  class BankAccountPaymentProfile < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Chargify-assigned ID of the stored bank account. This value can be
+    # used as an input to payment_profile_id when creating a subscription, in
+    # order to re-use a stored payment profile for the same customer
+    # @return [Integer]
+    attr_accessor :id
+
+    # The first name of the bank account holder
+    # @return [String]
+    attr_accessor :first_name
+
+    # The last name of the bank account holder
+    # @return [String]
+    attr_accessor :last_name
+
+    # The Chargify-assigned id for the customer record to which the bank account
+    # belongs
+    # @return [Integer]
+    attr_accessor :customer_id
+
+    # The vault that stores the payment profile with the provided vault_token.
+    # @return [BankAccountVault]
+    attr_accessor :current_vault
+
+    # The “token” provided by your vault storage for an already stored payment
+    # profile
+    # @return [String]
+    attr_accessor :vault_token
+
+    # The current billing street address for the bank account
+    # @return [String]
+    attr_accessor :billing_address
+
+    # The current billing address city for the bank account
+    # @return [String]
+    attr_accessor :billing_city
+
+    # The current billing address state for the bank account
+    # @return [String]
+    attr_accessor :billing_state
+
+    # The current billing address zip code for the bank account
+    # @return [String]
+    attr_accessor :billing_zip
+
+    # The current billing address country for the bank account
+    # @return [String]
+    attr_accessor :billing_country
+
+    # (only for Authorize.Net CIM storage): the customerProfileId for the owner
+    # of the customerPaymentProfileId provided as the vault_token.
+    # @return [String]
+    attr_accessor :customer_vault_token
+
+    # The current billing street address, second line, for the bank account
+    # @return [String]
+    attr_accessor :billing_address_2
+
+    # The bank where the account resides
+    # @return [String]
+    attr_accessor :bank_name
+
+    # A string representation of the stored bank routing number with all but the
+    # last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’). payment_type will be
+    # bank_account
+    # @return [String]
+    attr_accessor :masked_bank_routing_number
+
+    # A string representation of the stored bank account number with all but the
+    # last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’)
+    # @return [String]
+    attr_accessor :masked_bank_account_number
+
+    # Defaults to checking
+    # @return [BankAccountType]
+    attr_accessor :bank_account_type
+
+    # Defaults to personal
+    # @return [BankAccountHolderType]
+    attr_accessor :bank_account_holder_type
+
+    # Defaults to personal
+    # @return [PaymentType]
+    attr_accessor :payment_type
+
+    # denotes whether a bank account has been verified by providing the amounts
+    # of two small deposits made into the account
+    # @return [TrueClass | FalseClass]
+    attr_accessor :verified
+
+    # denotes whether a bank account has been verified by providing the amounts
+    # of two small deposits made into the account
+    # @return [Integer]
+    attr_accessor :site_gateway_setting_id
+
+    # denotes whether a bank account has been verified by providing the amounts
+    # of two small deposits made into the account
+    # @return [String]
+    attr_accessor :gateway_handle
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['current_vault'] = 'current_vault'
+      @_hash['vault_token'] = 'vault_token'
+      @_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['customer_vault_token'] = 'customer_vault_token'
+      @_hash['billing_address_2'] = 'billing_address_2'
+      @_hash['bank_name'] = 'bank_name'
+      @_hash['masked_bank_routing_number'] = 'masked_bank_routing_number'
+      @_hash['masked_bank_account_number'] = 'masked_bank_account_number'
+      @_hash['bank_account_type'] = 'bank_account_type'
+      @_hash['bank_account_holder_type'] = 'bank_account_holder_type'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['verified'] = 'verified'
+      @_hash['site_gateway_setting_id'] = 'site_gateway_setting_id'
+      @_hash['gateway_handle'] = 'gateway_handle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        first_name
+        last_name
+        customer_id
+        current_vault
+        vault_token
+        billing_address
+        billing_city
+        billing_state
+        billing_zip
+        billing_country
+        customer_vault_token
+        billing_address_2
+        bank_name
+        bank_account_type
+        bank_account_holder_type
+        payment_type
+        verified
+        site_gateway_setting_id
+        gateway_handle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        billing_address
+        billing_city
+        billing_state
+        billing_zip
+        billing_country
+        customer_vault_token
+        billing_address_2
+        gateway_handle
+      ]
+    end
+
+    def initialize(masked_bank_routing_number = nil,
+                   masked_bank_account_number = nil,
+                   id = SKIP,
+                   first_name = SKIP,
+                   last_name = SKIP,
+                   customer_id = SKIP,
+                   current_vault = SKIP,
+                   vault_token = SKIP,
+                   billing_address = SKIP,
+                   billing_city = SKIP,
+                   billing_state = SKIP,
+                   billing_zip = SKIP,
+                   billing_country = SKIP,
+                   customer_vault_token = SKIP,
+                   billing_address_2 = SKIP,
+                   bank_name = SKIP,
+                   bank_account_type = BankAccountType::CHECKING,
+                   bank_account_holder_type = SKIP,
+                   payment_type = SKIP,
+                   verified = false,
+                   site_gateway_setting_id = SKIP,
+                   gateway_handle = SKIP)
+      @id = id unless id == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @customer_id = customer_id unless customer_id == SKIP
+      @current_vault = current_vault unless current_vault == SKIP
+      @vault_token = vault_token unless vault_token == 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
+      @customer_vault_token = customer_vault_token unless customer_vault_token == SKIP
+      @billing_address_2 = billing_address_2 unless billing_address_2 == SKIP
+      @bank_name = bank_name unless bank_name == SKIP
+      @masked_bank_routing_number = masked_bank_routing_number
+      @masked_bank_account_number = masked_bank_account_number
+      @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
+      @verified = verified unless verified == SKIP
+      @site_gateway_setting_id = site_gateway_setting_id unless site_gateway_setting_id == 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.
+      masked_bank_routing_number =
+        hash.key?('masked_bank_routing_number') ? hash['masked_bank_routing_number'] : nil
+      masked_bank_account_number =
+        hash.key?('masked_bank_account_number') ? hash['masked_bank_account_number'] : nil
+      id = hash.key?('id') ? hash['id'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      current_vault = hash.key?('current_vault') ? hash['current_vault'] : SKIP
+      vault_token = hash.key?('vault_token') ? hash['vault_token'] : 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
+      customer_vault_token =
+        hash.key?('customer_vault_token') ? hash['customer_vault_token'] : SKIP
+      billing_address_2 =
+        hash.key?('billing_address_2') ? hash['billing_address_2'] : SKIP
+      bank_name = hash.key?('bank_name') ? hash['bank_name'] : 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
+      verified = hash['verified'] ||= false
+      site_gateway_setting_id =
+        hash.key?('site_gateway_setting_id') ? hash['site_gateway_setting_id'] : SKIP
+      gateway_handle =
+        hash.key?('gateway_handle') ? hash['gateway_handle'] : SKIP
+
+      # Create object from extracted values.
+      BankAccountPaymentProfile.new(masked_bank_routing_number,
+                                    masked_bank_account_number,
+                                    id,
+                                    first_name,
+                                    last_name,
+                                    customer_id,
+                                    current_vault,
+                                    vault_token,
+                                    billing_address,
+                                    billing_city,
+                                    billing_state,
+                                    billing_zip,
+                                    billing_country,
+                                    customer_vault_token,
+                                    billing_address_2,
+                                    bank_name,
+                                    bank_account_type,
+                                    bank_account_holder_type,
+                                    payment_type,
+                                    verified,
+                                    site_gateway_setting_id,
+                                    gateway_handle)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BankAccountPaymentProfile | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.masked_bank_routing_number,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.masked_bank_account_number,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['masked_bank_routing_number'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['masked_bank_account_number'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/bank_account_response.rb

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

data/lib/advanced_billing/models/bank_account_type.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Defaults to checking
+  class BankAccountType
+    BANK_ACCOUNT_TYPE = [
+      # TODO: Write general description for CHECKING
+      CHECKING = 'checking'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'savings'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_ACCOUNT_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/bank_account_vault.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The vault that stores the payment profile with the provided vault_token.
+  class BankAccountVault
+    BANK_ACCOUNT_VAULT = [
+      # TODO: Write general description for BOGUS
+      BOGUS = 'bogus'.freeze,
+
+      # TODO: Write general description for AUTHORIZENET
+      AUTHORIZENET = 'authorizenet'.freeze,
+
+      # TODO: Write general description for STRIPE_CONNECT
+      STRIPE_CONNECT = 'stripe_connect'.freeze,
+
+      # TODO: Write general description for BRAINTREE_BLUE
+      BRAINTREE_BLUE = 'braintree_blue'.freeze,
+
+      # TODO: Write general description for GOCARDLESS
+      GOCARDLESS = 'gocardless'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_ACCOUNT_VAULT.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/bank_account_verification.rb

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