xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/manual_journal.rb

@@ -0,0 +1,255 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # ManualJournal Model.
+  class ManualJournal < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Description of journal being posted
+    # @return [String]
+    attr_accessor :narration
+
+    # See JournalLines
+    # @return [Array[ManualJournalLine]]
+    attr_accessor :journal_lines
+
+    # Date journal was posted – YYYY-MM-DD
+    # @return [String]
+    attr_accessor :date
+
+    # 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 Manual Journal Status Codes
+    # @return [Status15]
+    attr_accessor :status
+
+    # Url link to a source document – shown as “Go to [appName]” in the Xero app
+    # @return [String]
+    attr_accessor :url
+
+    # Boolean – default is true if not specified
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_on_cash_basis_reports
+
+    # Boolean to indicate if a manual journal has an attachment
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_attachments
+
+    # Last modified date UTC format
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # The Xero identifier for a Manual Journal
+    # @return [UUID | String]
+    attr_accessor :manual_journal_id
+
+    # A string to indicate if a invoice status
+    # @return [String]
+    attr_accessor :status_attribute_string
+
+    # Displays array of warning messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :warnings
+
+    # Displays array of validation error messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :validation_errors
+
+    # Displays array of attachments from the API
+    # @return [Array[Attachment]]
+    attr_accessor :attachments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['narration'] = 'Narration'
+      @_hash['journal_lines'] = 'JournalLines'
+      @_hash['date'] = 'Date'
+      @_hash['line_amount_types'] = 'LineAmountTypes'
+      @_hash['status'] = 'Status'
+      @_hash['url'] = 'Url'
+      @_hash['show_on_cash_basis_reports'] = 'ShowOnCashBasisReports'
+      @_hash['has_attachments'] = 'HasAttachments'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['manual_journal_id'] = 'ManualJournalID'
+      @_hash['status_attribute_string'] = 'StatusAttributeString'
+      @_hash['warnings'] = 'Warnings'
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash['attachments'] = 'Attachments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        journal_lines
+        date
+        line_amount_types
+        status
+        url
+        show_on_cash_basis_reports
+        has_attachments
+        updated_date_utc
+        manual_journal_id
+        status_attribute_string
+        warnings
+        validation_errors
+        attachments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(narration:, journal_lines: SKIP, date: SKIP,
+                   line_amount_types: SKIP, status: SKIP, url: SKIP,
+                   show_on_cash_basis_reports: SKIP, has_attachments: false,
+                   updated_date_utc: SKIP, manual_journal_id: SKIP,
+                   status_attribute_string: SKIP, warnings: SKIP,
+                   validation_errors: SKIP, attachments: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @narration = narration
+      @journal_lines = journal_lines unless journal_lines == SKIP
+      @date = date unless date == SKIP
+      @line_amount_types = line_amount_types unless line_amount_types == SKIP
+      @status = status unless status == SKIP
+      @url = url unless url == SKIP
+      unless show_on_cash_basis_reports == SKIP
+        @show_on_cash_basis_reports =
+          show_on_cash_basis_reports
+      end
+      @has_attachments = has_attachments unless has_attachments == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @manual_journal_id = manual_journal_id unless manual_journal_id == SKIP
+      @status_attribute_string = status_attribute_string unless status_attribute_string == SKIP
+      @warnings = warnings unless warnings == SKIP
+      @validation_errors = validation_errors unless validation_errors == 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.
+      narration = hash.key?('Narration') ? hash['Narration'] : nil
+      # Parameter is an array, so we need to iterate through it
+      journal_lines = nil
+      unless hash['JournalLines'].nil?
+        journal_lines = []
+        hash['JournalLines'].each do |structure|
+          journal_lines << (ManualJournalLine.from_hash(structure) if structure)
+        end
+      end
+
+      journal_lines = SKIP unless hash.key?('JournalLines')
+      date = hash.key?('Date') ? hash['Date'] : SKIP
+      line_amount_types =
+        hash.key?('LineAmountTypes') ? hash['LineAmountTypes'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      url = hash.key?('Url') ? hash['Url'] : SKIP
+      show_on_cash_basis_reports =
+        hash.key?('ShowOnCashBasisReports') ? hash['ShowOnCashBasisReports'] : SKIP
+      has_attachments = hash['HasAttachments'] ||= false
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      manual_journal_id =
+        hash.key?('ManualJournalID') ? hash['ManualJournalID'] : SKIP
+      status_attribute_string =
+        hash.key?('StatusAttributeString') ? hash['StatusAttributeString'] : SKIP
+      # 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
+      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')
+      # 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.
+      ManualJournal.new(narration: narration,
+                        journal_lines: journal_lines,
+                        date: date,
+                        line_amount_types: line_amount_types,
+                        status: status,
+                        url: url,
+                        show_on_cash_basis_reports: show_on_cash_basis_reports,
+                        has_attachments: has_attachments,
+                        updated_date_utc: updated_date_utc,
+                        manual_journal_id: manual_journal_id,
+                        status_attribute_string: status_attribute_string,
+                        warnings: warnings,
+                        validation_errors: validation_errors,
+                        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} narration: #{@narration}, journal_lines: #{@journal_lines}, date: #{@date},"\
+      " line_amount_types: #{@line_amount_types}, status: #{@status}, url: #{@url},"\
+      " show_on_cash_basis_reports: #{@show_on_cash_basis_reports}, has_attachments:"\
+      " #{@has_attachments}, updated_date_utc: #{@updated_date_utc}, manual_journal_id:"\
+      " #{@manual_journal_id}, status_attribute_string: #{@status_attribute_string}, warnings:"\
+      " #{@warnings}, validation_errors: #{@validation_errors}, 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} narration: #{@narration.inspect}, journal_lines: #{@journal_lines.inspect},"\
+      " date: #{@date.inspect}, line_amount_types: #{@line_amount_types.inspect}, status:"\
+      " #{@status.inspect}, url: #{@url.inspect}, show_on_cash_basis_reports:"\
+      " #{@show_on_cash_basis_reports.inspect}, has_attachments: #{@has_attachments.inspect},"\
+      " updated_date_utc: #{@updated_date_utc.inspect}, manual_journal_id:"\
+      " #{@manual_journal_id.inspect}, status_attribute_string:"\
+      " #{@status_attribute_string.inspect}, warnings: #{@warnings.inspect}, validation_errors:"\
+      " #{@validation_errors.inspect}, attachments: #{@attachments.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/manual_journal_line.rb

@@ -0,0 +1,156 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # ManualJournalLine Model.
+  class ManualJournalLine < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # total for line. Debits are positive, credits are negative value
+    # @return [Float]
+    attr_accessor :line_amount
+
+    # See Accounts
+    # @return [String]
+    attr_accessor :account_code
+
+    # See Accounts
+    # @return [UUID | String]
+    attr_accessor :account_id
+
+    # Description for journal line
+    # @return [String]
+    attr_accessor :description
+
+    # The tax type from TaxRates
+    # @return [String]
+    attr_accessor :tax_type
+
+    # Optional Tracking Category – see Tracking. Any JournalLine can have a
+    # maximum of 2 <TrackingCategory> elements.
+    # @return [Array[TrackingCategory]]
+    attr_accessor :tracking
+
+    # The calculated tax amount based on the TaxType and LineAmount
+    # @return [Float]
+    attr_accessor :tax_amount
+
+    # is the line blank
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_blank
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_amount'] = 'LineAmount'
+      @_hash['account_code'] = 'AccountCode'
+      @_hash['account_id'] = 'AccountID'
+      @_hash['description'] = 'Description'
+      @_hash['tax_type'] = 'TaxType'
+      @_hash['tracking'] = 'Tracking'
+      @_hash['tax_amount'] = 'TaxAmount'
+      @_hash['is_blank'] = 'IsBlank'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line_amount
+        account_code
+        account_id
+        description
+        tax_type
+        tracking
+        tax_amount
+        is_blank
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_amount: SKIP, account_code: SKIP, account_id: SKIP,
+                   description: SKIP, tax_type: SKIP, tracking: SKIP,
+                   tax_amount: SKIP, is_blank: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @line_amount = line_amount unless line_amount == SKIP
+      @account_code = account_code unless account_code == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @description = description unless description == SKIP
+      @tax_type = tax_type unless tax_type == SKIP
+      @tracking = tracking unless tracking == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @is_blank = is_blank unless is_blank == 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.
+      line_amount = hash.key?('LineAmount') ? hash['LineAmount'] : SKIP
+      account_code = hash.key?('AccountCode') ? hash['AccountCode'] : SKIP
+      account_id = hash.key?('AccountID') ? hash['AccountID'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      tax_type = hash.key?('TaxType') ? hash['TaxType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tracking = nil
+      unless hash['Tracking'].nil?
+        tracking = []
+        hash['Tracking'].each do |structure|
+          tracking << (TrackingCategory.from_hash(structure) if structure)
+        end
+      end
+
+      tracking = SKIP unless hash.key?('Tracking')
+      tax_amount = hash.key?('TaxAmount') ? hash['TaxAmount'] : SKIP
+      is_blank = hash.key?('IsBlank') ? hash['IsBlank'] : 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.
+      ManualJournalLine.new(line_amount: line_amount,
+                            account_code: account_code,
+                            account_id: account_id,
+                            description: description,
+                            tax_type: tax_type,
+                            tracking: tracking,
+                            tax_amount: tax_amount,
+                            is_blank: is_blank,
+                            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} line_amount: #{@line_amount}, account_code: #{@account_code}, account_id:"\
+      " #{@account_id}, description: #{@description}, tax_type: #{@tax_type}, tracking:"\
+      " #{@tracking}, tax_amount: #{@tax_amount}, is_blank: #{@is_blank}, 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} line_amount: #{@line_amount.inspect}, account_code:"\
+      " #{@account_code.inspect}, account_id: #{@account_id.inspect}, description:"\
+      " #{@description.inspect}, tax_type: #{@tax_type.inspect}, tracking: #{@tracking.inspect},"\
+      " tax_amount: #{@tax_amount.inspect}, is_blank: #{@is_blank.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/manual_journals.rb

@@ -0,0 +1,114 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # ManualJournals Model.
+  class ManualJournals < 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[ManualJournal]]
+    attr_accessor :manual_journals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination'] = 'pagination'
+      @_hash['warnings'] = 'Warnings'
+      @_hash['manual_journals'] = 'ManualJournals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination
+        warnings
+        manual_journals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pagination: SKIP, warnings: SKIP, manual_journals: 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
+      @manual_journals = manual_journals unless manual_journals == 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
+      manual_journals = nil
+      unless hash['ManualJournals'].nil?
+        manual_journals = []
+        hash['ManualJournals'].each do |structure|
+          manual_journals << (ManualJournal.from_hash(structure) if structure)
+        end
+      end
+
+      manual_journals = SKIP unless hash.key?('ManualJournals')
+
+      # 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.
+      ManualJournals.new(pagination: pagination,
+                         warnings: warnings,
+                         manual_journals: manual_journals,
+                         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}, manual_journals:"\
+      " #{@manual_journals}, 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},"\
+      " manual_journals: #{@manual_journals.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/mclass.rb

@@ -0,0 +1,48 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Account Class Types
+  class Class
+    MCLASS = [
+      # TODO: Write general description for ASSET
+      ASSET = 'ASSET'.freeze,
+
+      # TODO: Write general description for EQUITY
+      EQUITY = 'EQUITY'.freeze,
+
+      # TODO: Write general description for EXPENSE
+      EXPENSE = 'EXPENSE'.freeze,
+
+      # TODO: Write general description for LIABILITY
+      LIABILITY = 'LIABILITY'.freeze,
+
+      # TODO: Write general description for REVENUE
+      REVENUE = 'REVENUE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MCLASS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ASSET)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'asset' then ASSET
+      when 'equity' then EQUITY
+      when 'expense' then EXPENSE
+      when 'liability' then LIABILITY
+      when 'revenue' then REVENUE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/oauth_provider_error.rb

@@ -0,0 +1,62 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # OAuth 2 Authorization error codes
+  class OauthProviderError
+    OAUTH_PROVIDER_ERROR = [
+      # The request is missing a required parameter, includes an unsupported
+      # parameter value (other than grant type), repeats a parameter, includes
+      # multiple credentials, utilizes more than one mechanism for
+      # authenticating the client, or is otherwise malformed.
+      INVALID_REQUEST = 'invalid_request'.freeze,
+
+      # Client authentication failed (e.g., unknown client, no client
+      # authentication included, or unsupported authentication method).
+      INVALID_CLIENT = 'invalid_client'.freeze,
+
+      # The provided authorization grant (e.g., authorization code, resource
+      # owner credentials) or refresh token is invalid, expired, revoked, does
+      # not match the redirection URI used in the authorization request, or was
+      # issued to another client.
+      INVALID_GRANT = 'invalid_grant'.freeze,
+
+      # The authenticated client is not authorized to use this authorization
+      # grant type.
+      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
+
+      # The authorization grant type is not supported by the authorization
+      # server.
+      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
+
+      # The requested scope is invalid, unknown, malformed, or exceeds the scope
+      # granted by the resource owner.
+      INVALID_SCOPE = 'invalid_scope'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OAUTH_PROVIDER_ERROR.include?(value)
+    end
+
+    def self.from_value(value, default_value = INVALID_REQUEST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'invalid_request' then INVALID_REQUEST
+      when 'invalid_client' then INVALID_CLIENT
+      when 'invalid_grant' then INVALID_GRANT
+      when 'unauthorized_client' then UNAUTHORIZED_CLIENT
+      when 'unsupported_grant_type' then UNSUPPORTED_GRANT_TYPE
+      when 'invalid_scope' then INVALID_SCOPE
+      else
+        default_value
+      end
+    end
+  end
+end