xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/status3.rb

@@ -0,0 +1,52 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Invoice Status Codes
+  class Status3
+    STATUS3 = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'DRAFT'.freeze,
+
+      # TODO: Write general description for SUBMITTED
+      SUBMITTED = 'SUBMITTED'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze,
+
+      # TODO: Write general description for AUTHORISED
+      AUTHORISED = 'AUTHORISED'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'PAID'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'VOIDED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS3.include?(value)
+    end
+
+    def self.from_value(value, default_value = DRAFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'draft' then DRAFT
+      when 'submitted' then SUBMITTED
+      when 'deleted' then DELETED
+      when 'authorised' then AUTHORISED
+      when 'paid' then PAID
+      when 'voided' then VOIDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/status4.rb

@@ -0,0 +1,40 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Prepayment Status Codes
+  class Status4
+    STATUS4 = [
+      # TODO: Write general description for AUTHORISED
+      AUTHORISED = 'AUTHORISED'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'PAID'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'VOIDED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS4.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTHORISED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'authorised' then AUTHORISED
+      when 'paid' then PAID
+      when 'voided' then VOIDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/status5.rb

@@ -0,0 +1,40 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Overpayment Status Codes
+  class Status5
+    STATUS5 = [
+      # TODO: Write general description for AUTHORISED
+      AUTHORISED = 'AUTHORISED'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'PAID'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'VOIDED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS5.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTHORISED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'authorised' then AUTHORISED
+      when 'paid' then PAID
+      when 'voided' then VOIDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/status6.rb

@@ -0,0 +1,52 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Credit Note Status Codes
+  class Status6
+    STATUS6 = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'DRAFT'.freeze,
+
+      # TODO: Write general description for SUBMITTED
+      SUBMITTED = 'SUBMITTED'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze,
+
+      # TODO: Write general description for AUTHORISED
+      AUTHORISED = 'AUTHORISED'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'PAID'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'VOIDED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS6.include?(value)
+    end
+
+    def self.from_value(value, default_value = DRAFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'draft' then DRAFT
+      when 'submitted' then SUBMITTED
+      when 'deleted' then DELETED
+      when 'authorised' then AUTHORISED
+      when 'paid' then PAID
+      when 'voided' then VOIDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/status7.rb

@@ -0,0 +1,36 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The status of the payment.
+  class Status7
+    STATUS7 = [
+      # TODO: Write general description for AUTHORISED
+      AUTHORISED = 'AUTHORISED'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS7.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTHORISED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'authorised' then AUTHORISED
+      when 'deleted' then DELETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/status8.rb

@@ -0,0 +1,37 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # AUTHORISED or DELETED (read-only). New batch payments will have a status of
+  # AUTHORISED. It is not possible to delete batch payments via the API.
+  class Status8
+    STATUS8 = [
+      # TODO: Write general description for AUTHORISED
+      AUTHORISED = 'AUTHORISED'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS8.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTHORISED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'authorised' then AUTHORISED
+      when 'deleted' then DELETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/status9.rb

@@ -0,0 +1,40 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The status of a tracking category
+  class Status9
+    STATUS9 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for ARCHIVED
+      ARCHIVED = 'ARCHIVED'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS9.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 'deleted' then DELETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/system_account.rb

@@ -0,0 +1,110 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # If this is a system account then this element is returned. See System
+  # Account types. Note that non-system accounts may have this element set as
+  # either “” or null.
+  class SystemAccount
+    SYSTEM_ACCOUNT = [
+      # TODO: Write general description for DEBTORS
+      DEBTORS = 'DEBTORS'.freeze,
+
+      # TODO: Write general description for CREDITORS
+      CREDITORS = 'CREDITORS'.freeze,
+
+      # TODO: Write general description for BANKCURRENCYGAIN
+      BANKCURRENCYGAIN = 'BANKCURRENCYGAIN'.freeze,
+
+      # TODO: Write general description for GST
+      GST = 'GST'.freeze,
+
+      # TODO: Write general description for GSTONIMPORTS
+      GSTONIMPORTS = 'GSTONIMPORTS'.freeze,
+
+      # TODO: Write general description for HISTORICAL
+      HISTORICAL = 'HISTORICAL'.freeze,
+
+      # TODO: Write general description for REALISEDCURRENCYGAIN
+      REALISEDCURRENCYGAIN = 'REALISEDCURRENCYGAIN'.freeze,
+
+      # TODO: Write general description for RETAINEDEARNINGS
+      RETAINEDEARNINGS = 'RETAINEDEARNINGS'.freeze,
+
+      # TODO: Write general description for ROUNDING
+      ROUNDING = 'ROUNDING'.freeze,
+
+      # TODO: Write general description for TRACKINGTRANSFERS
+      TRACKINGTRANSFERS = 'TRACKINGTRANSFERS'.freeze,
+
+      # TODO: Write general description for UNPAIDEXPCLM
+      UNPAIDEXPCLM = 'UNPAIDEXPCLM'.freeze,
+
+      # TODO: Write general description for UNREALISEDCURRENCYGAIN
+      UNREALISEDCURRENCYGAIN = 'UNREALISEDCURRENCYGAIN'.freeze,
+
+      # TODO: Write general description for WAGEPAYABLES
+      WAGEPAYABLES = 'WAGEPAYABLES'.freeze,
+
+      # TODO: Write general description for CISASSETS
+      CISASSETS = 'CISASSETS'.freeze,
+
+      # TODO: Write general description for CISASSET
+      CISASSET = 'CISASSET'.freeze,
+
+      # TODO: Write general description for CISLABOUR
+      CISLABOUR = 'CISLABOUR'.freeze,
+
+      # TODO: Write general description for CISLABOUREXPENSE
+      CISLABOUREXPENSE = 'CISLABOUREXPENSE'.freeze,
+
+      # TODO: Write general description for CISLABOURINCOME
+      CISLABOURINCOME = 'CISLABOURINCOME'.freeze,
+
+      # TODO: Write general description for CISLIABILITY
+      CISLIABILITY = 'CISLIABILITY'.freeze,
+
+      # TODO: Write general description for CISMATERIALS
+      CISMATERIALS = 'CISMATERIALS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SYSTEM_ACCOUNT.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEBTORS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'debtors' then DEBTORS
+      when 'creditors' then CREDITORS
+      when 'bankcurrencygain' then BANKCURRENCYGAIN
+      when 'gst' then GST
+      when 'gstonimports' then GSTONIMPORTS
+      when 'historical' then HISTORICAL
+      when 'realisedcurrencygain' then REALISEDCURRENCYGAIN
+      when 'retainedearnings' then RETAINEDEARNINGS
+      when 'rounding' then ROUNDING
+      when 'trackingtransfers' then TRACKINGTRANSFERS
+      when 'unpaidexpclm' then UNPAIDEXPCLM
+      when 'unrealisedcurrencygain' then UNREALISEDCURRENCYGAIN
+      when 'wagepayables' then WAGEPAYABLES
+      when 'cisassets' then CISASSETS
+      when 'cisasset' then CISASSET
+      when 'cislabour' then CISLABOUR
+      when 'cislabourexpense' then CISLABOUREXPENSE
+      when 'cislabourincome' then CISLABOURINCOME
+      when 'cisliability' then CISLIABILITY
+      when 'cismaterials' then CISMATERIALS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/task.rb

@@ -0,0 +1,234 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Task Model.
+  class Task < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the task.
+    # @return [UUID | String]
+    attr_accessor :task_id
+
+    # Name of the task.
+    # @return [String]
+    attr_accessor :name
+
+    # Name of the task.
+    # @return [Amount]
+    attr_accessor :rate
+
+    # 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`.
+    # @return [ChargeType]
+    attr_accessor :charge_type
+
+    # An estimated time to perform the task
+    # @return [Integer]
+    attr_accessor :estimate_minutes
+
+    # Identifier of the project task belongs to.
+    # @return [UUID | String]
+    attr_accessor :project_id
+
+    # Total minutes which have been logged against the task. Logged by assigning
+    # a time entry to a task
+    # @return [Integer]
+    attr_accessor :total_minutes
+
+    # Total minutes which have been logged against the task. Logged by assigning
+    # a time entry to a task
+    # @return [Amount]
+    attr_accessor :total_amount
+
+    # Minutes on this task which have been invoiced.
+    # @return [Integer]
+    attr_accessor :minutes_invoiced
+
+    # Minutes on this task which have not been invoiced.
+    # @return [Integer]
+    attr_accessor :minutes_to_be_invoiced
+
+    # Minutes logged against this task if its charge type is `FIXED`.
+    # @return [Integer]
+    attr_accessor :fixed_minutes
+
+    # Minutes logged against this task if its charge type is `NON_CHARGEABLE`.
+    # @return [Integer]
+    attr_accessor :non_chargeable_minutes
+
+    # Minutes logged against this task if its charge type is `NON_CHARGEABLE`.
+    # @return [Amount]
+    attr_accessor :amount_to_be_invoiced
+
+    # Minutes logged against this task if its charge type is `NON_CHARGEABLE`.
+    # @return [Amount]
+    attr_accessor :amount_invoiced
+
+    # Status of the task. When a task of ChargeType is `FIXED` and the rate
+    # amount is invoiced the status will be set to `INVOICED` and can't be
+    # modified. A task with ChargeType of `TIME` or `NON_CHARGEABLE` cannot have
+    # a status of `INVOICED`. A `LOCKED` state indicates that the task is
+    # currently changing state (for example being invoiced) and can't be
+    # modified.
+    # @return [Status22]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['task_id'] = 'taskId'
+      @_hash['name'] = 'name'
+      @_hash['rate'] = 'rate'
+      @_hash['charge_type'] = 'chargeType'
+      @_hash['estimate_minutes'] = 'estimateMinutes'
+      @_hash['project_id'] = 'projectId'
+      @_hash['total_minutes'] = 'totalMinutes'
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['minutes_invoiced'] = 'minutesInvoiced'
+      @_hash['minutes_to_be_invoiced'] = 'minutesToBeInvoiced'
+      @_hash['fixed_minutes'] = 'fixedMinutes'
+      @_hash['non_chargeable_minutes'] = 'nonChargeableMinutes'
+      @_hash['amount_to_be_invoiced'] = 'amountToBeInvoiced'
+      @_hash['amount_invoiced'] = 'amountInvoiced'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        task_id
+        name
+        rate
+        charge_type
+        estimate_minutes
+        project_id
+        total_minutes
+        total_amount
+        minutes_invoiced
+        minutes_to_be_invoiced
+        fixed_minutes
+        non_chargeable_minutes
+        amount_to_be_invoiced
+        amount_invoiced
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(task_id: SKIP, name: SKIP, rate: SKIP, charge_type: SKIP,
+                   estimate_minutes: SKIP, project_id: SKIP,
+                   total_minutes: SKIP, total_amount: SKIP,
+                   minutes_invoiced: SKIP, minutes_to_be_invoiced: SKIP,
+                   fixed_minutes: SKIP, non_chargeable_minutes: SKIP,
+                   amount_to_be_invoiced: SKIP, amount_invoiced: SKIP,
+                   status: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @task_id = task_id unless task_id == SKIP
+      @name = name unless name == SKIP
+      @rate = rate unless rate == SKIP
+      @charge_type = charge_type unless charge_type == SKIP
+      @estimate_minutes = estimate_minutes unless estimate_minutes == SKIP
+      @project_id = project_id unless project_id == SKIP
+      @total_minutes = total_minutes unless total_minutes == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @minutes_invoiced = minutes_invoiced unless minutes_invoiced == SKIP
+      @minutes_to_be_invoiced = minutes_to_be_invoiced unless minutes_to_be_invoiced == SKIP
+      @fixed_minutes = fixed_minutes unless fixed_minutes == SKIP
+      @non_chargeable_minutes = non_chargeable_minutes unless non_chargeable_minutes == SKIP
+      @amount_to_be_invoiced = amount_to_be_invoiced unless amount_to_be_invoiced == SKIP
+      @amount_invoiced = amount_invoiced unless amount_invoiced == SKIP
+      @status = status unless status == 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.
+      task_id = hash.key?('taskId') ? hash['taskId'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      rate = Amount.from_hash(hash['rate']) if hash['rate']
+      charge_type = hash.key?('chargeType') ? hash['chargeType'] : SKIP
+      estimate_minutes =
+        hash.key?('estimateMinutes') ? hash['estimateMinutes'] : SKIP
+      project_id = hash.key?('projectId') ? hash['projectId'] : SKIP
+      total_minutes = hash.key?('totalMinutes') ? hash['totalMinutes'] : SKIP
+      total_amount = Amount.from_hash(hash['totalAmount']) if hash['totalAmount']
+      minutes_invoiced =
+        hash.key?('minutesInvoiced') ? hash['minutesInvoiced'] : SKIP
+      minutes_to_be_invoiced =
+        hash.key?('minutesToBeInvoiced') ? hash['minutesToBeInvoiced'] : SKIP
+      fixed_minutes = hash.key?('fixedMinutes') ? hash['fixedMinutes'] : SKIP
+      non_chargeable_minutes =
+        hash.key?('nonChargeableMinutes') ? hash['nonChargeableMinutes'] : SKIP
+      amount_to_be_invoiced = Amount.from_hash(hash['amountToBeInvoiced']) if
+        hash['amountToBeInvoiced']
+      amount_invoiced = Amount.from_hash(hash['amountInvoiced']) if hash['amountInvoiced']
+      status = hash.key?('status') ? hash['status'] : 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.
+      Task.new(task_id: task_id,
+               name: name,
+               rate: rate,
+               charge_type: charge_type,
+               estimate_minutes: estimate_minutes,
+               project_id: project_id,
+               total_minutes: total_minutes,
+               total_amount: total_amount,
+               minutes_invoiced: minutes_invoiced,
+               minutes_to_be_invoiced: minutes_to_be_invoiced,
+               fixed_minutes: fixed_minutes,
+               non_chargeable_minutes: non_chargeable_minutes,
+               amount_to_be_invoiced: amount_to_be_invoiced,
+               amount_invoiced: amount_invoiced,
+               status: status,
+               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} task_id: #{@task_id}, name: #{@name}, rate: #{@rate}, charge_type:"\
+      " #{@charge_type}, estimate_minutes: #{@estimate_minutes}, project_id: #{@project_id},"\
+      " total_minutes: #{@total_minutes}, total_amount: #{@total_amount}, minutes_invoiced:"\
+      " #{@minutes_invoiced}, minutes_to_be_invoiced: #{@minutes_to_be_invoiced}, fixed_minutes:"\
+      " #{@fixed_minutes}, non_chargeable_minutes: #{@non_chargeable_minutes},"\
+      " amount_to_be_invoiced: #{@amount_to_be_invoiced}, amount_invoiced: #{@amount_invoiced},"\
+      " status: #{@status}, 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} task_id: #{@task_id.inspect}, name: #{@name.inspect}, rate:"\
+      " #{@rate.inspect}, charge_type: #{@charge_type.inspect}, estimate_minutes:"\
+      " #{@estimate_minutes.inspect}, project_id: #{@project_id.inspect}, total_minutes:"\
+      " #{@total_minutes.inspect}, total_amount: #{@total_amount.inspect}, minutes_invoiced:"\
+      " #{@minutes_invoiced.inspect}, minutes_to_be_invoiced: #{@minutes_to_be_invoiced.inspect},"\
+      " fixed_minutes: #{@fixed_minutes.inspect}, non_chargeable_minutes:"\
+      " #{@non_chargeable_minutes.inspect}, amount_to_be_invoiced:"\
+      " #{@amount_to_be_invoiced.inspect}, amount_invoiced: #{@amount_invoiced.inspect}, status:"\
+      " #{@status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end