maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/movement_line_item.rb

@@ -0,0 +1,148 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # MovementLineItem Model.
+  class MovementLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # For Product (or "baseline") line items, this field will have a value of
+    # `0`.
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # For Product (or "baseline") line items, this field will have a value of
+    # `0`.
+    # @return [Integer]
+    attr_accessor :price_point_id
+
+    # For Product (or "baseline") line items, this field will have a value of
+    # `0`.
+    # @return [String]
+    attr_accessor :name
+
+    # For Product (or "baseline") line items, this field will have a value of
+    # `0`.
+    # @return [Integer]
+    attr_accessor :mrr
+
+    # For Product (or "baseline") line items, this field will have a value of
+    # `0`.
+    # @return [Array[MRRMovement]]
+    attr_accessor :mrr_movements
+
+    # For Product (or "baseline") line items, this field will have a value of
+    # `0`.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # For Product (or "baseline") line items, this field will have a value of
+    # `0`.
+    # @return [Integer]
+    attr_accessor :prev_quantity
+
+    # When `true`, the line item's MRR value will contribute to the `plan`
+    # breakout. When `false`, the line item contributes to the `usage` breakout.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :recurring
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'product_id'
+      @_hash['component_id'] = 'component_id'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['name'] = 'name'
+      @_hash['mrr'] = 'mrr'
+      @_hash['mrr_movements'] = 'mrr_movements'
+      @_hash['quantity'] = 'quantity'
+      @_hash['prev_quantity'] = 'prev_quantity'
+      @_hash['recurring'] = 'recurring'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+        component_id
+        price_point_id
+        name
+        mrr
+        mrr_movements
+        quantity
+        prev_quantity
+        recurring
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_id = SKIP,
+                   component_id = SKIP,
+                   price_point_id = SKIP,
+                   name = SKIP,
+                   mrr = SKIP,
+                   mrr_movements = SKIP,
+                   quantity = SKIP,
+                   prev_quantity = SKIP,
+                   recurring = SKIP)
+      @product_id = product_id unless product_id == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @name = name unless name == SKIP
+      @mrr = mrr unless mrr == SKIP
+      @mrr_movements = mrr_movements unless mrr_movements == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @prev_quantity = prev_quantity unless prev_quantity == SKIP
+      @recurring = recurring unless recurring == 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.
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      mrr = hash.key?('mrr') ? hash['mrr'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      mrr_movements = nil
+      unless hash['mrr_movements'].nil?
+        mrr_movements = []
+        hash['mrr_movements'].each do |structure|
+          mrr_movements << (MRRMovement.from_hash(structure) if structure)
+        end
+      end
+
+      mrr_movements = SKIP unless hash.key?('mrr_movements')
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      prev_quantity = hash.key?('prev_quantity') ? hash['prev_quantity'] : SKIP
+      recurring = hash.key?('recurring') ? hash['recurring'] : SKIP
+
+      # Create object from extracted values.
+      MovementLineItem.new(product_id,
+                           component_id,
+                           price_point_id,
+                           name,
+                           mrr,
+                           mrr_movements,
+                           quantity,
+                           prev_quantity,
+                           recurring)
+    end
+  end
+end

data/lib/advanced_billing/models/mrr.rb

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

data/lib/advanced_billing/models/mrr_movement.rb

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

data/lib/advanced_billing/models/mrr_response.rb

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

data/lib/advanced_billing/models/multi_invoice_payment.rb

@@ -0,0 +1,92 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # MultiInvoicePayment Model.
+  class MultiInvoicePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The numeric ID of the transaction.
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # Dollar amount of the sum of the paid invoices.
+    # @return [String]
+    attr_accessor :total_amount
+
+    # The ISO 4217 currency code (3 character string) representing the currency
+    # of invoice transaction.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # The ISO 4217 currency code (3 character string) representing the currency
+    # of invoice transaction.
+    # @return [Array[InvoicePaymentApplication]]
+    attr_accessor :applications
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['total_amount'] = 'total_amount'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['applications'] = 'applications'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_id
+        total_amount
+        currency_code
+        applications
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_id = SKIP,
+                   total_amount = SKIP,
+                   currency_code = SKIP,
+                   applications = SKIP)
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @applications = applications unless applications == 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.
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : SKIP
+      total_amount = hash.key?('total_amount') ? hash['total_amount'] : SKIP
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      applications = nil
+      unless hash['applications'].nil?
+        applications = []
+        hash['applications'].each do |structure|
+          applications << (InvoicePaymentApplication.from_hash(structure) if structure)
+        end
+      end
+
+      applications = SKIP unless hash.key?('applications')
+
+      # Create object from extracted values.
+      MultiInvoicePayment.new(transaction_id,
+                              total_amount,
+                              currency_code,
+                              applications)
+    end
+  end
+end

data/lib/advanced_billing/models/multi_invoice_payment_response.rb

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

data/lib/advanced_billing/models/nested_subscription_group.rb

@@ -0,0 +1,94 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # NestedSubscriptionGroup Model.
+  class NestedSubscriptionGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The UID for the group
+    # @return [String]
+    attr_accessor :uid
+
+    # Whether the group is configured to rely on a primary subscription for
+    # billing. At this time, it will always be 1.
+    # @return [Integer]
+    attr_accessor :scheme
+
+    # The subscription ID of the primary within the group. Applicable to scheme
+    # 1.
+    # @return [Integer]
+    attr_accessor :primary_subscription_id
+
+    # A boolean indicating whether the subscription is the primary in the group.
+    # Applicable to scheme 1.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :primary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['scheme'] = 'scheme'
+      @_hash['primary_subscription_id'] = 'primary_subscription_id'
+      @_hash['primary'] = 'primary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        scheme
+        primary_subscription_id
+        primary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP,
+                   scheme = SKIP,
+                   primary_subscription_id = SKIP,
+                   primary = SKIP)
+      @uid = uid unless uid == SKIP
+      @scheme = scheme unless scheme == SKIP
+      @primary_subscription_id = primary_subscription_id unless primary_subscription_id == SKIP
+      @primary = primary unless primary == 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
+      scheme = hash.key?('scheme') ? hash['scheme'] : SKIP
+      primary_subscription_id =
+        hash.key?('primary_subscription_id') ? hash['primary_subscription_id'] : SKIP
+      primary = hash.key?('primary') ? hash['primary'] : SKIP
+
+      # Create object from extracted values.
+      NestedSubscriptionGroup.new(uid,
+                                  scheme,
+                                  primary_subscription_id,
+                                  primary)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [NestedSubscriptionGroup | 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