xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/item.rb

@@ -0,0 +1,259 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Item Model.
+  class Item < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User defined item code (max length = 30)
+    # @return [String]
+    attr_accessor :code
+
+    # The inventory asset account for the item. The account must be of type
+    # INVENTORY. The  COGSAccountCode in PurchaseDetails is also required to
+    # create a tracked item
+    # @return [String]
+    attr_accessor :inventory_asset_account_code
+
+    # The name of the item (max length = 50)
+    # @return [String]
+    attr_accessor :name
+
+    # Boolean value, defaults to true. When IsSold is true the item will be
+    # available on sales transactions in the Xero UI. If IsSold is updated to
+    # false then Description and SalesDetails values will be nulled.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_sold
+
+    # Boolean value, defaults to true. When IsPurchased is true the item is
+    # available for purchase transactions in the Xero UI. If IsPurchased is
+    # updated to false then PurchaseDescription and PurchaseDetails values will
+    # be nulled.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_purchased
+
+    # The sales description of the item (max length = 4000)
+    # @return [String]
+    attr_accessor :description
+
+    # The purchase description of the item (max length = 4000)
+    # @return [String]
+    attr_accessor :purchase_description
+
+    # The purchase description of the item (max length = 4000)
+    # @return [Purchase]
+    attr_accessor :purchase_details
+
+    # The purchase description of the item (max length = 4000)
+    # @return [Purchase]
+    attr_accessor :sales_details
+
+    # True for items that are tracked as inventory. An item will be tracked as
+    # inventory if the InventoryAssetAccountCode and COGSAccountCode are set.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_tracked_as_inventory
+
+    # The value of the item on hand. Calculated using average cost accounting.
+    # @return [Float]
+    attr_accessor :total_cost_pool
+
+    # The quantity of the item on hand
+    # @return [Float]
+    attr_accessor :quantity_on_hand
+
+    # Last modified date in UTC format
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # The Xero identifier for an Item
+    # @return [UUID | String]
+    attr_accessor :item_id
+
+    # Status of object
+    # @return [String]
+    attr_accessor :status_attribute_string
+
+    # 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['code'] = 'Code'
+      @_hash['inventory_asset_account_code'] = 'InventoryAssetAccountCode'
+      @_hash['name'] = 'Name'
+      @_hash['is_sold'] = 'IsSold'
+      @_hash['is_purchased'] = 'IsPurchased'
+      @_hash['description'] = 'Description'
+      @_hash['purchase_description'] = 'PurchaseDescription'
+      @_hash['purchase_details'] = 'PurchaseDetails'
+      @_hash['sales_details'] = 'SalesDetails'
+      @_hash['is_tracked_as_inventory'] = 'IsTrackedAsInventory'
+      @_hash['total_cost_pool'] = 'TotalCostPool'
+      @_hash['quantity_on_hand'] = 'QuantityOnHand'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['item_id'] = 'ItemID'
+      @_hash['status_attribute_string'] = 'StatusAttributeString'
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        inventory_asset_account_code
+        name
+        is_sold
+        is_purchased
+        description
+        purchase_description
+        purchase_details
+        sales_details
+        is_tracked_as_inventory
+        total_cost_pool
+        quantity_on_hand
+        updated_date_utc
+        item_id
+        status_attribute_string
+        validation_errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code:, inventory_asset_account_code: SKIP, name: SKIP,
+                   is_sold: SKIP, is_purchased: SKIP, description: SKIP,
+                   purchase_description: SKIP, purchase_details: SKIP,
+                   sales_details: SKIP, is_tracked_as_inventory: SKIP,
+                   total_cost_pool: SKIP, quantity_on_hand: SKIP,
+                   updated_date_utc: SKIP, item_id: SKIP,
+                   status_attribute_string: SKIP, validation_errors: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code
+      unless inventory_asset_account_code == SKIP
+        @inventory_asset_account_code =
+          inventory_asset_account_code
+      end
+      @name = name unless name == SKIP
+      @is_sold = is_sold unless is_sold == SKIP
+      @is_purchased = is_purchased unless is_purchased == SKIP
+      @description = description unless description == SKIP
+      @purchase_description = purchase_description unless purchase_description == SKIP
+      @purchase_details = purchase_details unless purchase_details == SKIP
+      @sales_details = sales_details unless sales_details == SKIP
+      @is_tracked_as_inventory = is_tracked_as_inventory unless is_tracked_as_inventory == SKIP
+      @total_cost_pool = total_cost_pool unless total_cost_pool == SKIP
+      @quantity_on_hand = quantity_on_hand unless quantity_on_hand == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @item_id = item_id unless item_id == SKIP
+      @status_attribute_string = status_attribute_string unless status_attribute_string == SKIP
+      @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.
+      code = hash.key?('Code') ? hash['Code'] : nil
+      inventory_asset_account_code =
+        hash.key?('InventoryAssetAccountCode') ? hash['InventoryAssetAccountCode'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      is_sold = hash.key?('IsSold') ? hash['IsSold'] : SKIP
+      is_purchased = hash.key?('IsPurchased') ? hash['IsPurchased'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      purchase_description =
+        hash.key?('PurchaseDescription') ? hash['PurchaseDescription'] : SKIP
+      purchase_details = Purchase.from_hash(hash['PurchaseDetails']) if hash['PurchaseDetails']
+      sales_details = Purchase.from_hash(hash['SalesDetails']) if hash['SalesDetails']
+      is_tracked_as_inventory =
+        hash.key?('IsTrackedAsInventory') ? hash['IsTrackedAsInventory'] : SKIP
+      total_cost_pool =
+        hash.key?('TotalCostPool') ? hash['TotalCostPool'] : SKIP
+      quantity_on_hand =
+        hash.key?('QuantityOnHand') ? hash['QuantityOnHand'] : SKIP
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      item_id = hash.key?('ItemID') ? hash['ItemID'] : SKIP
+      status_attribute_string =
+        hash.key?('StatusAttributeString') ? hash['StatusAttributeString'] : 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.
+      Item.new(code: code,
+               inventory_asset_account_code: inventory_asset_account_code,
+               name: name,
+               is_sold: is_sold,
+               is_purchased: is_purchased,
+               description: description,
+               purchase_description: purchase_description,
+               purchase_details: purchase_details,
+               sales_details: sales_details,
+               is_tracked_as_inventory: is_tracked_as_inventory,
+               total_cost_pool: total_cost_pool,
+               quantity_on_hand: quantity_on_hand,
+               updated_date_utc: updated_date_utc,
+               item_id: item_id,
+               status_attribute_string: status_attribute_string,
+               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} code: #{@code}, inventory_asset_account_code:"\
+      " #{@inventory_asset_account_code}, name: #{@name}, is_sold: #{@is_sold}, is_purchased:"\
+      " #{@is_purchased}, description: #{@description}, purchase_description:"\
+      " #{@purchase_description}, purchase_details: #{@purchase_details}, sales_details:"\
+      " #{@sales_details}, is_tracked_as_inventory: #{@is_tracked_as_inventory}, total_cost_pool:"\
+      " #{@total_cost_pool}, quantity_on_hand: #{@quantity_on_hand}, updated_date_utc:"\
+      " #{@updated_date_utc}, item_id: #{@item_id}, status_attribute_string:"\
+      " #{@status_attribute_string}, 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} code: #{@code.inspect}, inventory_asset_account_code:"\
+      " #{@inventory_asset_account_code.inspect}, name: #{@name.inspect}, is_sold:"\
+      " #{@is_sold.inspect}, is_purchased: #{@is_purchased.inspect}, description:"\
+      " #{@description.inspect}, purchase_description: #{@purchase_description.inspect},"\
+      " purchase_details: #{@purchase_details.inspect}, sales_details: #{@sales_details.inspect},"\
+      " is_tracked_as_inventory: #{@is_tracked_as_inventory.inspect}, total_cost_pool:"\
+      " #{@total_cost_pool.inspect}, quantity_on_hand: #{@quantity_on_hand.inspect},"\
+      " updated_date_utc: #{@updated_date_utc.inspect}, item_id: #{@item_id.inspect},"\
+      " status_attribute_string: #{@status_attribute_string.inspect}, validation_errors:"\
+      " #{@validation_errors.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/items.rb

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

data/lib/xero_ap_is/models/journal.rb

@@ -0,0 +1,157 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Journal Model.
+  class Journal < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Xero identifier
+    # @return [UUID | String]
+    attr_accessor :journal_id
+
+    # Date the journal was posted
+    # @return [String]
+    attr_accessor :journal_date
+
+    # Xero generated journal number
+    # @return [Integer]
+    attr_accessor :journal_number
+
+    # Created date UTC format
+    # @return [String]
+    attr_accessor :created_date_utc
+
+    # reference field for additional indetifying information
+    # @return [String]
+    attr_accessor :reference
+
+    # The identifier for the source transaction (e.g. InvoiceID)
+    # @return [UUID | String]
+    attr_accessor :source_id
+
+    # The journal source type. The type of transaction that created the journal
+    # @return [SourceType]
+    attr_accessor :source_type
+
+    # See JournalLines
+    # @return [Array[JournalLine]]
+    attr_accessor :journal_lines
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['journal_id'] = 'JournalID'
+      @_hash['journal_date'] = 'JournalDate'
+      @_hash['journal_number'] = 'JournalNumber'
+      @_hash['created_date_utc'] = 'CreatedDateUTC'
+      @_hash['reference'] = 'Reference'
+      @_hash['source_id'] = 'SourceID'
+      @_hash['source_type'] = 'SourceType'
+      @_hash['journal_lines'] = 'JournalLines'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        journal_id
+        journal_date
+        journal_number
+        created_date_utc
+        reference
+        source_id
+        source_type
+        journal_lines
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(journal_id: SKIP, journal_date: SKIP, journal_number: SKIP,
+                   created_date_utc: SKIP, reference: SKIP, source_id: SKIP,
+                   source_type: SKIP, journal_lines: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @journal_id = journal_id unless journal_id == SKIP
+      @journal_date = journal_date unless journal_date == SKIP
+      @journal_number = journal_number unless journal_number == SKIP
+      @created_date_utc = created_date_utc unless created_date_utc == SKIP
+      @reference = reference unless reference == SKIP
+      @source_id = source_id unless source_id == SKIP
+      @source_type = source_type unless source_type == SKIP
+      @journal_lines = journal_lines unless journal_lines == 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.
+      journal_id = hash.key?('JournalID') ? hash['JournalID'] : SKIP
+      journal_date = hash.key?('JournalDate') ? hash['JournalDate'] : SKIP
+      journal_number = hash.key?('JournalNumber') ? hash['JournalNumber'] : SKIP
+      created_date_utc =
+        hash.key?('CreatedDateUTC') ? hash['CreatedDateUTC'] : SKIP
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+      source_id = hash.key?('SourceID') ? hash['SourceID'] : SKIP
+      source_type = hash.key?('SourceType') ? hash['SourceType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      journal_lines = nil
+      unless hash['JournalLines'].nil?
+        journal_lines = []
+        hash['JournalLines'].each do |structure|
+          journal_lines << (JournalLine.from_hash(structure) if structure)
+        end
+      end
+
+      journal_lines = SKIP unless hash.key?('JournalLines')
+
+      # 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.
+      Journal.new(journal_id: journal_id,
+                  journal_date: journal_date,
+                  journal_number: journal_number,
+                  created_date_utc: created_date_utc,
+                  reference: reference,
+                  source_id: source_id,
+                  source_type: source_type,
+                  journal_lines: journal_lines,
+                  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} journal_id: #{@journal_id}, journal_date: #{@journal_date}, journal_number:"\
+      " #{@journal_number}, created_date_utc: #{@created_date_utc}, reference: #{@reference},"\
+      " source_id: #{@source_id}, source_type: #{@source_type}, journal_lines: #{@journal_lines},"\
+      " 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} journal_id: #{@journal_id.inspect}, journal_date: #{@journal_date.inspect},"\
+      " journal_number: #{@journal_number.inspect}, created_date_utc:"\
+      " #{@created_date_utc.inspect}, reference: #{@reference.inspect}, source_id:"\
+      " #{@source_id.inspect}, source_type: #{@source_type.inspect}, journal_lines:"\
+      " #{@journal_lines.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end