xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/line_item_item.rb

@@ -0,0 +1,95 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # LineItemItem Model.
+  class LineItemItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User defined item code (max length = 30)
+    # @return [String]
+    attr_accessor :code
+
+    # The name of the item (max length = 50)
+    # @return [String]
+    attr_accessor :name
+
+    # The Xero identifier for an Item
+    # @return [UUID | String]
+    attr_accessor :item_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'Code'
+      @_hash['name'] = 'Name'
+      @_hash['item_id'] = 'ItemID'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        name
+        item_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, name: SKIP, item_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @name = name unless name == SKIP
+      @item_id = item_id unless item_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.
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      item_id = hash.key?('ItemID') ? hash['ItemID'] : 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.
+      LineItemItem.new(code: code,
+                       name: name,
+                       item_id: item_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} code: #{@code}, name: #{@name}, item_id: #{@item_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} code: #{@code.inspect}, name: #{@name.inspect}, item_id:"\
+      " #{@item_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/line_item_tracking.rb

@@ -0,0 +1,108 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # LineItemTracking Model.
+  class LineItemTracking < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Xero identifier for a tracking category
+    # @return [UUID | String]
+    attr_accessor :tracking_category_id
+
+    # The Xero identifier for a tracking category option
+    # @return [UUID | String]
+    attr_accessor :tracking_option_id
+
+    # The name of the tracking category
+    # @return [String]
+    attr_accessor :name
+
+    # See Tracking Options
+    # @return [String]
+    attr_accessor :option
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tracking_category_id'] = 'TrackingCategoryID'
+      @_hash['tracking_option_id'] = 'TrackingOptionID'
+      @_hash['name'] = 'Name'
+      @_hash['option'] = 'Option'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tracking_category_id
+        tracking_option_id
+        name
+        option
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tracking_category_id: SKIP, tracking_option_id: SKIP,
+                   name: SKIP, option: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tracking_category_id = tracking_category_id unless tracking_category_id == SKIP
+      @tracking_option_id = tracking_option_id unless tracking_option_id == SKIP
+      @name = name unless name == SKIP
+      @option = option unless option == 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.
+      tracking_category_id =
+        hash.key?('TrackingCategoryID') ? hash['TrackingCategoryID'] : SKIP
+      tracking_option_id =
+        hash.key?('TrackingOptionID') ? hash['TrackingOptionID'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      option = hash.key?('Option') ? hash['Option'] : 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.
+      LineItemTracking.new(tracking_category_id: tracking_category_id,
+                           tracking_option_id: tracking_option_id,
+                           name: name,
+                           option: option,
+                           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} tracking_category_id: #{@tracking_category_id}, tracking_option_id:"\
+      " #{@tracking_option_id}, name: #{@name}, option: #{@option}, 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} tracking_category_id: #{@tracking_category_id.inspect}, tracking_option_id:"\
+      " #{@tracking_option_id.inspect}, name: #{@name.inspect}, option: #{@option.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/link_type.rb

@@ -0,0 +1,48 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See External link types
+  class LinkType
+    LINK_TYPE = [
+      # TODO: Write general description for FACEBOOK
+      FACEBOOK = 'Facebook'.freeze,
+
+      # TODO: Write general description for GOOGLEPLUS
+      GOOGLEPLUS = 'GooglePlus'.freeze,
+
+      # TODO: Write general description for LINKEDIN
+      LINKEDIN = 'LinkedIn'.freeze,
+
+      # TODO: Write general description for TWITTER
+      TWITTER = 'Twitter'.freeze,
+
+      # TODO: Write general description for WEBSITE
+      WEBSITE = 'Website'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LINK_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = FACEBOOK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'facebook' then FACEBOOK
+      when 'googleplus' then GOOGLEPLUS
+      when 'linkedin' then LINKEDIN
+      when 'twitter' then TWITTER
+      when 'website' then WEBSITE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/linked_transaction.rb

@@ -0,0 +1,215 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # LinkedTransaction Model.
+  class LinkedTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Filter by the SourceTransactionID. Get all the linked transactions created
+    # from a particular ACCPAY invoice
+    # @return [UUID | String]
+    attr_accessor :source_transaction_id
+
+    # The line item identifier from the source transaction.
+    # @return [UUID | String]
+    attr_accessor :source_line_item_id
+
+    # Filter by the combination of ContactID and Status. Get all the linked
+    # transactions that have been assigned to a particular customer and have a
+    # particular status e.g. GET
+    # /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=
+    # APPROVED.
+    # @return [UUID | String]
+    attr_accessor :contact_id
+
+    # Filter by the TargetTransactionID. Get all the linked transactions
+    # allocated to a particular ACCREC invoice
+    # @return [UUID | String]
+    attr_accessor :target_transaction_id
+
+    # The line item identifier from the target transaction. It is possible  to
+    # link multiple billable expenses to the same TargetLineItemID.
+    # @return [UUID | String]
+    attr_accessor :target_line_item_id
+
+    # The Xero identifier for an Linked Transaction
+    # e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9
+    # @return [UUID | String]
+    attr_accessor :linked_transaction_id
+
+    # Filter by the combination of ContactID and Status. Get all the linked
+    # transactions that have been assigned to a particular customer and have a
+    # particular status e.g. GET
+    # /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=
+    # APPROVED.
+    # @return [Status14]
+    attr_accessor :status
+
+    # This will always be BILLABLEEXPENSE. More types may be added in future.
+    # @return [Type9]
+    attr_accessor :type
+
+    # The last modified date in UTC format
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # The Type of the source tranasction. This will be ACCPAY if the linked
+    # transaction was created from an invoice and SPEND if it was created from a
+    # bank transaction.
+    # @return [SourceTransactionTypeCode]
+    attr_accessor :source_transaction_type_code
+
+    # Displays array of validation error messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :validation_errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['source_transaction_id'] = 'SourceTransactionID'
+      @_hash['source_line_item_id'] = 'SourceLineItemID'
+      @_hash['contact_id'] = 'ContactID'
+      @_hash['target_transaction_id'] = 'TargetTransactionID'
+      @_hash['target_line_item_id'] = 'TargetLineItemID'
+      @_hash['linked_transaction_id'] = 'LinkedTransactionID'
+      @_hash['status'] = 'Status'
+      @_hash['type'] = 'Type'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['source_transaction_type_code'] = 'SourceTransactionTypeCode'
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        source_transaction_id
+        source_line_item_id
+        contact_id
+        target_transaction_id
+        target_line_item_id
+        linked_transaction_id
+        status
+        type
+        updated_date_utc
+        source_transaction_type_code
+        validation_errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(source_transaction_id: SKIP, source_line_item_id: SKIP,
+                   contact_id: SKIP, target_transaction_id: SKIP,
+                   target_line_item_id: SKIP, linked_transaction_id: SKIP,
+                   status: SKIP, type: SKIP, updated_date_utc: SKIP,
+                   source_transaction_type_code: SKIP, validation_errors: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @source_transaction_id = source_transaction_id unless source_transaction_id == SKIP
+      @source_line_item_id = source_line_item_id unless source_line_item_id == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @target_transaction_id = target_transaction_id unless target_transaction_id == SKIP
+      @target_line_item_id = target_line_item_id unless target_line_item_id == SKIP
+      @linked_transaction_id = linked_transaction_id unless linked_transaction_id == SKIP
+      @status = status unless status == SKIP
+      @type = type unless type == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      unless source_transaction_type_code == SKIP
+        @source_transaction_type_code =
+          source_transaction_type_code
+      end
+      @validation_errors = validation_errors unless validation_errors == 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.
+      source_transaction_id =
+        hash.key?('SourceTransactionID') ? hash['SourceTransactionID'] : SKIP
+      source_line_item_id =
+        hash.key?('SourceLineItemID') ? hash['SourceLineItemID'] : SKIP
+      contact_id = hash.key?('ContactID') ? hash['ContactID'] : SKIP
+      target_transaction_id =
+        hash.key?('TargetTransactionID') ? hash['TargetTransactionID'] : SKIP
+      target_line_item_id =
+        hash.key?('TargetLineItemID') ? hash['TargetLineItemID'] : SKIP
+      linked_transaction_id =
+        hash.key?('LinkedTransactionID') ? hash['LinkedTransactionID'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      source_transaction_type_code =
+        hash.key?('SourceTransactionTypeCode') ? hash['SourceTransactionTypeCode'] : SKIP
+      # 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')
+
+      # 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.
+      LinkedTransaction.new(source_transaction_id: source_transaction_id,
+                            source_line_item_id: source_line_item_id,
+                            contact_id: contact_id,
+                            target_transaction_id: target_transaction_id,
+                            target_line_item_id: target_line_item_id,
+                            linked_transaction_id: linked_transaction_id,
+                            status: status,
+                            type: type,
+                            updated_date_utc: updated_date_utc,
+                            source_transaction_type_code: source_transaction_type_code,
+                            validation_errors: validation_errors,
+                            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} source_transaction_id: #{@source_transaction_id}, source_line_item_id:"\
+      " #{@source_line_item_id}, contact_id: #{@contact_id}, target_transaction_id:"\
+      " #{@target_transaction_id}, target_line_item_id: #{@target_line_item_id},"\
+      " linked_transaction_id: #{@linked_transaction_id}, status: #{@status}, type: #{@type},"\
+      " updated_date_utc: #{@updated_date_utc}, source_transaction_type_code:"\
+      " #{@source_transaction_type_code}, validation_errors: #{@validation_errors},"\
+      " 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} source_transaction_id: #{@source_transaction_id.inspect},"\
+      " source_line_item_id: #{@source_line_item_id.inspect}, contact_id: #{@contact_id.inspect},"\
+      " target_transaction_id: #{@target_transaction_id.inspect}, target_line_item_id:"\
+      " #{@target_line_item_id.inspect}, linked_transaction_id: #{@linked_transaction_id.inspect},"\
+      " status: #{@status.inspect}, type: #{@type.inspect}, updated_date_utc:"\
+      " #{@updated_date_utc.inspect}, source_transaction_type_code:"\
+      " #{@source_transaction_type_code.inspect}, validation_errors:"\
+      " #{@validation_errors.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/linked_transactions.rb

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