maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/allocation_preview_item.rb

@@ -0,0 +1,272 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # AllocationPreviewItem Model.
+  class AllocationPreviewItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :subscription_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :quantity
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :previous_quantity
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :timestamp
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :proration_upgrade_scheme
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :proration_downgrade_scheme
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :accrue_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 :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 [Integer]
+    attr_accessor :price_point_id
+
+    # The numerical interval. i.e. an interval of ‘30’ coupled with an
+    # interval_unit of day would mean this component 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 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 component price point,
+    # either month or day. This property is only available for sites with
+    # Multifrequency enabled.
+    # @return [Integer]
+    attr_accessor :previous_price_point_id
+
+    # A string representing the interval unit for this component price point,
+    # either month or day. This property is only available for sites with
+    # Multifrequency enabled.
+    # @return [String]
+    attr_accessor :price_point_handle
+
+    # A string representing the interval unit for this component price point,
+    # either month or day. This property is only available for sites with
+    # Multifrequency enabled.
+    # @return [String]
+    attr_accessor :price_point_name
+
+    # A string representing the interval unit for this component price point,
+    # either month or day. This property is only available for sites with
+    # Multifrequency enabled.
+    # @return [String]
+    attr_accessor :component_handle
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component_id'] = 'component_id'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['quantity'] = 'quantity'
+      @_hash['previous_quantity'] = 'previous_quantity'
+      @_hash['memo'] = 'memo'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['proration_upgrade_scheme'] = 'proration_upgrade_scheme'
+      @_hash['proration_downgrade_scheme'] = 'proration_downgrade_scheme'
+      @_hash['accrue_charge'] = 'accrue_charge'
+      @_hash['upgrade_charge'] = 'upgrade_charge'
+      @_hash['downgrade_credit'] = 'downgrade_credit'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['interval'] = 'interval'
+      @_hash['interval_unit'] = 'interval_unit'
+      @_hash['previous_price_point_id'] = 'previous_price_point_id'
+      @_hash['price_point_handle'] = 'price_point_handle'
+      @_hash['price_point_name'] = 'price_point_name'
+      @_hash['component_handle'] = 'component_handle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_id
+        subscription_id
+        quantity
+        previous_quantity
+        memo
+        timestamp
+        proration_upgrade_scheme
+        proration_downgrade_scheme
+        accrue_charge
+        upgrade_charge
+        downgrade_credit
+        price_point_id
+        interval
+        interval_unit
+        previous_price_point_id
+        price_point_handle
+        price_point_name
+        component_handle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        memo
+        timestamp
+        upgrade_charge
+        downgrade_credit
+        component_handle
+      ]
+    end
+
+    def initialize(component_id = SKIP,
+                   subscription_id = SKIP,
+                   quantity = SKIP,
+                   previous_quantity = SKIP,
+                   memo = SKIP,
+                   timestamp = SKIP,
+                   proration_upgrade_scheme = SKIP,
+                   proration_downgrade_scheme = SKIP,
+                   accrue_charge = SKIP,
+                   upgrade_charge = SKIP,
+                   downgrade_credit = SKIP,
+                   price_point_id = SKIP,
+                   interval = SKIP,
+                   interval_unit = SKIP,
+                   previous_price_point_id = SKIP,
+                   price_point_handle = SKIP,
+                   price_point_name = SKIP,
+                   component_handle = SKIP)
+      @component_id = component_id unless component_id == SKIP
+      @subscription_id = subscription_id unless subscription_id == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @previous_quantity = previous_quantity unless previous_quantity == SKIP
+      @memo = memo unless memo == SKIP
+      @timestamp = timestamp unless timestamp == SKIP
+      @proration_upgrade_scheme = proration_upgrade_scheme unless proration_upgrade_scheme == SKIP
+      unless proration_downgrade_scheme == SKIP
+        @proration_downgrade_scheme =
+          proration_downgrade_scheme
+      end
+      @accrue_charge = accrue_charge unless accrue_charge == SKIP
+      @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
+      @downgrade_credit = downgrade_credit unless downgrade_credit == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @interval = interval unless interval == SKIP
+      @interval_unit = interval_unit unless interval_unit == SKIP
+      @previous_price_point_id = previous_price_point_id unless previous_price_point_id == SKIP
+      @price_point_handle = price_point_handle unless price_point_handle == SKIP
+      @price_point_name = price_point_name unless price_point_name == SKIP
+      @component_handle = component_handle unless component_handle == 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.
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
+      quantity = hash.key?('quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AllocationPreviewItemQuantity), hash['quantity']
+      ) : SKIP
+      previous_quantity = hash.key?('previous_quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AllocationPreviewItemPreviousQuantity), hash['previous_quantity']
+      ) : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      proration_upgrade_scheme =
+        hash.key?('proration_upgrade_scheme') ? hash['proration_upgrade_scheme'] : SKIP
+      proration_downgrade_scheme =
+        hash.key?('proration_downgrade_scheme') ? hash['proration_downgrade_scheme'] : SKIP
+      accrue_charge = hash.key?('accrue_charge') ? hash['accrue_charge'] : SKIP
+      upgrade_charge =
+        hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
+      downgrade_credit =
+        hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
+      interval = hash.key?('interval') ? hash['interval'] : SKIP
+      interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : SKIP
+      previous_price_point_id =
+        hash.key?('previous_price_point_id') ? hash['previous_price_point_id'] : SKIP
+      price_point_handle =
+        hash.key?('price_point_handle') ? hash['price_point_handle'] : SKIP
+      price_point_name =
+        hash.key?('price_point_name') ? hash['price_point_name'] : SKIP
+      component_handle =
+        hash.key?('component_handle') ? hash['component_handle'] : SKIP
+
+      # Create object from extracted values.
+      AllocationPreviewItem.new(component_id,
+                                subscription_id,
+                                quantity,
+                                previous_quantity,
+                                memo,
+                                timestamp,
+                                proration_upgrade_scheme,
+                                proration_downgrade_scheme,
+                                accrue_charge,
+                                upgrade_charge,
+                                downgrade_credit,
+                                price_point_id,
+                                interval,
+                                interval_unit,
+                                previous_price_point_id,
+                                price_point_handle,
+                                price_point_name,
+                                component_handle)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AllocationPreviewItem | 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

data/lib/advanced_billing/models/allocation_preview_line_item.rb

@@ -0,0 +1,135 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # AllocationPreviewLineItem Model.
+  class AllocationPreviewLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A handle for the line item transaction type
+    # @return [LineItemTransactionType]
+    attr_accessor :transaction_type
+
+    # A handle for the line item kind for allocation preview
+    # @return [AllocationPreviewLineItemKind]
+    attr_accessor :kind
+
+    # A handle for the line item kind for allocation preview
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # A handle for the line item kind for allocation preview
+    # @return [String]
+    attr_accessor :memo
+
+    # A handle for the line item kind for allocation preview
+    # @return [Integer]
+    attr_accessor :discount_amount_in_cents
+
+    # A handle for the line item kind for allocation preview
+    # @return [Integer]
+    attr_accessor :taxable_amount_in_cents
+
+    # A handle for the line item kind for allocation preview
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # A handle for the line item kind for allocation preview
+    # @return [String]
+    attr_accessor :component_handle
+
+    # Visible when using Fine-grained Component Control
+    # @return [AllocationPreviewDirection]
+    attr_accessor :direction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash['kind'] = 'kind'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['memo'] = 'memo'
+      @_hash['discount_amount_in_cents'] = 'discount_amount_in_cents'
+      @_hash['taxable_amount_in_cents'] = 'taxable_amount_in_cents'
+      @_hash['component_id'] = 'component_id'
+      @_hash['component_handle'] = 'component_handle'
+      @_hash['direction'] = 'direction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_type
+        kind
+        amount_in_cents
+        memo
+        discount_amount_in_cents
+        taxable_amount_in_cents
+        component_id
+        component_handle
+        direction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_type = SKIP,
+                   kind = SKIP,
+                   amount_in_cents = SKIP,
+                   memo = SKIP,
+                   discount_amount_in_cents = SKIP,
+                   taxable_amount_in_cents = SKIP,
+                   component_id = SKIP,
+                   component_handle = SKIP,
+                   direction = SKIP)
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @kind = kind unless kind == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @memo = memo unless memo == SKIP
+      @discount_amount_in_cents = discount_amount_in_cents unless discount_amount_in_cents == SKIP
+      @taxable_amount_in_cents = taxable_amount_in_cents unless taxable_amount_in_cents == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @component_handle = component_handle unless component_handle == SKIP
+      @direction = direction unless direction == 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_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      discount_amount_in_cents =
+        hash.key?('discount_amount_in_cents') ? hash['discount_amount_in_cents'] : SKIP
+      taxable_amount_in_cents =
+        hash.key?('taxable_amount_in_cents') ? hash['taxable_amount_in_cents'] : SKIP
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      component_handle =
+        hash.key?('component_handle') ? hash['component_handle'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+
+      # Create object from extracted values.
+      AllocationPreviewLineItem.new(transaction_type,
+                                    kind,
+                                    amount_in_cents,
+                                    memo,
+                                    discount_amount_in_cents,
+                                    taxable_amount_in_cents,
+                                    component_id,
+                                    component_handle,
+                                    direction)
+    end
+  end
+end

data/lib/advanced_billing/models/allocation_preview_line_item_kind.rb

@@ -0,0 +1,29 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # A handle for the line item kind for allocation preview
+  class AllocationPreviewLineItemKind
+    ALLOCATION_PREVIEW_LINE_ITEM_KIND = [
+      # TODO: Write general description for QUANTITY_BASED_COMPONENT
+      QUANTITY_BASED_COMPONENT = 'quantity_based_component'.freeze,
+
+      # TODO: Write general description for ON_OFF_COMPONENT
+      ON_OFF_COMPONENT = 'on_off_component'.freeze,
+
+      # TODO: Write general description for COUPON
+      COUPON = 'coupon'.freeze,
+
+      # TODO: Write general description for TAX
+      TAX = 'tax'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ALLOCATION_PREVIEW_LINE_ITEM_KIND.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/allocation_preview_response.rb

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

data/lib/advanced_billing/models/allocation_response.rb

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

data/lib/advanced_billing/models/allocation_settings.rb

@@ -0,0 +1,79 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # AllocationSettings Model.
+  class AllocationSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # Either "true" or "false".
+    # @return [String]
+    attr_accessor :accrue_charge
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['upgrade_charge'] = 'upgrade_charge'
+      @_hash['downgrade_credit'] = 'downgrade_credit'
+      @_hash['accrue_charge'] = 'accrue_charge'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        upgrade_charge
+        downgrade_credit
+        accrue_charge
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        upgrade_charge
+        downgrade_credit
+      ]
+    end
+
+    def initialize(upgrade_charge = SKIP,
+                   downgrade_credit = SKIP,
+                   accrue_charge = SKIP)
+      @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
+      @downgrade_credit = downgrade_credit unless downgrade_credit == SKIP
+      @accrue_charge = accrue_charge unless accrue_charge == 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.
+      upgrade_charge =
+        hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
+      downgrade_credit =
+        hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
+      accrue_charge = hash.key?('accrue_charge') ? hash['accrue_charge'] : SKIP
+
+      # Create object from extracted values.
+      AllocationSettings.new(upgrade_charge,
+                             downgrade_credit,
+                             accrue_charge)
+    end
+  end
+end

data/lib/advanced_billing/models/applied_credit_note_data.rb

@@ -0,0 +1,60 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # AppliedCreditNoteData Model.
+  class AppliedCreditNoteData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The UID of the credit note
+    # @return [String]
+    attr_accessor :uid
+
+    # The number of the credit note
+    # @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.
+      AppliedCreditNoteData.new(uid,
+                                number)
+    end
+  end
+end