maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/prepayment_method.rb

@@ -0,0 +1,41 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # :- When the `method` specified is `"credit_card_on_file"`, the prepayment
+  # amount will be collected using the default credit card payment profile and
+  # applied to the prepayment account balance. This is especially useful for
+  # manual replenishment of prepaid subscriptions.
+  class PrepaymentMethod
+    PREPAYMENT_METHOD = [
+      # TODO: Write general description for CHECK
+      CHECK = 'check'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze,
+
+      # TODO: Write general description for MONEY_ORDER
+      MONEY_ORDER = 'money_order'.freeze,
+
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze,
+
+      # TODO: Write general description for PAYPAL_ACCOUNT
+      PAYPAL_ACCOUNT = 'paypal_account'.freeze,
+
+      # TODO: Write general description for CREDIT_CARD_ON_FILE
+      CREDIT_CARD_ON_FILE = 'credit_card_on_file'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PREPAYMENT_METHOD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/prepayment_response.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PrepaymentResponse Model.
+  class PrepaymentResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Prepayment]
+    attr_accessor :prepayment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prepayment'] = 'prepayment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(prepayment = nil)
+      @prepayment = prepayment
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      prepayment = Prepayment.from_hash(hash['prepayment']) if hash['prepayment']
+
+      # Create object from extracted values.
+      PrepaymentResponse.new(prepayment)
+    end
+  end
+end

data/lib/advanced_billing/models/prepayments_response.rb

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

data/lib/advanced_billing/models/preview_allocations_request.rb

@@ -0,0 +1,99 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PreviewAllocationsRequest Model.
+  class PreviewAllocationsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateAllocation]]
+    attr_accessor :allocations
+
+    # To calculate proration amounts for a future time. Only within a current
+    # subscription period. Only ISO8601 format is supported.
+    # @return [Date]
+    attr_accessor :effective_proration_date
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['allocations'] = 'allocations'
+      @_hash['effective_proration_date'] = 'effective_proration_date'
+      @_hash['upgrade_charge'] = 'upgrade_charge'
+      @_hash['downgrade_credit'] = 'downgrade_credit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        effective_proration_date
+        upgrade_charge
+        downgrade_credit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        upgrade_charge
+        downgrade_credit
+      ]
+    end
+
+    def initialize(allocations = nil,
+                   effective_proration_date = SKIP,
+                   upgrade_charge = SKIP,
+                   downgrade_credit = SKIP)
+      @allocations = allocations
+      @effective_proration_date = effective_proration_date unless effective_proration_date == SKIP
+      @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
+      @downgrade_credit = downgrade_credit unless downgrade_credit == 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.
+      # Parameter is an array, so we need to iterate through it
+      allocations = nil
+      unless hash['allocations'].nil?
+        allocations = []
+        hash['allocations'].each do |structure|
+          allocations << (CreateAllocation.from_hash(structure) if structure)
+        end
+      end
+
+      allocations = nil unless hash.key?('allocations')
+      effective_proration_date =
+        hash.key?('effective_proration_date') ? hash['effective_proration_date'] : SKIP
+      upgrade_charge =
+        hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
+      downgrade_credit =
+        hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
+
+      # Create object from extracted values.
+      PreviewAllocationsRequest.new(allocations,
+                                    effective_proration_date,
+                                    upgrade_charge,
+                                    downgrade_credit)
+    end
+  end
+end

data/lib/advanced_billing/models/price.rb

@@ -0,0 +1,99 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Price Model.
+  class Price < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :starting_quantity
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :ending_quantity
+
+    # 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 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['unit_price'] = 'unit_price'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ending_quantity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        ending_quantity
+      ]
+    end
+
+    def initialize(starting_quantity = nil,
+                   unit_price = nil,
+                   ending_quantity = SKIP)
+      @starting_quantity = starting_quantity
+      @ending_quantity = ending_quantity unless ending_quantity == SKIP
+      @unit_price = unit_price
+    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') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PriceStartingQuantity), hash['starting_quantity']
+      ) : nil
+      unit_price = hash.key?('unit_price') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PriceUnitPrice), hash['unit_price']
+      ) : nil
+      ending_quantity = hash.key?('ending_quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PriceEndingQuantity), hash['ending_quantity']
+      ) : SKIP
+
+      # Create object from extracted values.
+      Price.new(starting_quantity,
+                unit_price,
+                ending_quantity)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Price | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:PriceStartingQuantity)
+                         .validate(value.starting_quantity) and
+            UnionTypeLookUp.get(:PriceUnitPrice)
+                           .validate(value.unit_price)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:PriceStartingQuantity)
+                       .validate(value['starting_quantity']) and
+          UnionTypeLookUp.get(:PriceUnitPrice)
+                         .validate(value['unit_price'])
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/price_point.rb

@@ -0,0 +1,206 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # PricePoint Model.
+  class PricePoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handle
+
+    # 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
+
+    # 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
+
+    # Whether or not the price point includes tax
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_included
+
+    # The numerical interval. i.e. an interval of ‘30’ coupled with an
+    # interval_unit of day would mean this 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 price point, either month
+    # or day. This property is only available for sites with Multifrequency
+    # enabled.
+    # @return [IntervalUnit]
+    attr_accessor :interval_unit
+
+    # A string representing the interval unit for this price point, either month
+    # or day. This property is only available for sites with Multifrequency
+    # enabled.
+    # @return [OveragePricing]
+    attr_accessor :overage_pricing
+
+    # Boolean which controls whether or not remaining units should be rolled
+    # over to the next period
+    # @return [TrueClass | FalseClass]
+    attr_accessor :rollover_prepaid_remainder
+
+    # Boolean which controls whether or not the allocated quantity should be
+    # renewed at the beginning of each period
+    # @return [TrueClass | FalseClass]
+    attr_accessor :renew_prepaid_allocation
+
+    # (only for prepaid usage components where rollover_prepaid_remainder is
+    # true) The number of `expiration_interval_unit`s after which rollover
+    # amounts should expire
+    # @return [Float]
+    attr_accessor :expiration_interval
+
+    # (only for prepaid usage components where rollover_prepaid_remainder is
+    # true) The number of `expiration_interval_unit`s after which rollover
+    # amounts should expire
+    # @return [IntervalUnit]
+    attr_accessor :expiration_interval_unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash['tax_included'] = 'tax_included'
+      @_hash['interval'] = 'interval'
+      @_hash['interval_unit'] = 'interval_unit'
+      @_hash['overage_pricing'] = 'overage_pricing'
+      @_hash['rollover_prepaid_remainder'] = 'rollover_prepaid_remainder'
+      @_hash['renew_prepaid_allocation'] = 'renew_prepaid_allocation'
+      @_hash['expiration_interval'] = 'expiration_interval'
+      @_hash['expiration_interval_unit'] = 'expiration_interval_unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        handle
+        pricing_scheme
+        prices
+        use_site_exchange_rate
+        tax_included
+        interval
+        interval_unit
+        overage_pricing
+        rollover_prepaid_remainder
+        renew_prepaid_allocation
+        expiration_interval
+        expiration_interval_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP,
+                   handle = SKIP,
+                   pricing_scheme = SKIP,
+                   prices = SKIP,
+                   use_site_exchange_rate = true,
+                   tax_included = SKIP,
+                   interval = SKIP,
+                   interval_unit = SKIP,
+                   overage_pricing = SKIP,
+                   rollover_prepaid_remainder = SKIP,
+                   renew_prepaid_allocation = SKIP,
+                   expiration_interval = SKIP,
+                   expiration_interval_unit = SKIP)
+      @name = name unless name == SKIP
+      @handle = handle unless handle == SKIP
+      @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
+      @prices = prices unless prices == SKIP
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == SKIP
+      @tax_included = tax_included unless tax_included == SKIP
+      @interval = interval unless interval == SKIP
+      @interval_unit = interval_unit unless interval_unit == SKIP
+      @overage_pricing = overage_pricing unless overage_pricing == SKIP
+      unless rollover_prepaid_remainder == SKIP
+        @rollover_prepaid_remainder =
+          rollover_prepaid_remainder
+      end
+      @renew_prepaid_allocation = renew_prepaid_allocation unless renew_prepaid_allocation == SKIP
+      @expiration_interval = expiration_interval unless expiration_interval == SKIP
+      @expiration_interval_unit = expiration_interval_unit unless expiration_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'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? 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')
+      use_site_exchange_rate = hash['use_site_exchange_rate'] ||= true
+      tax_included = hash.key?('tax_included') ? hash['tax_included'] : SKIP
+      interval = hash.key?('interval') ? hash['interval'] : SKIP
+      interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : SKIP
+      overage_pricing = OveragePricing.from_hash(hash['overage_pricing']) if
+        hash['overage_pricing']
+      rollover_prepaid_remainder =
+        hash.key?('rollover_prepaid_remainder') ? hash['rollover_prepaid_remainder'] : SKIP
+      renew_prepaid_allocation =
+        hash.key?('renew_prepaid_allocation') ? hash['renew_prepaid_allocation'] : SKIP
+      expiration_interval =
+        hash.key?('expiration_interval') ? hash['expiration_interval'] : SKIP
+      expiration_interval_unit =
+        hash.key?('expiration_interval_unit') ? hash['expiration_interval_unit'] : SKIP
+
+      # Create object from extracted values.
+      PricePoint.new(name,
+                     handle,
+                     pricing_scheme,
+                     prices,
+                     use_site_exchange_rate,
+                     tax_included,
+                     interval,
+                     interval_unit,
+                     overage_pricing,
+                     rollover_prepaid_remainder,
+                     renew_prepaid_allocation,
+                     expiration_interval,
+                     expiration_interval_unit)
+    end
+  end
+end

data/lib/advanced_billing/models/price_point_type.rb

@@ -0,0 +1,30 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # 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.
+  class PricePointType
+    PRICE_POINT_TYPE = [
+      # TODO: Write general description for CATALOG
+      CATALOG = 'catalog'.freeze,
+
+      # TODO: Write general description for DEFAULT
+      DEFAULT = 'default'.freeze,
+
+      # TODO: Write general description for CUSTOM
+      CUSTOM = 'custom'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRICE_POINT_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/pricing_scheme.rb

@@ -0,0 +1,31 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The identifier for the pricing scheme. See [Product
+  # Components](https://help.chargify.com/products/product-components.html) for
+  # an overview of pricing schemes.
+  class PricingScheme
+    PRICING_SCHEME = [
+      # TODO: Write general description for STAIRSTEP
+      STAIRSTEP = 'stairstep'.freeze,
+
+      # TODO: Write general description for VOLUME
+      VOLUME = 'volume'.freeze,
+
+      # TODO: Write general description for PER_UNIT
+      PER_UNIT = 'per_unit'.freeze,
+
+      # TODO: Write general description for TIERED
+      TIERED = 'tiered'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRICING_SCHEME.include?(value)
+    end
+  end
+end