xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/error1.rb

@@ -0,0 +1,138 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Error1 Model.
+  class Error1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of elements of resource validation errors
+    # @return [Array[ResourceValidationErrorsElement]]
+    attr_accessor :resource_validation_errors
+
+    # Array of elements of field validation errors
+    # @return [Array[FieldValidationErrorsElement]]
+    attr_accessor :field_validation_errors
+
+    # The internal type of error, not accessible externally
+    # @return [String]
+    attr_accessor :type
+
+    # Title of the error
+    # @return [String]
+    attr_accessor :title
+
+    # Detail of the error
+    # @return [String]
+    attr_accessor :detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['resource_validation_errors'] = 'resourceValidationErrors'
+      @_hash['field_validation_errors'] = 'fieldValidationErrors'
+      @_hash['type'] = 'type'
+      @_hash['title'] = 'title'
+      @_hash['detail'] = 'detail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        resource_validation_errors
+        field_validation_errors
+        type
+        title
+        detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(resource_validation_errors: SKIP,
+                   field_validation_errors: SKIP, type: SKIP, title: SKIP,
+                   detail: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless resource_validation_errors == SKIP
+        @resource_validation_errors =
+          resource_validation_errors
+      end
+      @field_validation_errors = field_validation_errors unless field_validation_errors == SKIP
+      @type = type unless type == SKIP
+      @title = title unless title == SKIP
+      @detail = detail unless detail == 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
+      resource_validation_errors = nil
+      unless hash['resourceValidationErrors'].nil?
+        resource_validation_errors = []
+        hash['resourceValidationErrors'].each do |structure|
+          resource_validation_errors << (ResourceValidationErrorsElement.from_hash(structure) if structure)
+        end
+      end
+
+      resource_validation_errors = SKIP unless hash.key?('resourceValidationErrors')
+      # Parameter is an array, so we need to iterate through it
+      field_validation_errors = nil
+      unless hash['fieldValidationErrors'].nil?
+        field_validation_errors = []
+        hash['fieldValidationErrors'].each do |structure|
+          field_validation_errors << (FieldValidationErrorsElement.from_hash(structure) if structure)
+        end
+      end
+
+      field_validation_errors = SKIP unless hash.key?('fieldValidationErrors')
+      type = hash.key?('type') ? hash['type'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      detail = hash.key?('detail') ? hash['detail'] : 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.
+      Error1.new(resource_validation_errors: resource_validation_errors,
+                 field_validation_errors: field_validation_errors,
+                 type: type,
+                 title: title,
+                 detail: detail,
+                 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} resource_validation_errors: #{@resource_validation_errors},"\
+      " field_validation_errors: #{@field_validation_errors}, type: #{@type}, title: #{@title},"\
+      " detail: #{@detail}, 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} resource_validation_errors: #{@resource_validation_errors.inspect},"\
+      " field_validation_errors: #{@field_validation_errors.inspect}, type: #{@type.inspect},"\
+      " title: #{@title.inspect}, detail: #{@detail.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/error2.rb

@@ -0,0 +1,106 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # On error, the API consumer will receive an HTTP response with a HTTP Status
+  # Code of 4xx or 5xx and a Content-Type of application/problem+json.
+  class Error2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Human readable high level error description.
+    # @return [String]
+    attr_accessor :title
+
+    # The numeric HTTP Status Code, e.g. 404
+    # @return [Integer]
+    attr_accessor :status
+
+    # Human readable detailed error description.
+    # @return [String]
+    attr_accessor :detail
+
+    # Identifies the type of error.
+    # @return [Type11]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['status'] = 'status'
+      @_hash['detail'] = 'detail'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        title
+        status
+        detail
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(title: SKIP, status: SKIP, detail: SKIP, type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @title = title unless title == SKIP
+      @status = status unless status == SKIP
+      @detail = detail unless detail == SKIP
+      @type = type unless type == 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.
+      title = hash.key?('title') ? hash['title'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      detail = hash.key?('detail') ? hash['detail'] : SKIP
+      type = hash.key?('type') ? hash['type'] : 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.
+      Error2.new(title: title,
+                 status: status,
+                 detail: detail,
+                 type: type,
+                 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} title: #{@title}, status: #{@status}, detail: #{@detail}, type: #{@type},"\
+      " 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} title: #{@title.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, type: #{@type.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/error3.rb

@@ -0,0 +1,85 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Error3 Model.
+  class Error3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Exception message
+    # @return [String]
+    attr_accessor :message
+
+    # Array of Elements of validation Errors
+    # @return [Object]
+    attr_accessor :model_state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['model_state'] = 'modelState'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        message
+        model_state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message: SKIP, model_state: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @message = message unless message == SKIP
+      @model_state = model_state unless model_state == 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.
+      message = hash.key?('message') ? hash['message'] : SKIP
+      model_state = hash.key?('modelState') ? hash['modelState'] : 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.
+      Error3.new(message: message,
+                 model_state: model_state,
+                 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} message: #{@message}, model_state: #{@model_state}, 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} message: #{@message.inspect}, model_state: #{@model_state.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/expense_claim.rb

@@ -0,0 +1,209 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # ExpenseClaim Model.
+  class ExpenseClaim < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Xero generated unique identifier for an expense claim
+    # @return [UUID | String]
+    attr_accessor :expense_claim_id
+
+    # Current status of an expense claim – see status types
+    # @return [Status12]
+    attr_accessor :status
+
+    # See Payments
+    # @return [Array[Payment]]
+    attr_accessor :payments
+
+    # See Payments
+    # @return [User]
+    attr_accessor :user
+
+    # See Payments
+    # @return [Array[Receipt]]
+    attr_accessor :receipts
+
+    # Last modified date UTC format
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # The total of an expense claim being paid
+    # @return [Float]
+    attr_accessor :total
+
+    # The amount due to be paid for an expense claim
+    # @return [Float]
+    attr_accessor :amount_due
+
+    # The amount still to pay for an expense claim
+    # @return [Float]
+    attr_accessor :amount_paid
+
+    # The date when the expense claim is due to be paid YYYY-MM-DD
+    # @return [String]
+    attr_accessor :payment_due_date
+
+    # The date the expense claim will be reported in Xero YYYY-MM-DD
+    # @return [String]
+    attr_accessor :reporting_date
+
+    # The Xero identifier for the Receipt e.g.
+    # e59a2c7f-1306-4078-a0f3-73537afcbba9
+    # @return [UUID | String]
+    attr_accessor :receipt_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['expense_claim_id'] = 'ExpenseClaimID'
+      @_hash['status'] = 'Status'
+      @_hash['payments'] = 'Payments'
+      @_hash['user'] = 'User'
+      @_hash['receipts'] = 'Receipts'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['total'] = 'Total'
+      @_hash['amount_due'] = 'AmountDue'
+      @_hash['amount_paid'] = 'AmountPaid'
+      @_hash['payment_due_date'] = 'PaymentDueDate'
+      @_hash['reporting_date'] = 'ReportingDate'
+      @_hash['receipt_id'] = 'ReceiptID'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expense_claim_id
+        status
+        payments
+        user
+        receipts
+        updated_date_utc
+        total
+        amount_due
+        amount_paid
+        payment_due_date
+        reporting_date
+        receipt_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(expense_claim_id: SKIP, status: SKIP, payments: SKIP,
+                   user: SKIP, receipts: SKIP, updated_date_utc: SKIP,
+                   total: SKIP, amount_due: SKIP, amount_paid: SKIP,
+                   payment_due_date: SKIP, reporting_date: SKIP,
+                   receipt_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @expense_claim_id = expense_claim_id unless expense_claim_id == SKIP
+      @status = status unless status == SKIP
+      @payments = payments unless payments == SKIP
+      @user = user unless user == SKIP
+      @receipts = receipts unless receipts == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @total = total unless total == SKIP
+      @amount_due = amount_due unless amount_due == SKIP
+      @amount_paid = amount_paid unless amount_paid == SKIP
+      @payment_due_date = payment_due_date unless payment_due_date == SKIP
+      @reporting_date = reporting_date unless reporting_date == SKIP
+      @receipt_id = receipt_id unless receipt_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.
+      expense_claim_id =
+        hash.key?('ExpenseClaimID') ? hash['ExpenseClaimID'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      # 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')
+      user = User.from_hash(hash['User']) if hash['User']
+      # Parameter is an array, so we need to iterate through it
+      receipts = nil
+      unless hash['Receipts'].nil?
+        receipts = []
+        hash['Receipts'].each do |structure|
+          receipts << (Receipt.from_hash(structure) if structure)
+        end
+      end
+
+      receipts = SKIP unless hash.key?('Receipts')
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      total = hash.key?('Total') ? hash['Total'] : SKIP
+      amount_due = hash.key?('AmountDue') ? hash['AmountDue'] : SKIP
+      amount_paid = hash.key?('AmountPaid') ? hash['AmountPaid'] : SKIP
+      payment_due_date =
+        hash.key?('PaymentDueDate') ? hash['PaymentDueDate'] : SKIP
+      reporting_date = hash.key?('ReportingDate') ? hash['ReportingDate'] : SKIP
+      receipt_id = hash.key?('ReceiptID') ? hash['ReceiptID'] : 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.
+      ExpenseClaim.new(expense_claim_id: expense_claim_id,
+                       status: status,
+                       payments: payments,
+                       user: user,
+                       receipts: receipts,
+                       updated_date_utc: updated_date_utc,
+                       total: total,
+                       amount_due: amount_due,
+                       amount_paid: amount_paid,
+                       payment_due_date: payment_due_date,
+                       reporting_date: reporting_date,
+                       receipt_id: receipt_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} expense_claim_id: #{@expense_claim_id}, status: #{@status}, payments:"\
+      " #{@payments}, user: #{@user}, receipts: #{@receipts}, updated_date_utc:"\
+      " #{@updated_date_utc}, total: #{@total}, amount_due: #{@amount_due}, amount_paid:"\
+      " #{@amount_paid}, payment_due_date: #{@payment_due_date}, reporting_date:"\
+      " #{@reporting_date}, receipt_id: #{@receipt_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} expense_claim_id: #{@expense_claim_id.inspect}, status: #{@status.inspect},"\
+      " payments: #{@payments.inspect}, user: #{@user.inspect}, receipts: #{@receipts.inspect},"\
+      " updated_date_utc: #{@updated_date_utc.inspect}, total: #{@total.inspect}, amount_due:"\
+      " #{@amount_due.inspect}, amount_paid: #{@amount_paid.inspect}, payment_due_date:"\
+      " #{@payment_due_date.inspect}, reporting_date: #{@reporting_date.inspect}, receipt_id:"\
+      " #{@receipt_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/expense_claims.rb

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