xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/budget.rb

@@ -0,0 +1,145 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Budget Model.
+  class Budget < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Xero identifier
+    # @return [UUID | String]
+    attr_accessor :budget_id
+
+    # Type of Budget. OVERALL or TRACKING
+    # @return [Type8]
+    attr_accessor :type
+
+    # The Budget description
+    # @return [String]
+    attr_accessor :description
+
+    # UTC timestamp of last update to budget
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # UTC timestamp of last update to budget
+    # @return [Array[BudgetLine]]
+    attr_accessor :budget_lines
+
+    # UTC timestamp of last update to budget
+    # @return [Array[TrackingCategory]]
+    attr_accessor :tracking
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['budget_id'] = 'BudgetID'
+      @_hash['type'] = 'Type'
+      @_hash['description'] = 'Description'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['budget_lines'] = 'BudgetLines'
+      @_hash['tracking'] = 'Tracking'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        budget_id
+        type
+        description
+        updated_date_utc
+        budget_lines
+        tracking
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(budget_id: SKIP, type: SKIP, description: SKIP,
+                   updated_date_utc: SKIP, budget_lines: SKIP, tracking: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @budget_id = budget_id unless budget_id == SKIP
+      @type = type unless type == SKIP
+      @description = description unless description == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @budget_lines = budget_lines unless budget_lines == SKIP
+      @tracking = tracking unless tracking == 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.
+      budget_id = hash.key?('BudgetID') ? hash['BudgetID'] : SKIP
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      budget_lines = nil
+      unless hash['BudgetLines'].nil?
+        budget_lines = []
+        hash['BudgetLines'].each do |structure|
+          budget_lines << (BudgetLine.from_hash(structure) if structure)
+        end
+      end
+
+      budget_lines = SKIP unless hash.key?('BudgetLines')
+      # Parameter is an array, so we need to iterate through it
+      tracking = nil
+      unless hash['Tracking'].nil?
+        tracking = []
+        hash['Tracking'].each do |structure|
+          tracking << (TrackingCategory.from_hash(structure) if structure)
+        end
+      end
+
+      tracking = SKIP unless hash.key?('Tracking')
+
+      # 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.
+      Budget.new(budget_id: budget_id,
+                 type: type,
+                 description: description,
+                 updated_date_utc: updated_date_utc,
+                 budget_lines: budget_lines,
+                 tracking: tracking,
+                 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} budget_id: #{@budget_id}, type: #{@type}, description: #{@description},"\
+      " updated_date_utc: #{@updated_date_utc}, budget_lines: #{@budget_lines}, tracking:"\
+      " #{@tracking}, 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} budget_id: #{@budget_id.inspect}, type: #{@type.inspect}, description:"\
+      " #{@description.inspect}, updated_date_utc: #{@updated_date_utc.inspect}, budget_lines:"\
+      " #{@budget_lines.inspect}, tracking: #{@tracking.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/budget_balance.rb

@@ -0,0 +1,105 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # BudgetBalance Model.
+  class BudgetBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Period the amount applies to (e.g. “2019-08”)
+    # @return [String]
+    attr_accessor :period
+
+    # LineItem Quantity
+    # @return [Float]
+    attr_accessor :amount
+
+    # Budgeted amount
+    # @return [Float]
+    attr_accessor :unit_amount
+
+    # Any footnotes associated with this balance
+    # @return [String]
+    attr_accessor :notes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['period'] = 'Period'
+      @_hash['amount'] = 'Amount'
+      @_hash['unit_amount'] = 'UnitAmount'
+      @_hash['notes'] = 'Notes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        period
+        amount
+        unit_amount
+        notes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(period: SKIP, amount: SKIP, unit_amount: SKIP, notes: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @period = period unless period == SKIP
+      @amount = amount unless amount == SKIP
+      @unit_amount = unit_amount unless unit_amount == SKIP
+      @notes = notes unless notes == 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.
+      period = hash.key?('Period') ? hash['Period'] : SKIP
+      amount = hash.key?('Amount') ? hash['Amount'] : SKIP
+      unit_amount = hash.key?('UnitAmount') ? hash['UnitAmount'] : SKIP
+      notes = hash.key?('Notes') ? hash['Notes'] : 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.
+      BudgetBalance.new(period: period,
+                        amount: amount,
+                        unit_amount: unit_amount,
+                        notes: notes,
+                        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} period: #{@period}, amount: #{@amount}, unit_amount: #{@unit_amount},"\
+      " notes: #{@notes}, 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} period: #{@period.inspect}, amount: #{@amount.inspect}, unit_amount:"\
+      " #{@unit_amount.inspect}, notes: #{@notes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/budget_line.rb

@@ -0,0 +1,105 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # BudgetLine Model.
+  class BudgetLine < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # See Accounts
+    # @return [UUID | String]
+    attr_accessor :account_id
+
+    # See Accounts
+    # @return [String]
+    attr_accessor :account_code
+
+    # See Accounts
+    # @return [Array[BudgetBalance]]
+    attr_accessor :budget_balances
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountID'
+      @_hash['account_code'] = 'AccountCode'
+      @_hash['budget_balances'] = 'BudgetBalances'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_code
+        budget_balances
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, account_code: SKIP, budget_balances: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id unless account_id == SKIP
+      @account_code = account_code unless account_code == SKIP
+      @budget_balances = budget_balances unless budget_balances == 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_id = hash.key?('AccountID') ? hash['AccountID'] : SKIP
+      account_code = hash.key?('AccountCode') ? hash['AccountCode'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      budget_balances = nil
+      unless hash['BudgetBalances'].nil?
+        budget_balances = []
+        hash['BudgetBalances'].each do |structure|
+          budget_balances << (BudgetBalance.from_hash(structure) if structure)
+        end
+      end
+
+      budget_balances = SKIP unless hash.key?('BudgetBalances')
+
+      # 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.
+      BudgetLine.new(account_id: account_id,
+                     account_code: account_code,
+                     budget_balances: budget_balances,
+                     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_id: #{@account_id}, account_code: #{@account_code},"\
+      " budget_balances: #{@budget_balances}, 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_id: #{@account_id.inspect}, account_code: #{@account_code.inspect},"\
+      " budget_balances: #{@budget_balances.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/budgets.rb

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

data/lib/xero_ap_is/models/charge_type.rb

@@ -0,0 +1,42 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Can be `TIME`, `FIXED` or `NON_CHARGEABLE`, defines how the task will be
+  # charged. Use `TIME` when you want to charge per hour and `FIXED` to charge
+  # as a fixed amount. If the task will not be charged use `NON_CHARGEABLE`.
+  class ChargeType
+    CHARGE_TYPE = [
+      # TODO: Write general description for TIME
+      TIME = 'TIME'.freeze,
+
+      # TODO: Write general description for FIXED
+      FIXED = 'FIXED'.freeze,
+
+      # TODO: Write general description for NON_CHARGEABLE
+      NON_CHARGEABLE = 'NON_CHARGEABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHARGE_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = TIME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'time' then TIME
+      when 'fixed' then FIXED
+      when 'non_chargeable' then NON_CHARGEABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/cis_org_setting.rb

@@ -0,0 +1,105 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # CisOrgSetting Model.
+  class CisOrgSetting < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # true or false - Boolean that describes if the organisation is a CIS
+    # Contractor
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cis_contractor_enabled
+
+    # true or false - Boolean that describes if the organisation is a CIS
+    # SubContractor
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cis_sub_contractor_enabled
+
+    # CIS Deduction rate for the organisation
+    # @return [Float]
+    attr_accessor :rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cis_contractor_enabled'] = 'CISContractorEnabled'
+      @_hash['cis_sub_contractor_enabled'] = 'CISSubContractorEnabled'
+      @_hash['rate'] = 'Rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cis_contractor_enabled
+        cis_sub_contractor_enabled
+        rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cis_contractor_enabled: SKIP,
+                   cis_sub_contractor_enabled: SKIP, rate: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cis_contractor_enabled = cis_contractor_enabled unless cis_contractor_enabled == SKIP
+      unless cis_sub_contractor_enabled == SKIP
+        @cis_sub_contractor_enabled =
+          cis_sub_contractor_enabled
+      end
+      @rate = rate unless rate == 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.
+      cis_contractor_enabled =
+        hash.key?('CISContractorEnabled') ? hash['CISContractorEnabled'] : SKIP
+      cis_sub_contractor_enabled =
+        hash.key?('CISSubContractorEnabled') ? hash['CISSubContractorEnabled'] : SKIP
+      rate = hash.key?('Rate') ? hash['Rate'] : 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.
+      CisOrgSetting.new(cis_contractor_enabled: cis_contractor_enabled,
+                        cis_sub_contractor_enabled: cis_sub_contractor_enabled,
+                        rate: rate,
+                        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} cis_contractor_enabled: #{@cis_contractor_enabled},"\
+      " cis_sub_contractor_enabled: #{@cis_sub_contractor_enabled}, rate: #{@rate},"\
+      " 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} cis_contractor_enabled: #{@cis_contractor_enabled.inspect},"\
+      " cis_sub_contractor_enabled: #{@cis_sub_contractor_enabled.inspect}, rate:"\
+      " #{@rate.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/cis_org_settings.rb

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