maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/offer_signup_page.rb

@@ -0,0 +1,100 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OfferSignupPage Model.
+  class OfferSignupPage < 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 :nickname
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enabled
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :return_url
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :return_params
+
+    # TODO: Write general description for this method
+    # @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['nickname'] = 'nickname'
+      @_hash['enabled'] = 'enabled'
+      @_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
+        nickname
+        enabled
+        return_url
+        return_params
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   nickname = SKIP,
+                   enabled = SKIP,
+                   return_url = SKIP,
+                   return_params = SKIP,
+                   url = SKIP)
+      @id = id unless id == SKIP
+      @nickname = nickname unless nickname == SKIP
+      @enabled = enabled unless enabled == 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
+      nickname = hash.key?('nickname') ? hash['nickname'] : SKIP
+      enabled = hash.key?('enabled') ? hash['enabled'] : 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.
+      OfferSignupPage.new(id,
+                          nickname,
+                          enabled,
+                          return_url,
+                          return_params,
+                          url)
+    end
+  end
+end

data/lib/advanced_billing/models/on_off_component.rb

@@ -0,0 +1,287 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OnOffComponent Model.
+  class OnOffComponent < 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
+
+    # 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
+
+    # (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 :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['description'] = 'description'
+      @_hash['handle'] = 'handle'
+      @_hash['taxable'] = 'taxable'
+      @_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,
+                   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
+      @description = description unless description == SKIP
+      @handle = handle unless handle == SKIP
+      @taxable = taxable unless taxable == SKIP
+      @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
+      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(:OnOffComponentUnitPrice), 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.
+      OnOffComponent.new(name,
+                         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 [OnOffComponent | 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 })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['name'],
+                            ->(val) { val.instance_of? String })
+    end
+  end
+end

data/lib/advanced_billing/models/organization_address.rb

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

data/lib/advanced_billing/models/origin_invoice.rb

@@ -0,0 +1,60 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OriginInvoice Model.
+  class OriginInvoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The UID of the invoice serving as an origin invoice.
+    # @return [String]
+    attr_accessor :uid
+
+    # The number of the invoice serving as an origin invoice.
+    # @return [String]
+    attr_accessor :number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['number'] = 'number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP,
+                   number = SKIP)
+      @uid = uid unless uid == SKIP
+      @number = number unless number == 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.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+
+      # Create object from extracted values.
+      OriginInvoice.new(uid,
+                        number)
+    end
+  end
+end

data/lib/advanced_billing/models/overage_pricing.rb

@@ -0,0 +1,73 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OveragePricing Model.
+  class OveragePricing < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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[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[
+        prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_scheme = nil,
+                   prices = SKIP)
+      @pricing_scheme = pricing_scheme
+      @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'] : nil
+      # 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.
+      OveragePricing.new(pricing_scheme,
+                         prices)
+    end
+  end
+end