subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/component_cost_data.rb

@@ -0,0 +1,135 @@
+# 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') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:ComponentCostDataPricingScheme), 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
+
+    # Validates an instance of the object from a given value.
+    # @param [ComponentCostData | 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/component_cost_data_rate_tier.rb

@@ -0,0 +1,101 @@
+# 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
+
+    # Validates an instance of the object from a given value.
+    # @param [ComponentCostDataRateTier | 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/component_custom_price.rb

@@ -0,0 +1,81 @@
+# 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
+
+    # 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['prices'] = 'prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pricing_scheme
+        prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_scheme = SKIP, prices = SKIP)
+      @pricing_scheme = pricing_scheme unless pricing_scheme == 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') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:ComponentCustomPricePricingScheme), hash['pricing_scheme']
+      ) : 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,
+                               prices)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ComponentCustomPrice | 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/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

data/lib/advanced_billing/models/component_kind_path.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Component Kind Path.
+  class ComponentKindPath
+    COMPONENT_KIND_PATH = [
+      # TODO: Write general description for METERED_COMPONENTS
+      METERED_COMPONENTS = 'metered_components'.freeze,
+
+      # TODO: Write general description for QUANTITY_BASED_COMPONENTS
+      QUANTITY_BASED_COMPONENTS = 'quantity_based_components'.freeze,
+
+      # TODO: Write general description for ON_OFF_COMPONENTS
+      ON_OFF_COMPONENTS = 'on_off_components'.freeze,
+
+      # TODO: Write general description for PREPAID_USAGE_COMPONENTS
+      PREPAID_USAGE_COMPONENTS = 'prepaid_usage_components'.freeze,
+
+      # TODO: Write general description for EVENT_BASED_COMPONENTS
+      EVENT_BASED_COMPONENTS = 'event_based_components'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      COMPONENT_KIND_PATH.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/component_price.rb

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

data/lib/advanced_billing/models/component_price_point.rb

@@ -0,0 +1,192 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ComponentPricePoint Model.
+  class ComponentPricePoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # Price point type. We expose the following types:
+    # 1. **default**: a price point that is marked as a default price for a
+    # certain product.
+    # 2. **custom**: a custom price point.
+    # 3. **catalog**: a price point that is **not** marked as a default price
+    # for a certain product and is **not** a custom one.
+    # @return [PricePointType]
+    attr_accessor :type
+
+    # Note: Refer to type attribute instead
+    # @return [TrueClass | FalseClass]
+    attr_accessor :default
+
+    # Note: Refer to type attribute instead
+    # @return [String]
+    attr_accessor :name
+
+    # Note: Refer to type attribute instead
+    # @return [String]
+    attr_accessor :pricing_scheme
+
+    # Note: Refer to type attribute instead
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # Note: Refer to type attribute instead
+    # @return [String]
+    attr_accessor :handle
+
+    # Note: Refer to type attribute instead
+    # @return [String]
+    attr_accessor :archived_at
+
+    # Note: Refer to type attribute instead
+    # @return [String]
+    attr_accessor :created_at
+
+    # Note: Refer to type attribute instead
+    # @return [String]
+    attr_accessor :updated_at
+
+    # Note: Refer to type attribute instead
+    # @return [Array[ComponentPricePointPrice]]
+    attr_accessor :prices
+
+    # 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
+
+    # (only used for Custom Pricing - ie. when the price point's type is
+    # `custom`) The id of the subscription that the custom price point is for.
+    # @return [Integer]
+    attr_accessor :subscription_id
+
+    # (only used for Custom Pricing - ie. when the price point's type is
+    # `custom`) The id of the subscription that the custom price point is for.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_included
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash['default'] = 'default'
+      @_hash['name'] = 'name'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['component_id'] = 'component_id'
+      @_hash['handle'] = 'handle'
+      @_hash['archived_at'] = 'archived_at'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['prices'] = 'prices'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['tax_included'] = 'tax_included'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        type
+        default
+        name
+        pricing_scheme
+        component_id
+        handle
+        archived_at
+        created_at
+        updated_at
+        prices
+        use_site_exchange_rate
+        subscription_id
+        tax_included
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        archived_at
+      ]
+    end
+
+    def initialize(id = SKIP, type = SKIP, default = SKIP, name = SKIP,
+                   pricing_scheme = SKIP, component_id = SKIP, handle = SKIP,
+                   archived_at = SKIP, created_at = SKIP, updated_at = SKIP,
+                   prices = SKIP, use_site_exchange_rate = true,
+                   subscription_id = SKIP, tax_included = SKIP)
+      @id = id unless id == SKIP
+      @type = type unless type == SKIP
+      @default = default unless default == SKIP
+      @name = name unless name == SKIP
+      @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @handle = handle unless handle == SKIP
+      @archived_at = archived_at unless archived_at == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @prices = prices unless prices == SKIP
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == SKIP
+      @subscription_id = subscription_id unless subscription_id == SKIP
+      @tax_included = tax_included unless tax_included == 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
+      type = hash.key?('type') ? hash['type'] : SKIP
+      default = hash.key?('default') ? hash['default'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : SKIP
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      archived_at = hash.key?('archived_at') ? hash['archived_at'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : 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 << (ComponentPricePointPrice.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+      use_site_exchange_rate = hash['use_site_exchange_rate'] ||= true
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
+      tax_included = hash.key?('tax_included') ? hash['tax_included'] : SKIP
+
+      # Create object from extracted values.
+      ComponentPricePoint.new(id,
+                              type,
+                              default,
+                              name,
+                              pricing_scheme,
+                              component_id,
+                              handle,
+                              archived_at,
+                              created_at,
+                              updated_at,
+                              prices,
+                              use_site_exchange_rate,
+                              subscription_id,
+                              tax_included)
+    end
+  end
+end