xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/depreciation_method.rb

@@ -0,0 +1,52 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The method of depreciation applied to this asset. See Depreciation Methods
+  class DepreciationMethod
+    DEPRECIATION_METHOD = [
+      # TODO: Write general description for NODEPRECIATION
+      NODEPRECIATION = 'NoDepreciation'.freeze,
+
+      # TODO: Write general description for STRAIGHTLINE
+      STRAIGHTLINE = 'StraightLine'.freeze,
+
+      # TODO: Write general description for DIMINISHINGVALUE100
+      DIMINISHINGVALUE100 = 'DiminishingValue100'.freeze,
+
+      # TODO: Write general description for DIMINISHINGVALUE150
+      DIMINISHINGVALUE150 = 'DiminishingValue150'.freeze,
+
+      # TODO: Write general description for DIMINISHINGVALUE200
+      DIMINISHINGVALUE200 = 'DiminishingValue200'.freeze,
+
+      # TODO: Write general description for FULLDEPRECIATION
+      FULLDEPRECIATION = 'FullDepreciation'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DEPRECIATION_METHOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = NODEPRECIATION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'nodepreciation' then NODEPRECIATION
+      when 'straightline' then STRAIGHTLINE
+      when 'diminishingvalue100' then DIMINISHINGVALUE100
+      when 'diminishingvalue150' then DIMINISHINGVALUE150
+      when 'diminishingvalue200' then DIMINISHINGVALUE200
+      when 'fulldepreciation' then FULLDEPRECIATION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/due_date_type.rb

@@ -0,0 +1,52 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # the payment terms
+  class DueDateType
+    DUE_DATE_TYPE = [
+      # TODO: Write general description for DAYSAFTERBILLDATE
+      DAYSAFTERBILLDATE = 'DAYSAFTERBILLDATE'.freeze,
+
+      # TODO: Write general description for DAYSAFTERBILLMONTH
+      DAYSAFTERBILLMONTH = 'DAYSAFTERBILLMONTH'.freeze,
+
+      # TODO: Write general description for DAYSAFTERINVOICEDATE
+      DAYSAFTERINVOICEDATE = 'DAYSAFTERINVOICEDATE'.freeze,
+
+      # TODO: Write general description for DAYSAFTERINVOICEMONTH
+      DAYSAFTERINVOICEMONTH = 'DAYSAFTERINVOICEMONTH'.freeze,
+
+      # TODO: Write general description for OFCURRENTMONTH
+      OFCURRENTMONTH = 'OFCURRENTMONTH'.freeze,
+
+      # TODO: Write general description for OFFOLLOWINGMONTH
+      OFFOLLOWINGMONTH = 'OFFOLLOWINGMONTH'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DUE_DATE_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = DAYSAFTERBILLDATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'daysafterbilldate' then DAYSAFTERBILLDATE
+      when 'daysafterbillmonth' then DAYSAFTERBILLMONTH
+      when 'daysafterinvoicedate' then DAYSAFTERINVOICEDATE
+      when 'daysafterinvoicemonth' then DAYSAFTERINVOICEMONTH
+      when 'ofcurrentmonth' then OFCURRENTMONTH
+      when 'offollowingmonth' then OFFOLLOWINGMONTH
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/edition.rb

@@ -0,0 +1,38 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # BUSINESS or PARTNER. Partner edition organisations are sold exclusively
+  # through accounting partners and have restricted functionality (e.g. no
+  # access to invoicing)
+  class Edition
+    EDITION = [
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'BUSINESS'.freeze,
+
+      # TODO: Write general description for PARTNER
+      PARTNER = 'PARTNER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EDITION.include?(value)
+    end
+
+    def self.from_value(value, default_value = BUSINESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'business' then BUSINESS
+      when 'partner' then PARTNER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/element.rb

@@ -0,0 +1,160 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Element Model.
+  class Element < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of Validation Error message
+    # @return [Array[ValidationError]]
+    attr_accessor :validation_errors
+
+    # Unique ID for batch payment object with validation error
+    # @return [UUID | String]
+    attr_accessor :batch_payment_id
+
+    # Unique ID for batch payment object with validation error
+    # @return [UUID | String]
+    attr_accessor :bank_transaction_id
+
+    # Unique ID for batch payment object with validation error
+    # @return [UUID | String]
+    attr_accessor :credit_note_id
+
+    # Unique ID for batch payment object with validation error
+    # @return [UUID | String]
+    attr_accessor :contact_id
+
+    # Unique ID for batch payment object with validation error
+    # @return [UUID | String]
+    attr_accessor :invoice_id
+
+    # Unique ID for batch payment object with validation error
+    # @return [UUID | String]
+    attr_accessor :item_id
+
+    # Unique ID for batch payment object with validation error
+    # @return [UUID | String]
+    attr_accessor :purchase_order_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash['batch_payment_id'] = 'BatchPaymentID'
+      @_hash['bank_transaction_id'] = 'BankTransactionID'
+      @_hash['credit_note_id'] = 'CreditNoteID'
+      @_hash['contact_id'] = 'ContactID'
+      @_hash['invoice_id'] = 'InvoiceID'
+      @_hash['item_id'] = 'ItemID'
+      @_hash['purchase_order_id'] = 'PurchaseOrderID'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        validation_errors
+        batch_payment_id
+        bank_transaction_id
+        credit_note_id
+        contact_id
+        invoice_id
+        item_id
+        purchase_order_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(validation_errors: SKIP, batch_payment_id: SKIP,
+                   bank_transaction_id: SKIP, credit_note_id: SKIP,
+                   contact_id: SKIP, invoice_id: SKIP, item_id: SKIP,
+                   purchase_order_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @validation_errors = validation_errors unless validation_errors == SKIP
+      @batch_payment_id = batch_payment_id unless batch_payment_id == SKIP
+      @bank_transaction_id = bank_transaction_id unless bank_transaction_id == SKIP
+      @credit_note_id = credit_note_id unless credit_note_id == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @item_id = item_id unless item_id == SKIP
+      @purchase_order_id = purchase_order_id unless purchase_order_id == 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.
+      # Parameter is an array, so we need to iterate through it
+      validation_errors = nil
+      unless hash['ValidationErrors'].nil?
+        validation_errors = []
+        hash['ValidationErrors'].each do |structure|
+          validation_errors << (ValidationError.from_hash(structure) if structure)
+        end
+      end
+
+      validation_errors = SKIP unless hash.key?('ValidationErrors')
+      batch_payment_id =
+        hash.key?('BatchPaymentID') ? hash['BatchPaymentID'] : SKIP
+      bank_transaction_id =
+        hash.key?('BankTransactionID') ? hash['BankTransactionID'] : SKIP
+      credit_note_id = hash.key?('CreditNoteID') ? hash['CreditNoteID'] : SKIP
+      contact_id = hash.key?('ContactID') ? hash['ContactID'] : SKIP
+      invoice_id = hash.key?('InvoiceID') ? hash['InvoiceID'] : SKIP
+      item_id = hash.key?('ItemID') ? hash['ItemID'] : SKIP
+      purchase_order_id =
+        hash.key?('PurchaseOrderID') ? hash['PurchaseOrderID'] : SKIP
+
+      # 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.
+      Element.new(validation_errors: validation_errors,
+                  batch_payment_id: batch_payment_id,
+                  bank_transaction_id: bank_transaction_id,
+                  credit_note_id: credit_note_id,
+                  contact_id: contact_id,
+                  invoice_id: invoice_id,
+                  item_id: item_id,
+                  purchase_order_id: purchase_order_id,
+                  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} validation_errors: #{@validation_errors}, batch_payment_id:"\
+      " #{@batch_payment_id}, bank_transaction_id: #{@bank_transaction_id}, credit_note_id:"\
+      " #{@credit_note_id}, contact_id: #{@contact_id}, invoice_id: #{@invoice_id}, item_id:"\
+      " #{@item_id}, purchase_order_id: #{@purchase_order_id}, 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} validation_errors: #{@validation_errors.inspect}, batch_payment_id:"\
+      " #{@batch_payment_id.inspect}, bank_transaction_id: #{@bank_transaction_id.inspect},"\
+      " credit_note_id: #{@credit_note_id.inspect}, contact_id: #{@contact_id.inspect},"\
+      " invoice_id: #{@invoice_id.inspect}, item_id: #{@item_id.inspect}, purchase_order_id:"\
+      " #{@purchase_order_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/employee.rb

@@ -0,0 +1,160 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Employee Model.
+  class Employee < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Xero identifier for an employee e.g.
+    # 297c2dc5-cc47-4afd-8ec8-74990b8761e9
+    # @return [UUID | String]
+    attr_accessor :employee_id
+
+    # Current status of an employee – see contact status types
+    # @return [Status11]
+    attr_accessor :status
+
+    # First name of an employee (max length = 255)
+    # @return [String]
+    attr_accessor :first_name
+
+    # Last name of an employee (max length = 255)
+    # @return [String]
+    attr_accessor :last_name
+
+    # Last name of an employee (max length = 255)
+    # @return [ExternalLink]
+    attr_accessor :external_link
+
+    # Last name of an employee (max length = 255)
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # A string to indicate if a invoice status
+    # @return [String]
+    attr_accessor :status_attribute_string
+
+    # Displays array of validation error messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :validation_errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['employee_id'] = 'EmployeeID'
+      @_hash['status'] = 'Status'
+      @_hash['first_name'] = 'FirstName'
+      @_hash['last_name'] = 'LastName'
+      @_hash['external_link'] = 'ExternalLink'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['status_attribute_string'] = 'StatusAttributeString'
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        employee_id
+        status
+        first_name
+        last_name
+        external_link
+        updated_date_utc
+        status_attribute_string
+        validation_errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(employee_id: SKIP, status: SKIP, first_name: SKIP,
+                   last_name: SKIP, external_link: SKIP, updated_date_utc: SKIP,
+                   status_attribute_string: SKIP, validation_errors: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @employee_id = employee_id unless employee_id == SKIP
+      @status = status unless status == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @external_link = external_link unless external_link == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @status_attribute_string = status_attribute_string unless status_attribute_string == SKIP
+      @validation_errors = validation_errors unless validation_errors == 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.
+      employee_id = hash.key?('EmployeeID') ? hash['EmployeeID'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      first_name = hash.key?('FirstName') ? hash['FirstName'] : SKIP
+      last_name = hash.key?('LastName') ? hash['LastName'] : SKIP
+      external_link = ExternalLink.from_hash(hash['ExternalLink']) if hash['ExternalLink']
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      status_attribute_string =
+        hash.key?('StatusAttributeString') ? hash['StatusAttributeString'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      validation_errors = nil
+      unless hash['ValidationErrors'].nil?
+        validation_errors = []
+        hash['ValidationErrors'].each do |structure|
+          validation_errors << (ValidationError.from_hash(structure) if structure)
+        end
+      end
+
+      validation_errors = SKIP unless hash.key?('ValidationErrors')
+
+      # 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.
+      Employee.new(employee_id: employee_id,
+                   status: status,
+                   first_name: first_name,
+                   last_name: last_name,
+                   external_link: external_link,
+                   updated_date_utc: updated_date_utc,
+                   status_attribute_string: status_attribute_string,
+                   validation_errors: validation_errors,
+                   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} employee_id: #{@employee_id}, status: #{@status}, first_name:"\
+      " #{@first_name}, last_name: #{@last_name}, external_link: #{@external_link},"\
+      " updated_date_utc: #{@updated_date_utc}, status_attribute_string:"\
+      " #{@status_attribute_string}, validation_errors: #{@validation_errors},"\
+      " 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} employee_id: #{@employee_id.inspect}, status: #{@status.inspect},"\
+      " first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect}, external_link:"\
+      " #{@external_link.inspect}, updated_date_utc: #{@updated_date_utc.inspect},"\
+      " status_attribute_string: #{@status_attribute_string.inspect}, validation_errors:"\
+      " #{@validation_errors.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/employees.rb

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

data/lib/xero_ap_is/models/end_balance.rb

@@ -0,0 +1,89 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The StartBalance plus all the Statement Line Amounts should be equal to the
+  # EndBalance Amount.
+  class EndBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :amount
+
+    # If the statement balances are credit or debit, the CreditDebitIndicator
+    # should be specified from the perspective of the Customer.
+    # @return [CreditDebitIndicator]
+    attr_accessor :credit_debit_indicator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['credit_debit_indicator'] = 'creditDebitIndicator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        credit_debit_indicator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, credit_debit_indicator: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount unless amount == SKIP
+      @credit_debit_indicator = credit_debit_indicator unless credit_debit_indicator == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      credit_debit_indicator =
+        hash.key?('creditDebitIndicator') ? hash['creditDebitIndicator'] : SKIP
+
+      # 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.
+      EndBalance.new(amount: amount,
+                     credit_debit_indicator: credit_debit_indicator,
+                     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} amount: #{@amount}, credit_debit_indicator: #{@credit_debit_indicator},"\
+      " 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} amount: #{@amount.inspect}, credit_debit_indicator:"\
+      " #{@credit_debit_indicator.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end