maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/customer_attributes.rb

@@ -0,0 +1,243 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CustomerAttributes Model.
+  class CustomerAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first name of the customer. Required when creating a customer via
+    # attributes.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The last name of the customer. Required when creating a customer via
+    # attributes.
+    # @return [String]
+    attr_accessor :last_name
+
+    # The email address of the customer. Required when creating a customer via
+    # attributes.
+    # @return [String]
+    attr_accessor :email
+
+    # A list of emails that should be cc’d on all customer communications.
+    # Optional.
+    # @return [String]
+    attr_accessor :cc_emails
+
+    # The organization/company of the customer. Optional.
+    # @return [String]
+    attr_accessor :organization
+
+    # A customer “reference”, or unique identifier from your app, stored in
+    # Chargify. Can be used so that you may reference your customer’s within
+    # Chargify using the same unique value you use in your application.
+    # Optional.
+    # @return [String]
+    attr_accessor :reference
+
+    # (Optional) The customer’s shipping street address (i.e. “123 Main St.”).
+    # @return [String]
+    attr_accessor :address
+
+    # (Optional) Second line of the customer’s shipping address i.e. “Apt. 100”
+    # @return [String]
+    attr_accessor :address_2
+
+    # (Optional) The customer’s shipping address city (i.e. “Boston”).
+    # @return [String]
+    attr_accessor :city
+
+    # (Optional) The customer’s shipping address state (i.e. “MA”). This must
+    # conform to the
+    # [ISO_3166-1](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) in
+    # order to be valid for tax locale purposes.
+    # @return [String]
+    attr_accessor :state
+
+    # (Optional) The customer’s shipping address zip code (i.e. “12345”).
+    # @return [String]
+    attr_accessor :zip
+
+    # (Optional) The customer shipping address country, required in [ISO_3166-1
+    # alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format (i.e.
+    # “US”).
+    # @return [String]
+    attr_accessor :country
+
+    # (Optional) The phone number of the customer.
+    # @return [String]
+    attr_accessor :phone
+
+    # (Optional) The phone number of the customer.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :verified
+
+    # (Optional) The tax_exempt status of the customer. Acceptable values are
+    # true or 1 for true and false or 0 for false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_exempt
+
+    # (Optional) Supplying the VAT number allows EU customer’s to opt-out of the
+    # Value Added Tax assuming the merchant address and customer billing address
+    # are not within the same EU country. It’s important to omit the country
+    # code from the VAT number upon entry. Otherwise, taxes will be assessed
+    # upon the purchase.
+    # @return [String]
+    attr_accessor :vat_number
+
+    # (Optional) A set of key/value pairs representing custom fields and their
+    # values. Metafields will be created “on-the-fly” in your site for a given
+    # key, if they have not been created yet.
+    # @return [Hash[String, String]]
+    attr_accessor :metafields
+
+    # The parent ID in Chargify if applicable. Parent is another Customer
+    # object.
+    # @return [Integer]
+    attr_accessor :parent_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['email'] = 'email'
+      @_hash['cc_emails'] = 'cc_emails'
+      @_hash['organization'] = 'organization'
+      @_hash['reference'] = 'reference'
+      @_hash['address'] = 'address'
+      @_hash['address_2'] = 'address_2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['phone'] = 'phone'
+      @_hash['verified'] = 'verified'
+      @_hash['tax_exempt'] = 'tax_exempt'
+      @_hash['vat_number'] = 'vat_number'
+      @_hash['metafields'] = 'metafields'
+      @_hash['parent_id'] = 'parent_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        email
+        cc_emails
+        organization
+        reference
+        address
+        address_2
+        city
+        state
+        zip
+        country
+        phone
+        verified
+        tax_exempt
+        vat_number
+        metafields
+        parent_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        address_2
+        parent_id
+      ]
+    end
+
+    def initialize(first_name = SKIP,
+                   last_name = SKIP,
+                   email = SKIP,
+                   cc_emails = SKIP,
+                   organization = SKIP,
+                   reference = SKIP,
+                   address = SKIP,
+                   address_2 = SKIP,
+                   city = SKIP,
+                   state = SKIP,
+                   zip = SKIP,
+                   country = SKIP,
+                   phone = SKIP,
+                   verified = SKIP,
+                   tax_exempt = SKIP,
+                   vat_number = SKIP,
+                   metafields = SKIP,
+                   parent_id = SKIP)
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @email = email unless email == SKIP
+      @cc_emails = cc_emails unless cc_emails == SKIP
+      @organization = organization unless organization == SKIP
+      @reference = reference unless reference == SKIP
+      @address = address unless address == SKIP
+      @address_2 = address_2 unless address_2 == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+      @country = country unless country == SKIP
+      @phone = phone unless phone == SKIP
+      @verified = verified unless verified == SKIP
+      @tax_exempt = tax_exempt unless tax_exempt == SKIP
+      @vat_number = vat_number unless vat_number == SKIP
+      @metafields = metafields unless metafields == SKIP
+      @parent_id = parent_id unless parent_id == 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.
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      cc_emails = hash.key?('cc_emails') ? hash['cc_emails'] : SKIP
+      organization = hash.key?('organization') ? hash['organization'] : SKIP
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      address = hash.key?('address') ? hash['address'] : SKIP
+      address_2 = hash.key?('address_2') ? hash['address_2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      verified = hash.key?('verified') ? hash['verified'] : SKIP
+      tax_exempt = hash.key?('tax_exempt') ? hash['tax_exempt'] : SKIP
+      vat_number = hash.key?('vat_number') ? hash['vat_number'] : SKIP
+      metafields = hash.key?('metafields') ? hash['metafields'] : SKIP
+      parent_id = hash.key?('parent_id') ? hash['parent_id'] : SKIP
+
+      # Create object from extracted values.
+      CustomerAttributes.new(first_name,
+                             last_name,
+                             email,
+                             cc_emails,
+                             organization,
+                             reference,
+                             address,
+                             address_2,
+                             city,
+                             state,
+                             zip,
+                             country,
+                             phone,
+                             verified,
+                             tax_exempt,
+                             vat_number,
+                             metafields,
+                             parent_id)
+    end
+  end
+end

data/lib/advanced_billing/models/customer_change.rb

@@ -0,0 +1,103 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CustomerChange Model.
+  class CustomerChange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CustomerPayerChange]
+    attr_accessor :payer
+
+    # TODO: Write general description for this method
+    # @return [AddressChange]
+    attr_accessor :shipping_address
+
+    # TODO: Write general description for this method
+    # @return [AddressChange]
+    attr_accessor :billing_address
+
+    # TODO: Write general description for this method
+    # @return [CustomerCustomFieldsChange]
+    attr_accessor :custom_fields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payer'] = 'payer'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['custom_fields'] = 'custom_fields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payer
+        shipping_address
+        billing_address
+        custom_fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payer
+        shipping_address
+        billing_address
+        custom_fields
+      ]
+    end
+
+    def initialize(payer = SKIP,
+                   shipping_address = SKIP,
+                   billing_address = SKIP,
+                   custom_fields = SKIP)
+      @payer = payer unless payer == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @custom_fields = custom_fields unless custom_fields == 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.
+      payer = hash.key?('payer') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CustomerChangePayer), hash['payer']
+      ) : SKIP
+      shipping_address = hash.key?('shipping_address') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CustomerChangeShippingAddress), hash['shipping_address']
+      ) : SKIP
+      billing_address = hash.key?('billing_address') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CustomerChangeBillingAddress), hash['billing_address']
+      ) : SKIP
+      custom_fields = hash.key?('custom_fields') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CustomerChangeCustomFields), hash['custom_fields']
+      ) : SKIP
+
+      # Create object from extracted values.
+      CustomerChange.new(payer,
+                         shipping_address,
+                         billing_address,
+                         custom_fields)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomerChange | 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/customer_changes_preview_response.rb

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

data/lib/advanced_billing/models/customer_custom_fields_change.rb

@@ -0,0 +1,97 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CustomerCustomFieldsChange Model.
+  class CustomerCustomFieldsChange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[InvoiceCustomField]]
+    attr_accessor :before
+
+    # TODO: Write general description for this method
+    # @return [Array[InvoiceCustomField]]
+    attr_accessor :after
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['before'] = 'before'
+      @_hash['after'] = 'after'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(before = nil,
+                   after = nil)
+      @before = before
+      @after = after
+    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
+      before = nil
+      unless hash['before'].nil?
+        before = []
+        hash['before'].each do |structure|
+          before << (InvoiceCustomField.from_hash(structure) if structure)
+        end
+      end
+
+      before = nil unless hash.key?('before')
+      # Parameter is an array, so we need to iterate through it
+      after = nil
+      unless hash['after'].nil?
+        after = []
+        hash['after'].each do |structure|
+          after << (InvoiceCustomField.from_hash(structure) if structure)
+        end
+      end
+
+      after = nil unless hash.key?('after')
+
+      # Create object from extracted values.
+      CustomerCustomFieldsChange.new(before,
+                                     after)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomerCustomFieldsChange | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.before,
+                                ->(val) { InvoiceCustomField.validate(val) }) and
+            APIHelper.valid_type?(value.after,
+                                  ->(val) { InvoiceCustomField.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['before'],
+                              ->(val) { InvoiceCustomField.validate(val) }) and
+          APIHelper.valid_type?(value['after'],
+                                ->(val) { InvoiceCustomField.validate(val) })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/customer_error.rb

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

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

data/lib/advanced_billing/models/customer_response.rb

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