maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/metadata.rb

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

data/lib/advanced_billing/models/metafield.rb

@@ -0,0 +1,124 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Metafield Model.
+  class Metafield < 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 :name
+
+    # Warning: When updating a metafield's scope attribute, all scope attributes
+    # must be passed. Partially complete scope attributes will override the
+    # existing settings.
+    # @return [MetafieldScope]
+    attr_accessor :scope
+
+    # the amount of subscriptions this metafield has been applied to in Chargify
+    # @return [Integer]
+    attr_accessor :data_count
+
+    # Indicates how data should be added to the metafield. For example, a text
+    # type is just a string, so a given metafield of this type can have any
+    # value attached. On the other hand, dropdown and radio have a set of
+    # allowed values that can be input, and appear differently on a Public
+    # Signup Page. Defaults to 'text'
+    # @return [MetafieldInput]
+    attr_accessor :input_type
+
+    # Indicates how data should be added to the metafield. For example, a text
+    # type is just a string, so a given metafield of this type can have any
+    # value attached. On the other hand, dropdown and radio have a set of
+    # allowed values that can be input, and appear differently on a Public
+    # Signup Page. Defaults to 'text'
+    # @return [Object]
+    attr_accessor :enum
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['scope'] = 'scope'
+      @_hash['data_count'] = 'data_count'
+      @_hash['input_type'] = 'input_type'
+      @_hash['enum'] = 'enum'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        scope
+        data_count
+        input_type
+        enum
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        enum
+      ]
+    end
+
+    def initialize(id = SKIP,
+                   name = SKIP,
+                   scope = SKIP,
+                   data_count = SKIP,
+                   input_type = SKIP,
+                   enum = SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @scope = scope unless scope == SKIP
+      @data_count = data_count unless data_count == SKIP
+      @input_type = input_type unless input_type == SKIP
+      @enum = enum unless enum == 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
+      name = hash.key?('name') ? hash['name'] : SKIP
+      scope = MetafieldScope.from_hash(hash['scope']) if hash['scope']
+      data_count = hash.key?('data_count') ? hash['data_count'] : SKIP
+      input_type = hash.key?('input_type') ? hash['input_type'] : SKIP
+      enum = hash.key?('enum') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:MetafieldEnum), hash['enum']
+      ) : SKIP
+
+      # Create object from extracted values.
+      Metafield.new(id,
+                    name,
+                    scope,
+                    data_count,
+                    input_type,
+                    enum)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Metafield | 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/metafield_input.rb

@@ -0,0 +1,33 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Indicates how data should be added to the metafield. For example, a text
+  # type is just a string, so a given metafield of this type can have any value
+  # attached. On the other hand, dropdown and radio have a set of allowed values
+  # that can be input, and appear differently on a Public Signup Page. Defaults
+  # to 'text'
+  class MetafieldInput
+    METAFIELD_INPUT = [
+      # TODO: Write general description for BALANCE_TRACKER
+      BALANCE_TRACKER = 'balance_tracker'.freeze,
+
+      # TODO: Write general description for TEXT
+      TEXT = 'text'.freeze,
+
+      # TODO: Write general description for RADIO
+      RADIO = 'radio'.freeze,
+
+      # TODO: Write general description for DROPDOWN
+      DROPDOWN = 'dropdown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      METAFIELD_INPUT.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/metafield_scope.rb

@@ -0,0 +1,113 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Warning: When updating a metafield's scope attribute, all scope attributes
+  # must be passed. Partially complete scope attributes will override the
+  # existing settings.
+  class MetafieldScope < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Include (1) or exclude (0) metafields from the csv export.
+    # @return [IncludeOption]
+    attr_accessor :csv
+
+    # Include (1) or exclude (0) metafields from invoices.
+    # @return [IncludeOption]
+    attr_accessor :invoices
+
+    # Include (1) or exclude (0) metafields from statements.
+    # @return [IncludeOption]
+    attr_accessor :statements
+
+    # Include (1) or exclude (0) metafields from the portal.
+    # @return [IncludeOption]
+    attr_accessor :portal
+
+    # Include (1) or exclude (0) metafields from being viewable by your
+    # ecosystem.
+    # @return [IncludeOption]
+    attr_accessor :public_show
+
+    # Include (1) or exclude (0) metafields from being edited by your ecosystem.
+    # @return [IncludeOption]
+    attr_accessor :public_edit
+
+    # Include (1) or exclude (0) metafields from being edited by your ecosystem.
+    # @return [Array[String]]
+    attr_accessor :hosted
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['csv'] = 'csv'
+      @_hash['invoices'] = 'invoices'
+      @_hash['statements'] = 'statements'
+      @_hash['portal'] = 'portal'
+      @_hash['public_show'] = 'public_show'
+      @_hash['public_edit'] = 'public_edit'
+      @_hash['hosted'] = 'hosted'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        csv
+        invoices
+        statements
+        portal
+        public_show
+        public_edit
+        hosted
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(csv = SKIP,
+                   invoices = SKIP,
+                   statements = SKIP,
+                   portal = SKIP,
+                   public_show = SKIP,
+                   public_edit = SKIP,
+                   hosted = SKIP)
+      @csv = csv unless csv == SKIP
+      @invoices = invoices unless invoices == SKIP
+      @statements = statements unless statements == SKIP
+      @portal = portal unless portal == SKIP
+      @public_show = public_show unless public_show == SKIP
+      @public_edit = public_edit unless public_edit == SKIP
+      @hosted = hosted unless hosted == 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.
+      csv = hash.key?('csv') ? hash['csv'] : SKIP
+      invoices = hash.key?('invoices') ? hash['invoices'] : SKIP
+      statements = hash.key?('statements') ? hash['statements'] : SKIP
+      portal = hash.key?('portal') ? hash['portal'] : SKIP
+      public_show = hash.key?('public_show') ? hash['public_show'] : SKIP
+      public_edit = hash.key?('public_edit') ? hash['public_edit'] : SKIP
+      hosted = hash.key?('hosted') ? hash['hosted'] : SKIP
+
+      # Create object from extracted values.
+      MetafieldScope.new(csv,
+                         invoices,
+                         statements,
+                         portal,
+                         public_show,
+                         public_edit,
+                         hosted)
+    end
+  end
+end

data/lib/advanced_billing/models/metered_component.rb

@@ -0,0 +1,323 @@
+# 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
+
+    # 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
+
+    # 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 :downgrade_credit
+
+    # 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 [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
+
+    # The numerical interval. i.e. an interval of ‘30’ coupled with an
+    # interval_unit of day would mean this component's default 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's default price
+    # point, either month or day. This property is only available for sites with
+    # Multifrequency enabled.
+    # @return [IntervalUnit]
+    attr_accessor :interval_unit
+
+    # 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['interval'] = 'interval'
+      @_hash['interval_unit'] = 'interval_unit'
+      @_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
+        interval
+        interval_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        upgrade_charge
+        downgrade_credit
+      ]
+    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,
+                   interval = SKIP,
+                   interval_unit = 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
+      @interval = interval unless interval == SKIP
+      @interval_unit = interval_unit unless interval_unit == 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') ? 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
+      interval = hash.key?('interval') ? hash['interval'] : SKIP
+      interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : 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,
+                           interval,
+                           interval_unit)
+    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
+            APIHelper.valid_type?(value.pricing_scheme,
+                                  ->(val) { PricingScheme.validate(val) })
+        )
+      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
+          APIHelper.valid_type?(value['pricing_scheme'],
+                                ->(val) { PricingScheme.validate(val) })
+      )
+    end
+  end
+end