maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/create_prepaid_usage_component_price_point.rb

@@ -0,0 +1,197 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreatePrepaidUsageComponentPricePoint Model.
+  class CreatePrepaidUsageComponentPricePoint < 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
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [OveragePricing]
+    attr_accessor :overage_pricing
+
+    # 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
+
+    # 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['overage_pricing'] = 'overage_pricing'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_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[
+        handle
+        use_site_exchange_rate
+        rollover_prepaid_remainder
+        renew_prepaid_allocation
+        expiration_interval
+        expiration_interval_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   pricing_scheme = nil,
+                   prices = nil,
+                   overage_pricing = nil,
+                   handle = SKIP,
+                   use_site_exchange_rate = true,
+                   rollover_prepaid_remainder = SKIP,
+                   renew_prepaid_allocation = SKIP,
+                   expiration_interval = SKIP,
+                   expiration_interval_unit = SKIP)
+      @name = name
+      @handle = handle unless handle == SKIP
+      @pricing_scheme = pricing_scheme
+      @prices = prices
+      @overage_pricing = overage_pricing
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == 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'] : nil
+      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 = nil unless hash.key?('prices')
+      overage_pricing = OveragePricing.from_hash(hash['overage_pricing']) if
+        hash['overage_pricing']
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      use_site_exchange_rate = hash['use_site_exchange_rate'] ||= true
+      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.
+      CreatePrepaidUsageComponentPricePoint.new(name,
+                                                pricing_scheme,
+                                                prices,
+                                                overage_pricing,
+                                                handle,
+                                                use_site_exchange_rate,
+                                                rollover_prepaid_remainder,
+                                                renew_prepaid_allocation,
+                                                expiration_interval,
+                                                expiration_interval_unit)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreatePrepaidUsageComponentPricePoint | 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.pricing_scheme,
+                                  ->(val) { PricingScheme.validate(val) }) and
+            APIHelper.valid_type?(value.prices,
+                                  ->(val) { Price.validate(val) }) and
+            APIHelper.valid_type?(value.overage_pricing,
+                                  ->(val) { OveragePricing.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['pricing_scheme'],
+                                ->(val) { PricingScheme.validate(val) }) and
+          APIHelper.valid_type?(value['prices'],
+                                ->(val) { Price.validate(val) }) and
+          APIHelper.valid_type?(value['overage_pricing'],
+                                ->(val) { OveragePricing.validate(val) })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/create_prepayment.rb

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

data/lib/advanced_billing/models/create_prepayment_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreatePrepaymentRequest Model.
+  class CreatePrepaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreatePrepayment]
+    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 = CreatePrepayment.from_hash(hash['prepayment']) if hash['prepayment']
+
+      # Create object from extracted values.
+      CreatePrepaymentRequest.new(prepayment)
+    end
+  end
+end

data/lib/advanced_billing/models/create_prepayment_response.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreatePrepaymentResponse Model.
+  class CreatePrepaymentResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreatedPrepayment]
+    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 = CreatedPrepayment.from_hash(hash['prepayment']) if hash['prepayment']
+
+      # Create object from extracted values.
+      CreatePrepaymentResponse.new(prepayment)
+    end
+  end
+end

data/lib/advanced_billing/models/create_product_currency_price.rb

@@ -0,0 +1,66 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateProductCurrencyPrice Model.
+  class CreateProductCurrencyPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO code for one of the site level currencies.
+    # @return [String]
+    attr_accessor :currency
+
+    # Price for the given role.
+    # @return [Integer]
+    attr_accessor :price
+
+    # Role for the price.
+    # @return [CurrencyPriceRole]
+    attr_accessor :role
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['price'] = 'price'
+      @_hash['role'] = 'role'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency = nil,
+                   price = nil,
+                   role = nil)
+      @currency = currency
+      @price = price
+      @role = role
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      price = hash.key?('price') ? hash['price'] : nil
+      role = hash.key?('role') ? hash['role'] : nil
+
+      # Create object from extracted values.
+      CreateProductCurrencyPrice.new(currency,
+                                     price,
+                                     role)
+    end
+  end
+end

data/lib/advanced_billing/models/create_product_currency_prices_request.rb

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

data/lib/advanced_billing/models/create_product_family.rb

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

data/lib/advanced_billing/models/create_product_family_request.rb

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