xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/prepayment.rb

@@ -0,0 +1,309 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Prepayment Model.
+  class Prepayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # See Prepayment Types
+    # @return [Type4]
+    attr_accessor :type
+
+    # See Prepayment Types
+    # @return [Contact]
+    attr_accessor :contact
+
+    # The date the prepayment is created YYYY-MM-DD
+    # @return [String]
+    attr_accessor :date
+
+    # See Prepayment Status Codes
+    # @return [Status4]
+    attr_accessor :status
+
+    # Line amounts are exclusive of tax by default if you don’t specify this
+    # element. See Line Amount Types
+    # @return [LineAmountTypes]
+    attr_accessor :line_amount_types
+
+    # See Prepayment Line Items
+    # @return [Array[LineItem]]
+    attr_accessor :line_items
+
+    # The subtotal of the prepayment excluding taxes
+    # @return [Float]
+    attr_accessor :sub_total
+
+    # The total tax on the prepayment
+    # @return [Float]
+    attr_accessor :total_tax
+
+    # The total of the prepayment(subtotal + total tax)
+    # @return [Float]
+    attr_accessor :total
+
+    # Returns Invoice number field. Reference field isn't available.
+    # @return [String]
+    attr_accessor :reference
+
+    # UTC timestamp of last update to the prepayment
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # 3 letter alpha code for the currency – see list of currency codes
+    # @return [CurrencyCode]
+    attr_accessor :currency_code
+
+    # Xero generated unique identifier
+    # @return [UUID | String]
+    attr_accessor :prepayment_id
+
+    # The currency rate for a multicurrency prepayment. If no rate is specified,
+    # the XE.com day rate is used
+    # @return [Float]
+    attr_accessor :currency_rate
+
+    # The remaining credit balance on the prepayment
+    # @return [Float]
+    attr_accessor :remaining_credit
+
+    # See Allocations
+    # @return [Array[Allocation]]
+    attr_accessor :allocations
+
+    # See Payments
+    # @return [Array[Payment]]
+    attr_accessor :payments
+
+    # The amount of applied to an invoice
+    # @return [Float]
+    attr_accessor :applied_amount
+
+    # boolean to indicate if a prepayment has an attachment
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_attachments
+
+    # See Attachments
+    # @return [Array[Attachment]]
+    attr_accessor :attachments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'Type'
+      @_hash['contact'] = 'Contact'
+      @_hash['date'] = 'Date'
+      @_hash['status'] = 'Status'
+      @_hash['line_amount_types'] = 'LineAmountTypes'
+      @_hash['line_items'] = 'LineItems'
+      @_hash['sub_total'] = 'SubTotal'
+      @_hash['total_tax'] = 'TotalTax'
+      @_hash['total'] = 'Total'
+      @_hash['reference'] = 'Reference'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['prepayment_id'] = 'PrepaymentID'
+      @_hash['currency_rate'] = 'CurrencyRate'
+      @_hash['remaining_credit'] = 'RemainingCredit'
+      @_hash['allocations'] = 'Allocations'
+      @_hash['payments'] = 'Payments'
+      @_hash['applied_amount'] = 'AppliedAmount'
+      @_hash['has_attachments'] = 'HasAttachments'
+      @_hash['attachments'] = 'Attachments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        contact
+        date
+        status
+        line_amount_types
+        line_items
+        sub_total
+        total_tax
+        total
+        reference
+        updated_date_utc
+        currency_code
+        prepayment_id
+        currency_rate
+        remaining_credit
+        allocations
+        payments
+        applied_amount
+        has_attachments
+        attachments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, contact: SKIP, date: SKIP, status: SKIP,
+                   line_amount_types: SKIP, line_items: SKIP, sub_total: SKIP,
+                   total_tax: SKIP, total: SKIP, reference: SKIP,
+                   updated_date_utc: SKIP, currency_code: SKIP,
+                   prepayment_id: SKIP, currency_rate: SKIP,
+                   remaining_credit: SKIP, allocations: SKIP, payments: SKIP,
+                   applied_amount: SKIP, has_attachments: false,
+                   attachments: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @contact = contact unless contact == SKIP
+      @date = date unless date == SKIP
+      @status = status unless status == SKIP
+      @line_amount_types = line_amount_types unless line_amount_types == SKIP
+      @line_items = line_items unless line_items == SKIP
+      @sub_total = sub_total unless sub_total == SKIP
+      @total_tax = total_tax unless total_tax == SKIP
+      @total = total unless total == SKIP
+      @reference = reference unless reference == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @prepayment_id = prepayment_id unless prepayment_id == SKIP
+      @currency_rate = currency_rate unless currency_rate == SKIP
+      @remaining_credit = remaining_credit unless remaining_credit == SKIP
+      @allocations = allocations unless allocations == SKIP
+      @payments = payments unless payments == SKIP
+      @applied_amount = applied_amount unless applied_amount == SKIP
+      @has_attachments = has_attachments unless has_attachments == SKIP
+      @attachments = attachments unless attachments == SKIP
+      @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.
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      contact = Contact.from_hash(hash['Contact']) if hash['Contact']
+      date = hash.key?('Date') ? hash['Date'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      line_amount_types =
+        hash.key?('LineAmountTypes') ? hash['LineAmountTypes'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['LineItems'].nil?
+        line_items = []
+        hash['LineItems'].each do |structure|
+          line_items << (LineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('LineItems')
+      sub_total = hash.key?('SubTotal') ? hash['SubTotal'] : SKIP
+      total_tax = hash.key?('TotalTax') ? hash['TotalTax'] : SKIP
+      total = hash.key?('Total') ? hash['Total'] : SKIP
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      prepayment_id = hash.key?('PrepaymentID') ? hash['PrepaymentID'] : SKIP
+      currency_rate = hash.key?('CurrencyRate') ? hash['CurrencyRate'] : SKIP
+      remaining_credit =
+        hash.key?('RemainingCredit') ? hash['RemainingCredit'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      allocations = nil
+      unless hash['Allocations'].nil?
+        allocations = []
+        hash['Allocations'].each do |structure|
+          allocations << (Allocation.from_hash(structure) if structure)
+        end
+      end
+
+      allocations = SKIP unless hash.key?('Allocations')
+      # Parameter is an array, so we need to iterate through it
+      payments = nil
+      unless hash['Payments'].nil?
+        payments = []
+        hash['Payments'].each do |structure|
+          payments << (Payment.from_hash(structure) if structure)
+        end
+      end
+
+      payments = SKIP unless hash.key?('Payments')
+      applied_amount = hash.key?('AppliedAmount') ? hash['AppliedAmount'] : SKIP
+      has_attachments = hash['HasAttachments'] ||= false
+      # Parameter is an array, so we need to iterate through it
+      attachments = nil
+      unless hash['Attachments'].nil?
+        attachments = []
+        hash['Attachments'].each do |structure|
+          attachments << (Attachment.from_hash(structure) if structure)
+        end
+      end
+
+      attachments = SKIP unless hash.key?('Attachments')
+
+      # 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.
+      Prepayment.new(type: type,
+                     contact: contact,
+                     date: date,
+                     status: status,
+                     line_amount_types: line_amount_types,
+                     line_items: line_items,
+                     sub_total: sub_total,
+                     total_tax: total_tax,
+                     total: total,
+                     reference: reference,
+                     updated_date_utc: updated_date_utc,
+                     currency_code: currency_code,
+                     prepayment_id: prepayment_id,
+                     currency_rate: currency_rate,
+                     remaining_credit: remaining_credit,
+                     allocations: allocations,
+                     payments: payments,
+                     applied_amount: applied_amount,
+                     has_attachments: has_attachments,
+                     attachments: attachments,
+                     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} type: #{@type}, contact: #{@contact}, date: #{@date}, status: #{@status},"\
+      " line_amount_types: #{@line_amount_types}, line_items: #{@line_items}, sub_total:"\
+      " #{@sub_total}, total_tax: #{@total_tax}, total: #{@total}, reference: #{@reference},"\
+      " updated_date_utc: #{@updated_date_utc}, currency_code: #{@currency_code}, prepayment_id:"\
+      " #{@prepayment_id}, currency_rate: #{@currency_rate}, remaining_credit:"\
+      " #{@remaining_credit}, allocations: #{@allocations}, payments: #{@payments},"\
+      " applied_amount: #{@applied_amount}, has_attachments: #{@has_attachments}, attachments:"\
+      " #{@attachments}, 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} type: #{@type.inspect}, contact: #{@contact.inspect}, date:"\
+      " #{@date.inspect}, status: #{@status.inspect}, line_amount_types:"\
+      " #{@line_amount_types.inspect}, line_items: #{@line_items.inspect}, sub_total:"\
+      " #{@sub_total.inspect}, total_tax: #{@total_tax.inspect}, total: #{@total.inspect},"\
+      " reference: #{@reference.inspect}, updated_date_utc: #{@updated_date_utc.inspect},"\
+      " currency_code: #{@currency_code.inspect}, prepayment_id: #{@prepayment_id.inspect},"\
+      " currency_rate: #{@currency_rate.inspect}, remaining_credit: #{@remaining_credit.inspect},"\
+      " allocations: #{@allocations.inspect}, payments: #{@payments.inspect}, applied_amount:"\
+      " #{@applied_amount.inspect}, has_attachments: #{@has_attachments.inspect}, attachments:"\
+      " #{@attachments.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/prepayments.rb

@@ -0,0 +1,113 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Prepayments Model.
+  class Prepayments < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Pagination]
+    attr_accessor :pagination
+
+    # Displays array of warning messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :warnings
+
+    # Displays array of warning messages from the API
+    # @return [Array[Prepayment]]
+    attr_accessor :prepayments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination'] = 'pagination'
+      @_hash['warnings'] = 'Warnings'
+      @_hash['prepayments'] = 'Prepayments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination
+        warnings
+        prepayments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pagination: SKIP, warnings: SKIP, prepayments: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @pagination = pagination unless pagination == SKIP
+      @warnings = warnings unless warnings == SKIP
+      @prepayments = prepayments unless prepayments == SKIP
+      @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.
+      pagination = Pagination.from_hash(hash['pagination']) if hash['pagination']
+      # Parameter is an array, so we need to iterate through it
+      warnings = nil
+      unless hash['Warnings'].nil?
+        warnings = []
+        hash['Warnings'].each do |structure|
+          warnings << (ValidationError.from_hash(structure) if structure)
+        end
+      end
+
+      warnings = SKIP unless hash.key?('Warnings')
+      # Parameter is an array, so we need to iterate through it
+      prepayments = nil
+      unless hash['Prepayments'].nil?
+        prepayments = []
+        hash['Prepayments'].each do |structure|
+          prepayments << (Prepayment.from_hash(structure) if structure)
+        end
+      end
+
+      prepayments = SKIP unless hash.key?('Prepayments')
+
+      # 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.
+      Prepayments.new(pagination: pagination,
+                      warnings: warnings,
+                      prepayments: prepayments,
+                      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} pagination: #{@pagination}, warnings: #{@warnings}, prepayments:"\
+      " #{@prepayments}, 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} pagination: #{@pagination.inspect}, warnings: #{@warnings.inspect},"\
+      " prepayments: #{@prepayments.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end