maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/component_allocation_error_item.rb

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

data/lib/advanced_billing/models/component_cost_data.rb

@@ -0,0 +1,128 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ComponentCostData Model.
+  class ComponentCostData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :component_code_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :price_point_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :quantity
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount
+
+    # 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[ComponentCostDataRateTier]]
+    attr_accessor :tiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component_code_id'] = 'component_code_id'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['product_id'] = 'product_id'
+      @_hash['quantity'] = 'quantity'
+      @_hash['amount'] = 'amount'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['tiers'] = 'tiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_code_id
+        price_point_id
+        product_id
+        quantity
+        amount
+        pricing_scheme
+        tiers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        component_code_id
+      ]
+    end
+
+    def initialize(component_code_id = SKIP,
+                   price_point_id = SKIP,
+                   product_id = SKIP,
+                   quantity = SKIP,
+                   amount = SKIP,
+                   pricing_scheme = SKIP,
+                   tiers = SKIP)
+      @component_code_id = component_code_id unless component_code_id == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @amount = amount unless amount == SKIP
+      @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
+      @tiers = tiers unless tiers == 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_code_id =
+        hash.key?('component_code_id') ? hash['component_code_id'] : SKIP
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tiers = nil
+      unless hash['tiers'].nil?
+        tiers = []
+        hash['tiers'].each do |structure|
+          tiers << (ComponentCostDataRateTier.from_hash(structure) if structure)
+        end
+      end
+
+      tiers = SKIP unless hash.key?('tiers')
+
+      # Create object from extracted values.
+      ComponentCostData.new(component_code_id,
+                            price_point_id,
+                            product_id,
+                            quantity,
+                            amount,
+                            pricing_scheme,
+                            tiers)
+    end
+  end
+end

data/lib/advanced_billing/models/component_cost_data_rate_tier.rb

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

data/lib/advanced_billing/models/component_currency_price.rb

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

data/lib/advanced_billing/models/component_currency_prices_response.rb

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

data/lib/advanced_billing/models/component_custom_price.rb

@@ -0,0 +1,96 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Create or update custom pricing unique to the subscription. Used in place of
+  # `price_point_id`.
+  class ComponentCustomPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Omit for On/Off components
+    # @return [PricingScheme]
+    attr_accessor :pricing_scheme
+
+    # 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
+
+    # On/off components only need one price bracket starting at 1
+    # @return [Array[Price]]
+    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['interval'] = 'interval'
+      @_hash['interval_unit'] = 'interval_unit'
+      @_hash['prices'] = 'prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pricing_scheme
+        interval
+        interval_unit
+        prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_scheme = SKIP,
+                   interval = SKIP,
+                   interval_unit = SKIP,
+                   prices = SKIP)
+      @pricing_scheme = pricing_scheme unless pricing_scheme == 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.
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : 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 << (Price.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+
+      # Create object from extracted values.
+      ComponentCustomPrice.new(pricing_scheme,
+                               interval,
+                               interval_unit,
+                               prices)
+    end
+  end
+end

data/lib/advanced_billing/models/component_kind.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # A handle for the component type
+  class ComponentKind
+    COMPONENT_KIND = [
+      # TODO: Write general description for METERED_COMPONENT
+      METERED_COMPONENT = 'metered_component'.freeze,
+
+      # TODO: Write general description for QUANTITY_BASED_COMPONENT
+      QUANTITY_BASED_COMPONENT = 'quantity_based_component'.freeze,
+
+      # TODO: Write general description for ON_OFF_COMPONENT
+      ON_OFF_COMPONENT = 'on_off_component'.freeze,
+
+      # TODO: Write general description for PREPAID_USAGE_COMPONENT
+      PREPAID_USAGE_COMPONENT = 'prepaid_usage_component'.freeze,
+
+      # TODO: Write general description for EVENT_BASED_COMPONENT
+      EVENT_BASED_COMPONENT = 'event_based_component'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      COMPONENT_KIND.include?(value)
+    end
+  end
+end