maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/proration.rb

@@ -0,0 +1,52 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Proration Model.
+  class Proration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The alternative to sending preserve_period as a direct attribute to
+    # migration
+    # @return [TrueClass | FalseClass]
+    attr_accessor :preserve_period
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['preserve_period'] = 'preserve_period'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        preserve_period
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(preserve_period = SKIP)
+      @preserve_period = preserve_period unless preserve_period == 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.
+      preserve_period =
+        hash.key?('preserve_period') ? hash['preserve_period'] : SKIP
+
+      # Create object from extracted values.
+      Proration.new(preserve_period)
+    end
+  end
+end

data/lib/advanced_billing/models/public_key.rb

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

data/lib/advanced_billing/models/public_signup_page.rb

@@ -0,0 +1,84 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PublicSignupPage Model.
+  class PublicSignupPage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The id of the signup page (public_signup_pages only)
+    # @return [Integer]
+    attr_accessor :id
+
+    # The url to which a customer will be returned after a successful signup
+    # (public_signup_pages only)
+    # @return [String]
+    attr_accessor :return_url
+
+    # The params to be appended to the return_url (public_signup_pages only)
+    # @return [String]
+    attr_accessor :return_params
+
+    # The url where the signup page can be viewed (public_signup_pages only)
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['return_url'] = 'return_url'
+      @_hash['return_params'] = 'return_params'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        return_url
+        return_params
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        return_url
+        return_params
+      ]
+    end
+
+    def initialize(id = SKIP,
+                   return_url = SKIP,
+                   return_params = SKIP,
+                   url = SKIP)
+      @id = id unless id == SKIP
+      @return_url = return_url unless return_url == SKIP
+      @return_params = return_params unless return_params == SKIP
+      @url = url unless url == 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
+      return_url = hash.key?('return_url') ? hash['return_url'] : SKIP
+      return_params = hash.key?('return_params') ? hash['return_params'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create object from extracted values.
+      PublicSignupPage.new(id,
+                           return_url,
+                           return_params,
+                           url)
+    end
+  end
+end

data/lib/advanced_billing/models/quantity_based_component.rb

@@ -0,0 +1,333 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # QuantityBasedComponent Model.
+  class QuantityBasedComponent < 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://chargify.zendesk.com/hc/en-us/articles/4407755865883#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 :recurring
+
+    # 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['recurring'] = 'recurring'
+      @_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
+        recurring
+        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,
+                   recurring = 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
+      @recurring = recurring unless recurring == 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(:QuantityBasedComponentUnitPrice), 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
+      recurring = hash.key?('recurring') ? hash['recurring'] : 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.
+      QuantityBasedComponent.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,
+                                 recurring,
+                                 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 [QuantityBasedComponent | 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

data/lib/advanced_billing/models/reactivate_subscription_group_request.rb

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