maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/update_component.rb

@@ -0,0 +1,146 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateComponent Model.
+  class UpdateComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handle
+
+    # The name of the Component, suitable for display on statements. i.e. Text
+    # Messages.
+    # @return [String]
+    attr_accessor :name
+
+    # The description of the component.
+    # @return [String]
+    attr_accessor :description
+
+    # The description of the component.
+    # @return [String]
+    attr_accessor :accounting_code
+
+    # Boolean flag describing whether a component is taxable or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :taxable
+
+    # A string representing the tax code related to the component type. This is
+    # especially important when using the Avalara service to tax based on
+    # locale. This attribute has a max length of 10 characters.
+    # @return [String]
+    attr_accessor :tax_code
+
+    # One of the following: Business Software, Consumer Software, Digital
+    # Services, Physical Goods, Other
+    # @return [ItemCategory]
+    attr_accessor :item_category
+
+    # One of the following: Business Software, Consumer Software, Digital
+    # Services, Physical Goods, Other
+    # @return [TrueClass | FalseClass]
+    attr_accessor :display_on_hosted_page
+
+    # The type of credit to be created when upgrading/downgrading. Defaults to
+    # the component and then site setting if one is not provided.
+    # Available values: `full`, `prorated`, `none`.
+    # @return [CreditType]
+    attr_accessor :upgrade_charge
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['handle'] = 'handle'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['accounting_code'] = 'accounting_code'
+      @_hash['taxable'] = 'taxable'
+      @_hash['tax_code'] = 'tax_code'
+      @_hash['item_category'] = 'item_category'
+      @_hash['display_on_hosted_page'] = 'display_on_hosted_page'
+      @_hash['upgrade_charge'] = 'upgrade_charge'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        handle
+        name
+        description
+        accounting_code
+        taxable
+        tax_code
+        item_category
+        display_on_hosted_page
+        upgrade_charge
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        accounting_code
+        tax_code
+        item_category
+        upgrade_charge
+      ]
+    end
+
+    def initialize(handle = SKIP,
+                   name = SKIP,
+                   description = SKIP,
+                   accounting_code = SKIP,
+                   taxable = SKIP,
+                   tax_code = SKIP,
+                   item_category = SKIP,
+                   display_on_hosted_page = SKIP,
+                   upgrade_charge = SKIP)
+      @handle = handle unless handle == SKIP
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @accounting_code = accounting_code unless accounting_code == SKIP
+      @taxable = taxable unless taxable == SKIP
+      @tax_code = tax_code unless tax_code == SKIP
+      @item_category = item_category unless item_category == SKIP
+      @display_on_hosted_page = display_on_hosted_page unless display_on_hosted_page == SKIP
+      @upgrade_charge = upgrade_charge unless upgrade_charge == 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
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      accounting_code =
+        hash.key?('accounting_code') ? hash['accounting_code'] : SKIP
+      taxable = hash.key?('taxable') ? hash['taxable'] : SKIP
+      tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
+      item_category = hash.key?('item_category') ? hash['item_category'] : SKIP
+      display_on_hosted_page =
+        hash.key?('display_on_hosted_page') ? hash['display_on_hosted_page'] : SKIP
+      upgrade_charge =
+        hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
+
+      # Create object from extracted values.
+      UpdateComponent.new(handle,
+                          name,
+                          description,
+                          accounting_code,
+                          taxable,
+                          tax_code,
+                          item_category,
+                          display_on_hosted_page,
+                          upgrade_charge)
+    end
+  end
+end

data/lib/advanced_billing/models/update_component_price_point.rb

@@ -0,0 +1,141 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateComponentPricePoint Model.
+  class UpdateComponentPricePoint < 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
+
+    # 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
+
+    # Whether to use the site level exchange rate or define your own prices for
+    # each currency if you have multiple currencies defined on the site.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_site_exchange_rate
+
+    # Whether or not the price point includes tax
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_included
+
+    # The numerical interval. i.e. an interval of ‘30’ coupled with an
+    # interval_unit of day would mean this component price point would renew
+    # every 30 days. This property is only available for sites with
+    # Multifrequency enabled.
+    # @return [Integer]
+    attr_accessor :interval
+
+    # A string representing the interval unit for this component price point,
+    # either month or day. This property is only available for sites with
+    # Multifrequency enabled.
+    # @return [IntervalUnit]
+    attr_accessor :interval_unit
+
+    # A string representing the interval unit for this component price point,
+    # either month or day. This property is only available for sites with
+    # Multifrequency enabled.
+    # @return [Array[UpdatePrice]]
+    attr_accessor :prices
+
+    # 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['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash['tax_included'] = 'tax_included'
+      @_hash['interval'] = 'interval'
+      @_hash['interval_unit'] = 'interval_unit'
+      @_hash['prices'] = 'prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        handle
+        pricing_scheme
+        use_site_exchange_rate
+        tax_included
+        interval
+        interval_unit
+        prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP,
+                   handle = SKIP,
+                   pricing_scheme = SKIP,
+                   use_site_exchange_rate = SKIP,
+                   tax_included = SKIP,
+                   interval = SKIP,
+                   interval_unit = SKIP,
+                   prices = SKIP)
+      @name = name unless name == SKIP
+      @handle = handle unless handle == SKIP
+      @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == SKIP
+      @tax_included = tax_included unless tax_included == SKIP
+      @interval = interval unless interval == SKIP
+      @interval_unit = interval_unit unless interval_unit == SKIP
+      @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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : SKIP
+      use_site_exchange_rate =
+        hash.key?('use_site_exchange_rate') ? hash['use_site_exchange_rate'] : SKIP
+      tax_included = hash.key?('tax_included') ? hash['tax_included'] : SKIP
+      interval = hash.key?('interval') ? hash['interval'] : SKIP
+      interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : 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 << (UpdatePrice.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+
+      # Create object from extracted values.
+      UpdateComponentPricePoint.new(name,
+                                    handle,
+                                    pricing_scheme,
+                                    use_site_exchange_rate,
+                                    tax_included,
+                                    interval,
+                                    interval_unit,
+                                    prices)
+    end
+  end
+end

data/lib/advanced_billing/models/update_component_price_point_request.rb

@@ -0,0 +1,51 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateComponentPricePointRequest Model.
+  class UpdateComponentPricePointRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UpdateComponentPricePoint]
+    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
+      %w[
+        price_point
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price_point = SKIP)
+      @price_point = price_point unless price_point == 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.
+      price_point = UpdateComponentPricePoint.from_hash(hash['price_point']) if
+        hash['price_point']
+
+      # Create object from extracted values.
+      UpdateComponentPricePointRequest.new(price_point)
+    end
+  end
+end

data/lib/advanced_billing/models/update_component_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateComponentRequest Model.
+  class UpdateComponentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UpdateComponent]
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(component = nil)
+      @component = component
+    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 = UpdateComponent.from_hash(hash['component']) if hash['component']
+
+      # Create object from extracted values.
+      UpdateComponentRequest.new(component)
+    end
+  end
+end

data/lib/advanced_billing/models/update_coupon_currency.rb

@@ -0,0 +1,57 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateCouponCurrency Model.
+  class UpdateCouponCurrency < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO code for the site defined currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # Price for the given currency.
+    # @return [Integer]
+    attr_accessor :price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['price'] = 'price'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency = nil,
+                   price = nil)
+      @currency = currency
+      @price = price
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      price = hash.key?('price') ? hash['price'] : nil
+
+      # Create object from extracted values.
+      UpdateCouponCurrency.new(currency,
+                               price)
+    end
+  end
+end

data/lib/advanced_billing/models/update_currency_price.rb

@@ -0,0 +1,57 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateCurrencyPrice Model.
+  class UpdateCurrencyPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the currency price record being updated
+    # @return [Integer]
+    attr_accessor :id
+
+    # New price for the given currency
+    # @return [Integer]
+    attr_accessor :price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['price'] = 'price'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   price = nil)
+      @id = id
+      @price = price
+    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'] : nil
+      price = hash.key?('price') ? hash['price'] : nil
+
+      # Create object from extracted values.
+      UpdateCurrencyPrice.new(id,
+                              price)
+    end
+  end
+end

data/lib/advanced_billing/models/update_currency_prices_request.rb

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