subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/metered_component.rb

@@ -0,0 +1,294 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # MeteredComponent Model.
+  class MeteredComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A name for this component that is suitable for showing customers and
+    # displaying on billing statements, ie. "Minutes".
+    # @return [String]
+    attr_accessor :name
+
+    # The name of the unit of measurement for the component. It should be
+    # singular since it will be automatically pluralized when necessary. i.e.
+    # “message”, which may then be shown as “5 messages” on a subscription’s
+    # component line-item
+    # @return [String]
+    attr_accessor :unit_name
+
+    # A description for the component that will be displayed to the user on the
+    # hosted signup page.
+    # @return [String]
+    attr_accessor :description
+
+    # A unique identifier for your use that can be used to retrieve this
+    # component is subsequent requests.  Must start with a letter or number and
+    # may only contain lowercase letters, numbers, or the characters '.', ':',
+    # '-', or '_'.
+    # @return [String]
+    attr_accessor :handle
+
+    # Boolean flag describing whether a component is taxable or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :taxable
+
+    # 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
+
+    # (Not required for ‘per_unit’ pricing schemes) One or more price brackets.
+    # See [Price Bracket
+    # Rules](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677#
+    # price-bracket-rules) for an overview of how price brackets work for
+    # different pricing schemes.
+    # @return [Array[Price]]
+    attr_accessor :prices
+
+    # (Not required for ‘per_unit’ pricing schemes) One or more price brackets.
+    # See [Price Bracket
+    # Rules](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677#
+    # price-bracket-rules) for an overview of how price brackets work for
+    # different pricing schemes.
+    # @return [String]
+    attr_accessor :upgrade_charge
+
+    # (Not required for ‘per_unit’ pricing schemes) One or more price brackets.
+    # See [Price Bracket
+    # Rules](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677#
+    # price-bracket-rules) for an overview of how price brackets work for
+    # different pricing schemes.
+    # @return [String]
+    attr_accessor :downgrade_credit
+
+    # (Not required for ‘per_unit’ pricing schemes) One or more price brackets.
+    # See [Price Bracket
+    # Rules](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405020625677#
+    # price-bracket-rules) for an overview of how price brackets work for
+    # different pricing schemes.
+    # @return [Array[ComponentPricePointItem]]
+    attr_accessor :price_points
+
+    # The amount the customer will be charged per unit when the pricing scheme
+    # is “per_unit”. For On/Off Components, this is the amount that the customer
+    # will be charged when they turn the component on for the subscription. 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
+
+    # 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
+
+    # (Only available on Relationship Invoicing sites) Boolean flag describing
+    # if the service date range should show for the component on generated
+    # invoices.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :hide_date_range_on_invoice
+
+    # deprecated May 2011 - use unit_price instead
+    # @return [String]
+    attr_accessor :price_in_cents
+
+    # deprecated May 2011 - use unit_price instead
+    # @return [TrueClass | FalseClass]
+    attr_accessor :display_on_hosted_page
+
+    # deprecated May 2011 - use unit_price instead
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_fractional_quantities
+
+    # deprecated May 2011 - use unit_price instead
+    # @return [Array[Integer]]
+    attr_accessor :public_signup_page_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['unit_name'] = 'unit_name'
+      @_hash['description'] = 'description'
+      @_hash['handle'] = 'handle'
+      @_hash['taxable'] = 'taxable'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash['upgrade_charge'] = 'upgrade_charge'
+      @_hash['downgrade_credit'] = 'downgrade_credit'
+      @_hash['price_points'] = 'price_points'
+      @_hash['unit_price'] = 'unit_price'
+      @_hash['tax_code'] = 'tax_code'
+      @_hash['hide_date_range_on_invoice'] = 'hide_date_range_on_invoice'
+      @_hash['price_in_cents'] = 'price_in_cents'
+      @_hash['display_on_hosted_page'] = 'display_on_hosted_page'
+      @_hash['allow_fractional_quantities'] = 'allow_fractional_quantities'
+      @_hash['public_signup_page_ids'] = 'public_signup_page_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        handle
+        taxable
+        prices
+        upgrade_charge
+        downgrade_credit
+        price_points
+        unit_price
+        tax_code
+        hide_date_range_on_invoice
+        price_in_cents
+        display_on_hosted_page
+        allow_fractional_quantities
+        public_signup_page_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, unit_name = nil, pricing_scheme = nil,
+                   description = SKIP, handle = SKIP, taxable = SKIP,
+                   prices = SKIP, upgrade_charge = SKIP,
+                   downgrade_credit = SKIP, price_points = SKIP,
+                   unit_price = SKIP, tax_code = SKIP,
+                   hide_date_range_on_invoice = SKIP, price_in_cents = SKIP,
+                   display_on_hosted_page = SKIP,
+                   allow_fractional_quantities = SKIP,
+                   public_signup_page_ids = SKIP)
+      @name = name
+      @unit_name = unit_name
+      @description = description unless description == SKIP
+      @handle = handle unless handle == SKIP
+      @taxable = taxable unless taxable == SKIP
+      @pricing_scheme = pricing_scheme
+      @prices = prices unless prices == SKIP
+      @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
+      @downgrade_credit = downgrade_credit unless downgrade_credit == SKIP
+      @price_points = price_points unless price_points == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @tax_code = tax_code unless tax_code == SKIP
+      unless hide_date_range_on_invoice == SKIP
+        @hide_date_range_on_invoice =
+          hide_date_range_on_invoice
+      end
+      @price_in_cents = price_in_cents unless price_in_cents == SKIP
+      @display_on_hosted_page = display_on_hosted_page unless display_on_hosted_page == SKIP
+      unless allow_fractional_quantities == SKIP
+        @allow_fractional_quantities =
+          allow_fractional_quantities
+      end
+      @public_signup_page_ids = public_signup_page_ids unless public_signup_page_ids == 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'] : nil
+      unit_name = hash.key?('unit_name') ? hash['unit_name'] : nil
+      pricing_scheme = hash.key?('pricing_scheme') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:MeteredComponentPricingScheme), hash['pricing_scheme']
+      ) : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      taxable = hash.key?('taxable') ? hash['taxable'] : 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')
+      upgrade_charge =
+        hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
+      downgrade_credit =
+        hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      price_points = nil
+      unless hash['price_points'].nil?
+        price_points = []
+        hash['price_points'].each do |structure|
+          price_points << (ComponentPricePointItem.from_hash(structure) if structure)
+        end
+      end
+
+      price_points = SKIP unless hash.key?('price_points')
+      unit_price = hash.key?('unit_price') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:MeteredComponentUnitPrice), hash['unit_price']
+      ) : SKIP
+      tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
+      hide_date_range_on_invoice =
+        hash.key?('hide_date_range_on_invoice') ? hash['hide_date_range_on_invoice'] : SKIP
+      price_in_cents =
+        hash.key?('price_in_cents') ? hash['price_in_cents'] : SKIP
+      display_on_hosted_page =
+        hash.key?('display_on_hosted_page') ? hash['display_on_hosted_page'] : SKIP
+      allow_fractional_quantities =
+        hash.key?('allow_fractional_quantities') ? hash['allow_fractional_quantities'] : SKIP
+      public_signup_page_ids =
+        hash.key?('public_signup_page_ids') ? hash['public_signup_page_ids'] : SKIP
+
+      # Create object from extracted values.
+      MeteredComponent.new(name,
+                           unit_name,
+                           pricing_scheme,
+                           description,
+                           handle,
+                           taxable,
+                           prices,
+                           upgrade_charge,
+                           downgrade_credit,
+                           price_points,
+                           unit_price,
+                           tax_code,
+                           hide_date_range_on_invoice,
+                           price_in_cents,
+                           display_on_hosted_page,
+                           allow_fractional_quantities,
+                           public_signup_page_ids)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [MeteredComponent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.name,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.unit_name,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:MeteredComponentPricingScheme)
+                           .validate(value.pricing_scheme)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['name'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['unit_name'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:MeteredComponentPricingScheme)
+                         .validate(value['pricing_scheme'])
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/metered_usage.rb

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

data/lib/advanced_billing/models/movement.rb

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