orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/credit_block_invoices_response.rb

@@ -0,0 +1,91 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreditBlockInvoicesResponse Model.
+  class CreditBlockInvoicesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Credit Block resource models prepaid credits within Orb.
+    # @return [CreditBlock]
+    attr_accessor :block
+
+    # The Credit Block resource models prepaid credits within Orb.
+    # @return [Array[InvoiceMinified]]
+    attr_accessor :invoices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['block'] = 'block'
+      @_hash['invoices'] = 'invoices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(block:, invoices:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @block = block
+      @invoices = invoices
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      block = CreditBlock.from_hash(hash['block']) if hash['block']
+      # Parameter is an array, so we need to iterate through it
+      invoices = nil
+      unless hash['invoices'].nil?
+        invoices = []
+        hash['invoices'].each do |structure|
+          invoices << (InvoiceMinified.from_hash(structure) if structure)
+        end
+      end
+
+      invoices = nil unless hash.key?('invoices')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CreditBlockInvoicesResponse.new(block: block,
+                                      invoices: invoices,
+                                      additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} block: #{@block}, invoices: #{@invoices}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} block: #{@block.inspect}, invoices: #{@invoices.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/credit_block_source.rb

@@ -0,0 +1,43 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # How this credit block was created: `allocation` (a subscription's recurring
+  # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+  # `manual` (a manual credit ledger increment, including credits voided or
+  # expired off another block).
+  class CreditBlockSource
+    CREDIT_BLOCK_SOURCE = [
+      # TODO: Write general description for ALLOCATION
+      ALLOCATION = 'allocation'.freeze,
+
+      # TODO: Write general description for TOP_UP
+      TOP_UP = 'top_up'.freeze,
+
+      # TODO: Write general description for MANUAL
+      MANUAL = 'manual'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ALLOCATION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'allocation' then ALLOCATION
+      when 'top_up' then TOP_UP
+      when 'manual' then MANUAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/credit_ledger_entries.rb

@@ -0,0 +1,109 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreditLedgerEntries Model.
+  class CreditLedgerEntries < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [PaginationMetadata]
+    attr_accessor :pagination_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['pagination_metadata'] = 'pagination_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, pagination_metadata:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @pagination_metadata = pagination_metadata
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      data = hash.key?('data') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreditLedgerEntry2), hash['data']
+      ) : nil
+      pagination_metadata = PaginationMetadata.from_hash(hash['pagination_metadata']) if
+        hash['pagination_metadata']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CreditLedgerEntries.new(data: data,
+                              pagination_metadata: pagination_metadata,
+                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditLedgerEntries | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:CreditLedgerEntry2)
+                         .validate(value.data) and
+            APIHelper.valid_type?(value.pagination_metadata,
+                                  ->(val) { PaginationMetadata.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:CreditLedgerEntry2)
+                       .validate(value['data']) and
+          APIHelper.valid_type?(value['pagination_metadata'],
+                                ->(val) { PaginationMetadata.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, pagination_metadata: #{@pagination_metadata},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, pagination_metadata:"\
+      " #{@pagination_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/credit_note.rb

@@ -0,0 +1,338 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # The [Credit Note](/invoicing/credit-notes) resource represents a credit that
+  # has been applied to a particular invoice.
+  class CreditNote < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Orb id of this credit note.
+    # @return [String]
+    attr_accessor :id
+
+    # The creation time of the resource in Orb.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The time at which the credit note was voided in Orb, if applicable.
+    # @return [DateTime]
+    attr_accessor :voided_at
+
+    # The unique identifier for credit notes.
+    # @return [String]
+    attr_accessor :credit_note_number
+
+    # The id of the invoice resource that this credit note is applied to.
+    # @return [String]
+    attr_accessor :invoice_id
+
+    # An optional memo supplied on the credit note.
+    # @return [String]
+    attr_accessor :memo
+
+    # An optional memo supplied on the credit note.
+    # @return [Reason]
+    attr_accessor :reason
+
+    # An optional memo supplied on the credit note.
+    # @return [Type3]
+    attr_accessor :type
+
+    # The total prior to any creditable invoice-level discounts or minimums.
+    # @return [String]
+    attr_accessor :subtotal
+
+    # The total including creditable invoice-level discounts or minimums, and
+    # tax.
+    # @return [String]
+    attr_accessor :total
+
+    # The total including creditable invoice-level discounts or minimums, and
+    # tax.
+    # @return [CustomerMinified]
+    attr_accessor :customer
+
+    # A URL to a PDF of the credit note.
+    # @return [String]
+    attr_accessor :credit_note_pdf
+
+    # Any credited amount from the applied minimum on the invoice.
+    # @return [String]
+    attr_accessor :minimum_amount_refunded
+
+    # Any discounts applied on the original invoice.
+    # @return [Array[CreditNoteDiscount]]
+    attr_accessor :discounts
+
+    # The maximum amount applied on the original invoice
+    # @return [CreditNoteDiscount]
+    attr_accessor :maximum_amount_adjustment
+
+    # All of the line items associated with this credit note.
+    # @return [Array[CreditNoteLineItem]]
+    attr_accessor :line_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created_at'] = 'created_at'
+      @_hash['voided_at'] = 'voided_at'
+      @_hash['credit_note_number'] = 'credit_note_number'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['memo'] = 'memo'
+      @_hash['reason'] = 'reason'
+      @_hash['type'] = 'type'
+      @_hash['subtotal'] = 'subtotal'
+      @_hash['total'] = 'total'
+      @_hash['customer'] = 'customer'
+      @_hash['credit_note_pdf'] = 'credit_note_pdf'
+      @_hash['minimum_amount_refunded'] = 'minimum_amount_refunded'
+      @_hash['discounts'] = 'discounts'
+      @_hash['maximum_amount_adjustment'] = 'maximum_amount_adjustment'
+      @_hash['line_items'] = 'line_items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        discounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        voided_at
+        memo
+        reason
+        credit_note_pdf
+        minimum_amount_refunded
+        maximum_amount_adjustment
+      ]
+    end
+
+    def initialize(id:, created_at:, voided_at:, credit_note_number:,
+                   invoice_id:, memo:, reason:, type:, subtotal:, total:,
+                   customer:, credit_note_pdf:, minimum_amount_refunded:,
+                   maximum_amount_adjustment:, line_items:, discounts: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @created_at = created_at
+      @voided_at = voided_at
+      @credit_note_number = credit_note_number
+      @invoice_id = invoice_id
+      @memo = memo
+      @reason = reason
+      @type = type
+      @subtotal = subtotal
+      @total = total
+      @customer = customer
+      @credit_note_pdf = credit_note_pdf
+      @minimum_amount_refunded = minimum_amount_refunded
+      @discounts = discounts unless discounts == SKIP
+      @maximum_amount_adjustment = maximum_amount_adjustment
+      @line_items = line_items
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      voided_at = if hash.key?('voided_at')
+                    (DateTimeHelper.from_rfc3339(hash['voided_at']) if hash['voided_at'])
+                  end
+      credit_note_number =
+        hash.key?('credit_note_number') ? hash['credit_note_number'] : nil
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      subtotal = hash.key?('subtotal') ? hash['subtotal'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+      customer = CustomerMinified.from_hash(hash['customer']) if hash['customer']
+      credit_note_pdf =
+        hash.key?('credit_note_pdf') ? hash['credit_note_pdf'] : nil
+      minimum_amount_refunded =
+        hash.key?('minimum_amount_refunded') ? hash['minimum_amount_refunded'] : nil
+      maximum_amount_adjustment = CreditNoteDiscount.from_hash(hash['maximum_amount_adjustment']) if
+        hash['maximum_amount_adjustment']
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (CreditNoteLineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+      # Parameter is an array, so we need to iterate through it
+      discounts = nil
+      unless hash['discounts'].nil?
+        discounts = []
+        hash['discounts'].each do |structure|
+          discounts << (CreditNoteDiscount.from_hash(structure) if structure)
+        end
+      end
+
+      discounts = SKIP unless hash.key?('discounts')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CreditNote.new(id: id,
+                     created_at: created_at,
+                     voided_at: voided_at,
+                     credit_note_number: credit_note_number,
+                     invoice_id: invoice_id,
+                     memo: memo,
+                     reason: reason,
+                     type: type,
+                     subtotal: subtotal,
+                     total: total,
+                     customer: customer,
+                     credit_note_pdf: credit_note_pdf,
+                     minimum_amount_refunded: minimum_amount_refunded,
+                     maximum_amount_adjustment: maximum_amount_adjustment,
+                     line_items: line_items,
+                     discounts: discounts,
+                     additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_voided_at
+      DateTimeHelper.to_rfc3339(voided_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditNote | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.voided_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.credit_note_number,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.invoice_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.memo,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.reason,
+                                  ->(val) { Reason.validate(val) }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { Type3.validate(val) }) and
+            APIHelper.valid_type?(value.subtotal,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.total,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.customer,
+                                  ->(val) { CustomerMinified.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.credit_note_pdf,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.minimum_amount_refunded,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.maximum_amount_adjustment,
+                                  ->(val) { CreditNoteDiscount.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.line_items,
+                                  ->(val) { CreditNoteLineItem.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['voided_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['credit_note_number'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['memo'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['reason'],
+                                ->(val) { Reason.validate(val) }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(val) { Type3.validate(val) }) and
+          APIHelper.valid_type?(value['subtotal'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['total'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['customer'],
+                                ->(val) { CustomerMinified.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['credit_note_pdf'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['minimum_amount_refunded'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['maximum_amount_adjustment'],
+                                ->(val) { CreditNoteDiscount.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['line_items'],
+                                ->(val) { CreditNoteLineItem.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, created_at: #{@created_at}, voided_at: #{@voided_at},"\
+      " credit_note_number: #{@credit_note_number}, invoice_id: #{@invoice_id}, memo: #{@memo},"\
+      " reason: #{@reason}, type: #{@type}, subtotal: #{@subtotal}, total: #{@total}, customer:"\
+      " #{@customer}, credit_note_pdf: #{@credit_note_pdf}, minimum_amount_refunded:"\
+      " #{@minimum_amount_refunded}, discounts: #{@discounts}, maximum_amount_adjustment:"\
+      " #{@maximum_amount_adjustment}, line_items: #{@line_items}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, created_at: #{@created_at.inspect}, voided_at:"\
+      " #{@voided_at.inspect}, credit_note_number: #{@credit_note_number.inspect}, invoice_id:"\
+      " #{@invoice_id.inspect}, memo: #{@memo.inspect}, reason: #{@reason.inspect}, type:"\
+      " #{@type.inspect}, subtotal: #{@subtotal.inspect}, total: #{@total.inspect}, customer:"\
+      " #{@customer.inspect}, credit_note_pdf: #{@credit_note_pdf.inspect},"\
+      " minimum_amount_refunded: #{@minimum_amount_refunded.inspect}, discounts:"\
+      " #{@discounts.inspect}, maximum_amount_adjustment: #{@maximum_amount_adjustment.inspect},"\
+      " line_items: #{@line_items.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end