maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/invoice_status.rb

@@ -0,0 +1,37 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The current status of the invoice. See [Invoice
+  # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#line-
+  # item-breakdowns) for more.
+  class InvoiceStatus
+    INVOICE_STATUS = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze,
+
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'paid'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'voided'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_STATUS.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_tax.rb

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

data/lib/advanced_billing/models/invoice_tax_breakout.rb

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

data/lib/advanced_billing/models/invoice_tax_component_breakout.rb

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

data/lib/advanced_billing/models/issue_advance_invoice_request.rb

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

data/lib/advanced_billing/models/issue_invoice_event_data.rb

@@ -0,0 +1,136 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Example schema for an `issue_invoice` event
+  class IssueInvoiceEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Consolidation level of the invoice, which is applicable to invoice
+    # consolidation.  It will hold one of the following values:
+    # * "none": A normal invoice with no consolidation.
+    # * "child": An invoice segment which has been combined into a consolidated
+    # invoice.
+    # * "parent": A consolidated invoice, whose contents are composed of invoice
+    # segments.
+    # "Parent" invoices do not have lines of their own, but they have subtotals
+    # and totals which aggregate the member invoice segments.
+    # See also the [invoice consolidation
+    # documentation](https://chargify.zendesk.com/hc/en-us/articles/440774639183
+    # 5).
+    # @return [InvoiceConsolidationLevel]
+    attr_accessor :consolidation_level
+
+    # The status of the invoice before event occurence. See [Invoice
+    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
+    # e-item-breakdowns) for more.
+    # @return [InvoiceStatus]
+    attr_accessor :from_status
+
+    # The status of the invoice after event occurence. See [Invoice
+    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
+    # e-item-breakdowns) for more.
+    # @return [InvoiceStatus]
+    attr_accessor :to_status
+
+    # Amount due on the invoice, which is `total_amount - credit_amount -
+    # paid_amount`.
+    # @return [String]
+    attr_accessor :due_amount
+
+    # The invoice total, which is `subtotal_amount - discount_amount +
+    # tax_amount`.'
+    # @return [String]
+    attr_accessor :total_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['consolidation_level'] = 'consolidation_level'
+      @_hash['from_status'] = 'from_status'
+      @_hash['to_status'] = 'to_status'
+      @_hash['due_amount'] = 'due_amount'
+      @_hash['total_amount'] = 'total_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(consolidation_level = nil,
+                   from_status = nil,
+                   to_status = nil,
+                   due_amount = nil,
+                   total_amount = nil)
+      @consolidation_level = consolidation_level
+      @from_status = from_status
+      @to_status = to_status
+      @due_amount = due_amount
+      @total_amount = total_amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      consolidation_level =
+        hash.key?('consolidation_level') ? hash['consolidation_level'] : nil
+      from_status = hash.key?('from_status') ? hash['from_status'] : nil
+      to_status = hash.key?('to_status') ? hash['to_status'] : nil
+      due_amount = hash.key?('due_amount') ? hash['due_amount'] : nil
+      total_amount = hash.key?('total_amount') ? hash['total_amount'] : nil
+
+      # Create object from extracted values.
+      IssueInvoiceEventData.new(consolidation_level,
+                                from_status,
+                                to_status,
+                                due_amount,
+                                total_amount)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [IssueInvoiceEventData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.consolidation_level,
+                                ->(val) { InvoiceConsolidationLevel.validate(val) }) and
+            APIHelper.valid_type?(value.from_status,
+                                  ->(val) { InvoiceStatus.validate(val) }) and
+            APIHelper.valid_type?(value.to_status,
+                                  ->(val) { InvoiceStatus.validate(val) }) and
+            APIHelper.valid_type?(value.due_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.total_amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['consolidation_level'],
+                              ->(val) { InvoiceConsolidationLevel.validate(val) }) and
+          APIHelper.valid_type?(value['from_status'],
+                                ->(val) { InvoiceStatus.validate(val) }) and
+          APIHelper.valid_type?(value['to_status'],
+                                ->(val) { InvoiceStatus.validate(val) }) and
+          APIHelper.valid_type?(value['due_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['total_amount'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/issue_invoice_request.rb

@@ -0,0 +1,63 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # IssueInvoiceRequest Model.
+  class IssueInvoiceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Action taken when payment for an invoice fails:
+    # - `leave_open_invoice` - prepayments and credits applied to invoice;
+    # invoice status set to "open"; email sent to the customer for the issued
+    # invoice (if setting applies); payment failure recorded in the invoice
+    # history. This is the default option.
+    # - `rollback_to_pending` - prepayments and credits not applied; invoice
+    # remains in "pending" status; no email sent to the customer; payment
+    # failure recorded in the invoice history.
+    # - `initiate_dunning` - prepayments and credits applied to the invoice;
+    # invoice status set to "open"; email sent to the customer for the issued
+    # invoice (if setting applies); payment failure recorded in the invoice
+    # history; subscription will  most likely go into "past_due" or "canceled"
+    # state (depending upon net terms and dunning settings).
+    # @return [FailedPaymentAction]
+    attr_accessor :on_failed_payment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['on_failed_payment'] = 'on_failed_payment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        on_failed_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(on_failed_payment = FailedPaymentAction::LEAVE_OPEN_INVOICE)
+      @on_failed_payment = on_failed_payment unless on_failed_payment == 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.
+      on_failed_payment =
+        hash['on_failed_payment'] ||= FailedPaymentAction::LEAVE_OPEN_INVOICE
+
+      # Create object from extracted values.
+      IssueInvoiceRequest.new(on_failed_payment)
+    end
+  end
+end

data/lib/advanced_billing/models/issue_service_credit.rb

@@ -0,0 +1,81 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # IssueServiceCredit Model.
+  class IssueServiceCredit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['memo'] = 'memo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil,
+                   memo = nil)
+      @amount = amount
+      @memo = memo
+    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') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:IssueServiceCreditAmount), hash['amount']
+      ) : nil
+      memo = hash.key?('memo') ? hash['memo'] : nil
+
+      # Create object from extracted values.
+      IssueServiceCredit.new(amount,
+                             memo)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [IssueServiceCredit | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:IssueServiceCreditAmount)
+                         .validate(value.amount) and
+            APIHelper.valid_type?(value.memo,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:IssueServiceCreditAmount)
+                       .validate(value['amount']) and
+          APIHelper.valid_type?(value['memo'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end