maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/update_payment_profile.rb

@@ -0,0 +1,194 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdatePaymentProfile Model.
+  class UpdatePaymentProfile < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first name of the card holder.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The last name of the card holder.
+    # @return [String]
+    attr_accessor :last_name
+
+    # The full credit card number
+    # @return [String]
+    attr_accessor :full_number
+
+    # The type of card used.
+    # @return [CardType]
+    attr_accessor :card_type
+
+    # (Optional when performing an Import via vault_token, required otherwise)
+    # The 1- or 2-digit credit card expiration month, as an integer or string,
+    # i.e. 5
+    # @return [String]
+    attr_accessor :expiration_month
+
+    # (Optional when performing a Import via vault_token, required otherwise)
+    # The 4-digit credit card expiration year, as an integer or string, i.e.
+    # 2012
+    # @return [String]
+    attr_accessor :expiration_year
+
+    # The vault that stores the payment profile with the provided `vault_token`.
+    # Use `bogus` for testing.
+    # @return [CurrentVault]
+    attr_accessor :current_vault
+
+    # The credit card or bank account billing street address (i.e. 123 Main
+    # St.). This value is merely passed through to the payment gateway.
+    # @return [String]
+    attr_accessor :billing_address
+
+    # The credit card or bank account billing address city (i.e. “Boston”). This
+    # value is merely passed through to the payment gateway.
+    # @return [String]
+    attr_accessor :billing_city
+
+    # The credit card or bank account billing address state (i.e. MA). This
+    # value is merely passed through to the payment gateway. 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 :billing_state
+
+    # The credit card or bank account billing address zip code (i.e. 12345).
+    # This value is merely passed through to the payment gateway.
+    # @return [String]
+    attr_accessor :billing_zip
+
+    # The credit card or bank account billing address country, required in
+    # [ISO_3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+    # format (i.e. “US”). This value is merely passed through to the payment
+    # gateway. Some gateways require country codes in a specific format. Please
+    # check your gateway’s documentation. If creating an ACH subscription, only
+    # US is supported at this time.
+    # @return [String]
+    attr_accessor :billing_country
+
+    # Second line of the customer’s billing address i.e. Apt. 100
+    # @return [String]
+    attr_accessor :billing_address_2
+
+    # 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['full_number'] = 'full_number'
+      @_hash['card_type'] = 'card_type'
+      @_hash['expiration_month'] = 'expiration_month'
+      @_hash['expiration_year'] = 'expiration_year'
+      @_hash['current_vault'] = 'current_vault'
+      @_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['billing_address_2'] = 'billing_address_2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        full_number
+        card_type
+        expiration_month
+        expiration_year
+        current_vault
+        billing_address
+        billing_city
+        billing_state
+        billing_zip
+        billing_country
+        billing_address_2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        billing_address_2
+      ]
+    end
+
+    def initialize(first_name = SKIP,
+                   last_name = SKIP,
+                   full_number = SKIP,
+                   card_type = SKIP,
+                   expiration_month = SKIP,
+                   expiration_year = SKIP,
+                   current_vault = SKIP,
+                   billing_address = SKIP,
+                   billing_city = SKIP,
+                   billing_state = SKIP,
+                   billing_zip = SKIP,
+                   billing_country = SKIP,
+                   billing_address_2 = SKIP)
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @full_number = full_number unless full_number == SKIP
+      @card_type = card_type unless card_type == SKIP
+      @expiration_month = expiration_month unless expiration_month == SKIP
+      @expiration_year = expiration_year unless expiration_year == SKIP
+      @current_vault = current_vault unless current_vault == 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
+      @billing_address_2 = billing_address_2 unless billing_address_2 == 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
+      full_number = hash.key?('full_number') ? hash['full_number'] : SKIP
+      card_type = hash.key?('card_type') ? hash['card_type'] : SKIP
+      expiration_month =
+        hash.key?('expiration_month') ? hash['expiration_month'] : SKIP
+      expiration_year =
+        hash.key?('expiration_year') ? hash['expiration_year'] : SKIP
+      current_vault = hash.key?('current_vault') ? hash['current_vault'] : 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
+      billing_address_2 =
+        hash.key?('billing_address_2') ? hash['billing_address_2'] : SKIP
+
+      # Create object from extracted values.
+      UpdatePaymentProfile.new(first_name,
+                               last_name,
+                               full_number,
+                               card_type,
+                               expiration_month,
+                               expiration_year,
+                               current_vault,
+                               billing_address,
+                               billing_city,
+                               billing_state,
+                               billing_zip,
+                               billing_country,
+                               billing_address_2)
+    end
+  end
+end

data/lib/advanced_billing/models/update_payment_profile_request.rb

@@ -0,0 +1,49 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdatePaymentProfileRequest Model.
+  class UpdatePaymentProfileRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UpdatePaymentProfile]
+    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 = UpdatePaymentProfile.from_hash(hash['payment_profile']) if
+        hash['payment_profile']
+
+      # Create object from extracted values.
+      UpdatePaymentProfileRequest.new(payment_profile)
+    end
+  end
+end

data/lib/advanced_billing/models/update_price.rb

@@ -0,0 +1,109 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdatePrice Model.
+  class UpdatePrice < 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 [Object]
+    attr_accessor :ending_quantity
+
+    # The price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or
+    # 0.00000065
+    # @return [Object]
+    attr_accessor :unit_price
+
+    # The price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or
+    # 0.00000065
+    # @return [TrueClass | FalseClass]
+    attr_accessor :destroy
+
+    # The price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or
+    # 0.00000065
+    # @return [Object]
+    attr_accessor :starting_quantity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['ending_quantity'] = 'ending_quantity'
+      @_hash['unit_price'] = 'unit_price'
+      @_hash['destroy'] = '_destroy'
+      @_hash['starting_quantity'] = 'starting_quantity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        ending_quantity
+        unit_price
+        destroy
+        starting_quantity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   ending_quantity = SKIP,
+                   unit_price = SKIP,
+                   destroy = SKIP,
+                   starting_quantity = SKIP)
+      @id = id unless id == SKIP
+      @ending_quantity = ending_quantity unless ending_quantity == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @destroy = destroy unless destroy == SKIP
+      @starting_quantity = starting_quantity unless starting_quantity == 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
+      ending_quantity = hash.key?('ending_quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:UpdatePriceEndingQuantity), hash['ending_quantity']
+      ) : SKIP
+      unit_price = hash.key?('unit_price') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:UpdatePriceUnitPrice), hash['unit_price']
+      ) : SKIP
+      destroy = hash.key?('_destroy') ? hash['_destroy'] : SKIP
+      starting_quantity = hash.key?('starting_quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:UpdatePriceStartingQuantity), hash['starting_quantity']
+      ) : SKIP
+
+      # Create object from extracted values.
+      UpdatePrice.new(id,
+                      ending_quantity,
+                      unit_price,
+                      destroy,
+                      starting_quantity)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [UpdatePrice | 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/update_product_price_point.rb

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

data/lib/advanced_billing/models/update_product_price_point_request.rb

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

data/lib/advanced_billing/models/update_reason_code.rb

@@ -0,0 +1,70 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateReasonCode Model.
+  class UpdateReasonCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the ReasonCode
+    # @return [String]
+    attr_accessor :code
+
+    # The friendly summary of what the code signifies
+    # @return [String]
+    attr_accessor :description
+
+    # The order that code appears in lists
+    # @return [Integer]
+    attr_accessor :position
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['description'] = 'description'
+      @_hash['position'] = 'position'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        description
+        position
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP,
+                   description = SKIP,
+                   position = SKIP)
+      @code = code unless code == SKIP
+      @description = description unless description == SKIP
+      @position = position unless position == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      position = hash.key?('position') ? hash['position'] : SKIP
+
+      # Create object from extracted values.
+      UpdateReasonCode.new(code,
+                           description,
+                           position)
+    end
+  end
+end

data/lib/advanced_billing/models/update_reason_code_request.rb

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

data/lib/advanced_billing/models/update_segment.rb

@@ -0,0 +1,73 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateSegment Model.
+  class UpdateSegment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [PricingScheme]
+    attr_accessor :pricing_scheme
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Array[CreateOrUpdateSegmentPrice]]
+    attr_accessor :prices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_scheme = nil,
+                   prices = SKIP)
+      @pricing_scheme = pricing_scheme
+      @prices = prices unless prices == 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.
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : nil
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (CreateOrUpdateSegmentPrice.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+
+      # Create object from extracted values.
+      UpdateSegment.new(pricing_scheme,
+                        prices)
+    end
+  end
+end

data/lib/advanced_billing/models/update_segment_request.rb

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