xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/type2.rb

@@ -0,0 +1,48 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The type of the jurisdiction
+  class Type2
+    TYPE2 = [
+      # TODO: Write general description for ENUM_SYSGSTUSCOUNTRY
+      ENUM_SYSGSTUSCOUNTRY = 'SYSGST/USCOUNTRY'.freeze,
+
+      # TODO: Write general description for ENUM_SYSGSTUSSTATE
+      ENUM_SYSGSTUSSTATE = 'SYSGST/USSTATE'.freeze,
+
+      # TODO: Write general description for ENUM_SYSGSTUSCOUNTY
+      ENUM_SYSGSTUSCOUNTY = 'SYSGST/USCOUNTY'.freeze,
+
+      # TODO: Write general description for ENUM_SYSGSTUSCITY
+      ENUM_SYSGSTUSCITY = 'SYSGST/USCITY'.freeze,
+
+      # TODO: Write general description for ENUM_SYSGSTUSSPECIAL
+      ENUM_SYSGSTUSSPECIAL = 'SYSGST/USSPECIAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_SYSGSTUSCOUNTRY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_sysgstuscountry' then ENUM_SYSGSTUSCOUNTRY
+      when 'enum_sysgstusstate' then ENUM_SYSGSTUSSTATE
+      when 'enum_sysgstuscounty' then ENUM_SYSGSTUSCOUNTY
+      when 'enum_sysgstuscity' then ENUM_SYSGSTUSCITY
+      when 'enum_sysgstusspecial' then ENUM_SYSGSTUSSPECIAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/type3.rb

@@ -0,0 +1,60 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Invoice Types
+  class Type3
+    TYPE3 = [
+      # TODO: Write general description for ACCPAY
+      ACCPAY = 'ACCPAY'.freeze,
+
+      # TODO: Write general description for ACCPAYCREDIT
+      ACCPAYCREDIT = 'ACCPAYCREDIT'.freeze,
+
+      # TODO: Write general description for APOVERPAYMENT
+      APOVERPAYMENT = 'APOVERPAYMENT'.freeze,
+
+      # TODO: Write general description for APPREPAYMENT
+      APPREPAYMENT = 'APPREPAYMENT'.freeze,
+
+      # TODO: Write general description for ACCREC
+      ACCREC = 'ACCREC'.freeze,
+
+      # TODO: Write general description for ACCRECCREDIT
+      ACCRECCREDIT = 'ACCRECCREDIT'.freeze,
+
+      # TODO: Write general description for AROVERPAYMENT
+      AROVERPAYMENT = 'AROVERPAYMENT'.freeze,
+
+      # TODO: Write general description for ARPREPAYMENT
+      ARPREPAYMENT = 'ARPREPAYMENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE3.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCPAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accpay' then ACCPAY
+      when 'accpaycredit' then ACCPAYCREDIT
+      when 'apoverpayment' then APOVERPAYMENT
+      when 'apprepayment' then APPREPAYMENT
+      when 'accrec' then ACCREC
+      when 'accreccredit' then ACCRECCREDIT
+      when 'aroverpayment' then AROVERPAYMENT
+      when 'arprepayment' then ARPREPAYMENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/type4.rb

@@ -0,0 +1,44 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Prepayment Types
+  class Type4
+    TYPE4 = [
+      # TODO: Write general description for RECEIVEPREPAYMENT
+      RECEIVEPREPAYMENT = 'RECEIVE-PREPAYMENT'.freeze,
+
+      # TODO: Write general description for SPENDPREPAYMENT
+      SPENDPREPAYMENT = 'SPEND-PREPAYMENT'.freeze,
+
+      # TODO: Write general description for ARPREPAYMENT
+      ARPREPAYMENT = 'ARPREPAYMENT'.freeze,
+
+      # TODO: Write general description for APPREPAYMENT
+      APPREPAYMENT = 'APPREPAYMENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE4.include?(value)
+    end
+
+    def self.from_value(value, default_value = RECEIVEPREPAYMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'receiveprepayment' then RECEIVEPREPAYMENT
+      when 'spendprepayment' then SPENDPREPAYMENT
+      when 'arprepayment' then ARPREPAYMENT
+      when 'apprepayment' then APPREPAYMENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/type5.rb

@@ -0,0 +1,40 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Overpayment Types
+  class Type5
+    TYPE5 = [
+      # TODO: Write general description for RECEIVEOVERPAYMENT
+      RECEIVEOVERPAYMENT = 'RECEIVE-OVERPAYMENT'.freeze,
+
+      # TODO: Write general description for SPENDOVERPAYMENT
+      SPENDOVERPAYMENT = 'SPEND-OVERPAYMENT'.freeze,
+
+      # TODO: Write general description for AROVERPAYMENT
+      AROVERPAYMENT = 'AROVERPAYMENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE5.include?(value)
+    end
+
+    def self.from_value(value, default_value = RECEIVEOVERPAYMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'receiveoverpayment' then RECEIVEOVERPAYMENT
+      when 'spendoverpayment' then SPENDOVERPAYMENT
+      when 'aroverpayment' then AROVERPAYMENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/type6.rb

@@ -0,0 +1,36 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Credit Note Types
+  class Type6
+    TYPE6 = [
+      # TODO: Write general description for ACCPAYCREDIT
+      ACCPAYCREDIT = 'ACCPAYCREDIT'.freeze,
+
+      # TODO: Write general description for ACCRECCREDIT
+      ACCRECCREDIT = 'ACCRECCREDIT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE6.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCPAYCREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accpaycredit' then ACCPAYCREDIT
+      when 'accreccredit' then ACCRECCREDIT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/type7.rb

@@ -0,0 +1,37 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # PAYBATCH for bill payments or RECBATCH for sales invoice payments
+  # (read-only)
+  class Type7
+    TYPE7 = [
+      # TODO: Write general description for PAYBATCH
+      PAYBATCH = 'PAYBATCH'.freeze,
+
+      # TODO: Write general description for RECBATCH
+      RECBATCH = 'RECBATCH'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE7.include?(value)
+    end
+
+    def self.from_value(value, default_value = PAYBATCH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'paybatch' then PAYBATCH
+      when 'recbatch' then RECBATCH
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/type8.rb

@@ -0,0 +1,36 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Type of Budget. OVERALL or TRACKING
+  class Type8
+    TYPE8 = [
+      # TODO: Write general description for OVERALL
+      OVERALL = 'OVERALL'.freeze,
+
+      # TODO: Write general description for TRACKING
+      TRACKING = 'TRACKING'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE8.include?(value)
+    end
+
+    def self.from_value(value, default_value = OVERALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'overall' then OVERALL
+      when 'tracking' then TRACKING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/type9.rb

@@ -0,0 +1,26 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # This will always be BILLABLEEXPENSE. More types may be added in future.
+  class Type9
+    TYPE9 = [
+      # TODO: Write general description for BILLABLEEXPENSE
+      BILLABLEEXPENSE = 'BILLABLEEXPENSE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE9.include?(value)
+    end
+
+    def self.from_value(value, default_value = BILLABLEEXPENSE)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/xero_ap_is/models/unit.rb

@@ -0,0 +1,36 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # One of the following - WEEKLY or MONTHLY
+  class Unit
+    UNIT = [
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      UNIT.include?(value)
+    end
+
+    def self.from_value(value, default_value = WEEKLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'weekly' then WEEKLY
+      when 'monthly' then MONTHLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/user.rb

@@ -0,0 +1,139 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # User Model.
+  class User < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Xero identifier
+    # @return [UUID | String]
+    attr_accessor :user_id
+
+    # Email address of user
+    # @return [String]
+    attr_accessor :email_address
+
+    # First name of user
+    # @return [String]
+    attr_accessor :first_name
+
+    # Last name of user
+    # @return [String]
+    attr_accessor :last_name
+
+    # Timestamp of last change to user
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # Boolean to indicate if user is the subscriber
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_subscriber
+
+    # User role that defines permissions in Xero and via API (READONLY,
+    # INVOICEONLY, STANDARD, FINANCIALADVISER, etc)
+    # @return [OrganisationRole]
+    attr_accessor :organisation_role
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_id'] = 'UserID'
+      @_hash['email_address'] = 'EmailAddress'
+      @_hash['first_name'] = 'FirstName'
+      @_hash['last_name'] = 'LastName'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['is_subscriber'] = 'IsSubscriber'
+      @_hash['organisation_role'] = 'OrganisationRole'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        user_id
+        email_address
+        first_name
+        last_name
+        updated_date_utc
+        is_subscriber
+        organisation_role
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user_id: SKIP, email_address: SKIP, first_name: SKIP,
+                   last_name: SKIP, updated_date_utc: SKIP, is_subscriber: SKIP,
+                   organisation_role: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @user_id = user_id unless user_id == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @is_subscriber = is_subscriber unless is_subscriber == SKIP
+      @organisation_role = organisation_role unless organisation_role == 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.
+      user_id = hash.key?('UserID') ? hash['UserID'] : SKIP
+      email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
+      first_name = hash.key?('FirstName') ? hash['FirstName'] : SKIP
+      last_name = hash.key?('LastName') ? hash['LastName'] : SKIP
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      is_subscriber = hash.key?('IsSubscriber') ? hash['IsSubscriber'] : SKIP
+      organisation_role =
+        hash.key?('OrganisationRole') ? hash['OrganisationRole'] : 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.
+      User.new(user_id: user_id,
+               email_address: email_address,
+               first_name: first_name,
+               last_name: last_name,
+               updated_date_utc: updated_date_utc,
+               is_subscriber: is_subscriber,
+               organisation_role: organisation_role,
+               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} user_id: #{@user_id}, email_address: #{@email_address}, first_name:"\
+      " #{@first_name}, last_name: #{@last_name}, updated_date_utc: #{@updated_date_utc},"\
+      " is_subscriber: #{@is_subscriber}, organisation_role: #{@organisation_role},"\
+      " 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} user_id: #{@user_id.inspect}, email_address: #{@email_address.inspect},"\
+      " first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect}, updated_date_utc:"\
+      " #{@updated_date_utc.inspect}, is_subscriber: #{@is_subscriber.inspect}, organisation_role:"\
+      " #{@organisation_role.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/users.rb

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

data/lib/xero_ap_is/models/validation_error.rb

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