xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/external_link.rb

@@ -0,0 +1,95 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # ExternalLink Model.
+  class ExternalLink < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # See External link types
+    # @return [LinkType]
+    attr_accessor :link_type
+
+    # URL for service e.g. http://twitter.com/xeroapi
+    # @return [String]
+    attr_accessor :url
+
+    # URL for service e.g. http://twitter.com/xeroapi
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['link_type'] = 'LinkType'
+      @_hash['url'] = 'Url'
+      @_hash['description'] = 'Description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        link_type
+        url
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(link_type: SKIP, url: SKIP, description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @link_type = link_type unless link_type == SKIP
+      @url = url unless url == SKIP
+      @description = description unless description == 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.
+      link_type = hash.key?('LinkType') ? hash['LinkType'] : SKIP
+      url = hash.key?('Url') ? hash['Url'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : 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.
+      ExternalLink.new(link_type: link_type,
+                       url: url,
+                       description: description,
+                       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} link_type: #{@link_type}, url: #{@url}, description: #{@description},"\
+      " 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} link_type: #{@link_type.inspect}, url: #{@url.inspect}, description:"\
+      " #{@description.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/federal_tax_classification.rb

@@ -0,0 +1,56 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Contact federal tax classification
+  class FederalTaxClassification
+    FEDERAL_TAX_CLASSIFICATION = [
+      # TODO: Write general description for SOLE_PROPRIETOR
+      SOLE_PROPRIETOR = 'SOLE_PROPRIETOR'.freeze,
+
+      # TODO: Write general description for PARTNERSHIP
+      PARTNERSHIP = 'PARTNERSHIP'.freeze,
+
+      # TODO: Write general description for TRUST_OR_ESTATE
+      TRUST_OR_ESTATE = 'TRUST_OR_ESTATE'.freeze,
+
+      # TODO: Write general description for NONPROFIT
+      NONPROFIT = 'NONPROFIT'.freeze,
+
+      # TODO: Write general description for C_CORP
+      C_CORP = 'C_CORP'.freeze,
+
+      # TODO: Write general description for S_CORP
+      S_CORP = 'S_CORP'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FEDERAL_TAX_CLASSIFICATION.include?(value)
+    end
+
+    def self.from_value(value, default_value = SOLE_PROPRIETOR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sole_proprietor' then SOLE_PROPRIETOR
+      when 'partnership' then PARTNERSHIP
+      when 'trust_or_estate' then TRUST_OR_ESTATE
+      when 'nonprofit' then NONPROFIT
+      when 'c_corp' then C_CORP
+      when 's_corp' then S_CORP
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/feed_connection.rb

@@ -0,0 +1,177 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # FeedConnection Model.
+  class FeedConnection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # GUID used to identify the Account.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # This account identifier is generated by the financial institute (FI). This
+    # must be unique for your financial institute.
+    # @return [String]
+    attr_accessor :account_token
+
+    # String(40) when AccountType is BANK String(4) when AccountType is
+    # CREDITCARD The Account Number is used to match the feed to a Xero Bank
+    # Account. The API will create a new Xero Bank Account if a match to an
+    # existing Xero Bank Account is not found. Only the last 4 digits must be
+    # supplied for Credit Card numbers. Must be included if AccountId is not
+    # specified.
+    # @return [String]
+    attr_accessor :account_number
+
+    # The Account Name will be used for the creation of a new Xero Bank Account
+    # if a matching Xero Bank Account is not found.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Xero identifier for a bank account in Xero. Must be included if
+    # AccountNumber is not specified.
+    # @return [UUID | String]
+    attr_accessor :account_id
+
+    # High level bank account type - BANK CREDITCARD BANK encompasses all bank
+    # account types other than credit cards.
+    # @return [AccountType1]
+    attr_accessor :account_type
+
+    # 3 letter alpha code for the ISO-4217 currency code, e.g. USD, AUD.
+    # @return [CurrencyCode1]
+    attr_accessor :currency
+
+    # ISO-3166 alpha-2 country code, e.g. US, AU This element is required only
+    # when the Application supports multi-region. Talk to your Partner Manager
+    # to confirm if this is the case.
+    # @return [CountryCode]
+    attr_accessor :country
+
+    # the current status of the feed connection
+    # @return [Status21]
+    attr_accessor :status
+
+    # 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.
+    # @return [Error2]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['account_token'] = 'accountToken'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['account_name'] = 'accountName'
+      @_hash['account_id'] = 'accountId'
+      @_hash['account_type'] = 'accountType'
+      @_hash['currency'] = 'currency'
+      @_hash['country'] = 'country'
+      @_hash['status'] = 'status'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        account_token
+        account_number
+        account_name
+        account_id
+        account_type
+        currency
+        country
+        status
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, account_token: SKIP, account_number: SKIP,
+                   account_name: SKIP, account_id: SKIP, account_type: SKIP,
+                   currency: SKIP, country: SKIP, status: SKIP, error: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @account_token = account_token unless account_token == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @currency = currency unless currency == SKIP
+      @country = country unless country == SKIP
+      @status = status unless status == SKIP
+      @error = error unless error == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      account_token = hash.key?('accountToken') ? hash['accountToken'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      error = Error2.from_hash(hash['error']) if hash['error']
+
+      # 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.
+      FeedConnection.new(id: id,
+                         account_token: account_token,
+                         account_number: account_number,
+                         account_name: account_name,
+                         account_id: account_id,
+                         account_type: account_type,
+                         currency: currency,
+                         country: country,
+                         status: status,
+                         error: error,
+                         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} id: #{@id}, account_token: #{@account_token}, account_number:"\
+      " #{@account_number}, account_name: #{@account_name}, account_id: #{@account_id},"\
+      " account_type: #{@account_type}, currency: #{@currency}, country: #{@country}, status:"\
+      " #{@status}, error: #{@error}, 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} id: #{@id.inspect}, account_token: #{@account_token.inspect},"\
+      " account_number: #{@account_number.inspect}, account_name: #{@account_name.inspect},"\
+      " account_id: #{@account_id.inspect}, account_type: #{@account_type.inspect}, currency:"\
+      " #{@currency.inspect}, country: #{@country.inspect}, status: #{@status.inspect}, error:"\
+      " #{@error.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/feed_connections.rb

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

data/lib/xero_ap_is/models/field_validation_errors_element.rb

@@ -0,0 +1,127 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # FieldValidationErrorsElement Model.
+  class FieldValidationErrorsElement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The field name of the erroneous field
+    # @return [String]
+    attr_accessor :field_name
+
+    # The provided value
+    # @return [String]
+    attr_accessor :value_provided
+
+    # Explanation of the field validation error
+    # @return [String]
+    attr_accessor :localised_message
+
+    # Internal type of the field validation error message
+    # @return [String]
+    attr_accessor :type
+
+    # Title of the field validation error
+    # @return [String]
+    attr_accessor :title
+
+    # Detail of the field validation error
+    # @return [String]
+    attr_accessor :detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field_name'] = 'fieldName'
+      @_hash['value_provided'] = 'valueProvided'
+      @_hash['localised_message'] = 'localisedMessage'
+      @_hash['type'] = 'type'
+      @_hash['title'] = 'title'
+      @_hash['detail'] = 'detail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        field_name
+        value_provided
+        localised_message
+        type
+        title
+        detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(field_name: SKIP, value_provided: SKIP,
+                   localised_message: SKIP, type: SKIP, title: SKIP,
+                   detail: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @field_name = field_name unless field_name == SKIP
+      @value_provided = value_provided unless value_provided == SKIP
+      @localised_message = localised_message unless localised_message == 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.
+      field_name = hash.key?('fieldName') ? hash['fieldName'] : SKIP
+      value_provided = hash.key?('valueProvided') ? hash['valueProvided'] : SKIP
+      localised_message =
+        hash.key?('localisedMessage') ? hash['localisedMessage'] : SKIP
+      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.
+      FieldValidationErrorsElement.new(field_name: field_name,
+                                       value_provided: value_provided,
+                                       localised_message: localised_message,
+                                       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} field_name: #{@field_name}, value_provided: #{@value_provided},"\
+      " localised_message: #{@localised_message}, 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} field_name: #{@field_name.inspect}, value_provided:"\
+      " #{@value_provided.inspect}, localised_message: #{@localised_message.inspect}, type:"\
+      " #{@type.inspect}, title: #{@title.inspect}, detail: #{@detail.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/history_record.rb

@@ -0,0 +1,105 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # HistoryRecord Model.
+  class HistoryRecord < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # details
+    # @return [String]
+    attr_accessor :details
+
+    # Name of branding theme
+    # @return [String]
+    attr_accessor :changes
+
+    # has a value of 0
+    # @return [String]
+    attr_accessor :user
+
+    # UTC timestamp of creation date of branding theme
+    # @return [String]
+    attr_accessor :date_utc
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['details'] = 'Details'
+      @_hash['changes'] = 'Changes'
+      @_hash['user'] = 'User'
+      @_hash['date_utc'] = 'DateUTC'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        details
+        changes
+        user
+        date_utc
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(details: SKIP, changes: SKIP, user: SKIP, date_utc: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @details = details unless details == SKIP
+      @changes = changes unless changes == SKIP
+      @user = user unless user == SKIP
+      @date_utc = date_utc unless date_utc == 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.
+      details = hash.key?('Details') ? hash['Details'] : SKIP
+      changes = hash.key?('Changes') ? hash['Changes'] : SKIP
+      user = hash.key?('User') ? hash['User'] : SKIP
+      date_utc = hash.key?('DateUTC') ? hash['DateUTC'] : 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.
+      HistoryRecord.new(details: details,
+                        changes: changes,
+                        user: user,
+                        date_utc: date_utc,
+                        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} details: #{@details}, changes: #{@changes}, user: #{@user}, date_utc:"\
+      " #{@date_utc}, 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} details: #{@details.inspect}, changes: #{@changes.inspect}, user:"\
+      " #{@user.inspect}, date_utc: #{@date_utc.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end