xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/contact_group.rb

@@ -0,0 +1,119 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # ContactGroup Model.
+  class ContactGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Name of the contact group. Required when creating a new contact  group
+    # @return [String]
+    attr_accessor :name
+
+    # The Status of a contact group. To delete a contact group update the status
+    # to DELETED. Only contact groups with a status of ACTIVE are returned on
+    # GETs.
+    # @return [Status1]
+    attr_accessor :status
+
+    # The Xero identifier for an contact group – specified as a string following
+    # the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
+    # @return [UUID | String]
+    attr_accessor :contact_group_id
+
+    # The ContactID and Name of Contacts in a contact group. Returned on GETs
+    # when the ContactGroupID is supplied in the URL.
+    # @return [Array[Contact]]
+    attr_accessor :contacts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'Name'
+      @_hash['status'] = 'Status'
+      @_hash['contact_group_id'] = 'ContactGroupID'
+      @_hash['contacts'] = 'Contacts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        status
+        contact_group_id
+        contacts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, status: SKIP, contact_group_id: SKIP,
+                   contacts: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @status = status unless status == SKIP
+      @contact_group_id = contact_group_id unless contact_group_id == SKIP
+      @contacts = contacts unless contacts == 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.
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      contact_group_id =
+        hash.key?('ContactGroupID') ? hash['ContactGroupID'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      contacts = nil
+      unless hash['Contacts'].nil?
+        contacts = []
+        hash['Contacts'].each do |structure|
+          contacts << (Contact.from_hash(structure) if structure)
+        end
+      end
+
+      contacts = SKIP unless hash.key?('Contacts')
+
+      # 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.
+      ContactGroup.new(name: name,
+                       status: status,
+                       contact_group_id: contact_group_id,
+                       contacts: contacts,
+                       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} name: #{@name}, status: #{@status}, contact_group_id: #{@contact_group_id},"\
+      " contacts: #{@contacts}, 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} name: #{@name.inspect}, status: #{@status.inspect}, contact_group_id:"\
+      " #{@contact_group_id.inspect}, contacts: #{@contacts.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/contact_groups.rb

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

data/lib/xero_ap_is/models/contact_person.rb

@@ -0,0 +1,108 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # ContactPerson Model.
+  class ContactPerson < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # First name of person
+    # @return [String]
+    attr_accessor :first_name
+
+    # Last name of person
+    # @return [String]
+    attr_accessor :last_name
+
+    # Email address of person
+    # @return [String]
+    attr_accessor :email_address
+
+    # boolean to indicate whether contact should be included on emails with
+    # invoices etc.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_in_emails
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_name'] = 'FirstName'
+      @_hash['last_name'] = 'LastName'
+      @_hash['email_address'] = 'EmailAddress'
+      @_hash['include_in_emails'] = 'IncludeInEmails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        email_address
+        include_in_emails
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first_name: SKIP, last_name: SKIP, email_address: SKIP,
+                   include_in_emails: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @include_in_emails = include_in_emails unless include_in_emails == 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.
+      first_name = hash.key?('FirstName') ? hash['FirstName'] : SKIP
+      last_name = hash.key?('LastName') ? hash['LastName'] : SKIP
+      email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
+      include_in_emails =
+        hash.key?('IncludeInEmails') ? hash['IncludeInEmails'] : 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.
+      ContactPerson.new(first_name: first_name,
+                        last_name: last_name,
+                        email_address: email_address,
+                        include_in_emails: include_in_emails,
+                        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} first_name: #{@first_name}, last_name: #{@last_name}, email_address:"\
+      " #{@email_address}, include_in_emails: #{@include_in_emails}, 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} first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect},"\
+      " email_address: #{@email_address.inspect}, include_in_emails:"\
+      " #{@include_in_emails.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/contact_status.rb

@@ -0,0 +1,40 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Current status of a contact – see contact status types
+  class ContactStatus
+    CONTACT_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for ARCHIVED
+      ARCHIVED = 'ARCHIVED'.freeze,
+
+      # TODO: Write general description for GDPRREQUEST
+      GDPRREQUEST = 'GDPRREQUEST'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONTACT_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'archived' then ARCHIVED
+      when 'gdprrequest' then GDPRREQUEST
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/contacts.rb

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

data/lib/xero_ap_is/models/conversion_balances.rb

@@ -0,0 +1,108 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Balance supplied for each account that has a value as at the conversion
+  # date.
+  class ConversionBalances < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account code for a account
+    # @return [String]
+    attr_accessor :account_code
+
+    # The opening balances of the account. Debits are positive, credits are
+    # negative values
+    # @return [Float]
+    attr_accessor :balance
+
+    # The opening balances of the account. Debits are positive, credits are
+    # negative values
+    # @return [Array[BalanceDetails]]
+    attr_accessor :balance_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_code'] = 'AccountCode'
+      @_hash['balance'] = 'Balance'
+      @_hash['balance_details'] = 'BalanceDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_code
+        balance
+        balance_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_code: SKIP, balance: SKIP, balance_details: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_code = account_code unless account_code == SKIP
+      @balance = balance unless balance == SKIP
+      @balance_details = balance_details unless balance_details == 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.
+      account_code = hash.key?('AccountCode') ? hash['AccountCode'] : SKIP
+      balance = hash.key?('Balance') ? hash['Balance'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      balance_details = nil
+      unless hash['BalanceDetails'].nil?
+        balance_details = []
+        hash['BalanceDetails'].each do |structure|
+          balance_details << (BalanceDetails.from_hash(structure) if structure)
+        end
+      end
+
+      balance_details = SKIP unless hash.key?('BalanceDetails')
+
+      # 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.
+      ConversionBalances.new(account_code: account_code,
+                             balance: balance,
+                             balance_details: balance_details,
+                             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} account_code: #{@account_code}, balance: #{@balance}, balance_details:"\
+      " #{@balance_details}, 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} account_code: #{@account_code.inspect}, balance: #{@balance.inspect},"\
+      " balance_details: #{@balance_details.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/conversion_date.rb

@@ -0,0 +1,87 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The date when the organisation starts using Xero
+  class ConversionDate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The month the organisation starts using Xero. Value is an integer between
+    # 1 and 12
+    # @return [Integer]
+    attr_accessor :month
+
+    # The year the organisation starts using Xero. Value is an integer greater
+    # than 2006
+    # @return [Integer]
+    attr_accessor :year
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['month'] = 'Month'
+      @_hash['year'] = 'Year'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        month
+        year
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(month: SKIP, year: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @month = month unless month == SKIP
+      @year = year unless year == 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.
+      month = hash.key?('Month') ? hash['Month'] : SKIP
+      year = hash.key?('Year') ? hash['Year'] : 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.
+      ConversionDate.new(month: month,
+                         year: year,
+                         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} month: #{@month}, year: #{@year}, 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} month: #{@month.inspect}, year: #{@year.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end