xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/task_create_or_update.rb

@@ -0,0 +1,105 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # TaskCreateOrUpdate Model.
+  class TaskCreateOrUpdate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the task. Max length 100 characters.
+    # @return [String]
+    attr_accessor :name
+
+    # Name of the task. Max length 100 characters.
+    # @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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['rate'] = 'rate'
+      @_hash['charge_type'] = 'chargeType'
+      @_hash['estimate_minutes'] = 'estimateMinutes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        estimate_minutes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, rate:, charge_type:, estimate_minutes: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @rate = rate
+      @charge_type = charge_type
+      @estimate_minutes = estimate_minutes unless estimate_minutes == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      rate = Amount.from_hash(hash['rate']) if hash['rate']
+      charge_type = hash.key?('chargeType') ? hash['chargeType'] : nil
+      estimate_minutes =
+        hash.key?('estimateMinutes') ? hash['estimateMinutes'] : 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.
+      TaskCreateOrUpdate.new(name: name,
+                             rate: rate,
+                             charge_type: charge_type,
+                             estimate_minutes: estimate_minutes,
+                             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} name: #{@name}, rate: #{@rate}, charge_type: #{@charge_type},"\
+      " estimate_minutes: #{@estimate_minutes}, 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} name: #{@name.inspect}, rate: #{@rate.inspect}, charge_type:"\
+      " #{@charge_type.inspect}, estimate_minutes: #{@estimate_minutes.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/tasks.rb

@@ -0,0 +1,94 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Tasks Model.
+  class Tasks < 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[Task]]
+    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 << (Task.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.
+      Tasks.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/tax_breakdown_component.rb

@@ -0,0 +1,172 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # TaxBreakdownComponent Model.
+  class TaxBreakdownComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID number of this component
+    # @return [UUID | String]
+    attr_accessor :tax_component_id
+
+    # The type of the jurisdiction
+    # @return [Type2]
+    attr_accessor :type
+
+    # The name of the jurisdiction
+    # @return [String]
+    attr_accessor :name
+
+    # The percentage of the tax
+    # @return [Float]
+    attr_accessor :tax_percentage
+
+    # The amount of the tax
+    # @return [Float]
+    attr_accessor :tax_amount
+
+    # The amount that is taxable
+    # @return [Float]
+    attr_accessor :taxable_amount
+
+    # The amount that is not taxable
+    # @return [Float]
+    attr_accessor :non_taxable_amount
+
+    # The amount that is exempt
+    # @return [Float]
+    attr_accessor :exempt_amount
+
+    # The state assigned number of the jurisdiction
+    # @return [String]
+    attr_accessor :state_assigned_no
+
+    # Name identifying the region within the country
+    # @return [String]
+    attr_accessor :jurisdiction_region
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_component_id'] = 'TaxComponentId'
+      @_hash['type'] = 'Type'
+      @_hash['name'] = 'Name'
+      @_hash['tax_percentage'] = 'TaxPercentage'
+      @_hash['tax_amount'] = 'TaxAmount'
+      @_hash['taxable_amount'] = 'TaxableAmount'
+      @_hash['non_taxable_amount'] = 'NonTaxableAmount'
+      @_hash['exempt_amount'] = 'ExemptAmount'
+      @_hash['state_assigned_no'] = 'StateAssignedNo'
+      @_hash['jurisdiction_region'] = 'JurisdictionRegion'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_component_id
+        type
+        name
+        tax_percentage
+        tax_amount
+        taxable_amount
+        non_taxable_amount
+        exempt_amount
+        state_assigned_no
+        jurisdiction_region
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_component_id: SKIP, type: SKIP, name: SKIP,
+                   tax_percentage: SKIP, tax_amount: SKIP, taxable_amount: SKIP,
+                   non_taxable_amount: SKIP, exempt_amount: SKIP,
+                   state_assigned_no: SKIP, jurisdiction_region: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_component_id = tax_component_id unless tax_component_id == SKIP
+      @type = type unless type == SKIP
+      @name = name unless name == SKIP
+      @tax_percentage = tax_percentage unless tax_percentage == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @taxable_amount = taxable_amount unless taxable_amount == SKIP
+      @non_taxable_amount = non_taxable_amount unless non_taxable_amount == SKIP
+      @exempt_amount = exempt_amount unless exempt_amount == SKIP
+      @state_assigned_no = state_assigned_no unless state_assigned_no == SKIP
+      @jurisdiction_region = jurisdiction_region unless jurisdiction_region == 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.
+      tax_component_id =
+        hash.key?('TaxComponentId') ? hash['TaxComponentId'] : SKIP
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      tax_percentage = hash.key?('TaxPercentage') ? hash['TaxPercentage'] : SKIP
+      tax_amount = hash.key?('TaxAmount') ? hash['TaxAmount'] : SKIP
+      taxable_amount = hash.key?('TaxableAmount') ? hash['TaxableAmount'] : SKIP
+      non_taxable_amount =
+        hash.key?('NonTaxableAmount') ? hash['NonTaxableAmount'] : SKIP
+      exempt_amount = hash.key?('ExemptAmount') ? hash['ExemptAmount'] : SKIP
+      state_assigned_no =
+        hash.key?('StateAssignedNo') ? hash['StateAssignedNo'] : SKIP
+      jurisdiction_region =
+        hash.key?('JurisdictionRegion') ? hash['JurisdictionRegion'] : 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.
+      TaxBreakdownComponent.new(tax_component_id: tax_component_id,
+                                type: type,
+                                name: name,
+                                tax_percentage: tax_percentage,
+                                tax_amount: tax_amount,
+                                taxable_amount: taxable_amount,
+                                non_taxable_amount: non_taxable_amount,
+                                exempt_amount: exempt_amount,
+                                state_assigned_no: state_assigned_no,
+                                jurisdiction_region: jurisdiction_region,
+                                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} tax_component_id: #{@tax_component_id}, type: #{@type}, name: #{@name},"\
+      " tax_percentage: #{@tax_percentage}, tax_amount: #{@tax_amount}, taxable_amount:"\
+      " #{@taxable_amount}, non_taxable_amount: #{@non_taxable_amount}, exempt_amount:"\
+      " #{@exempt_amount}, state_assigned_no: #{@state_assigned_no}, jurisdiction_region:"\
+      " #{@jurisdiction_region}, 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} tax_component_id: #{@tax_component_id.inspect}, type: #{@type.inspect},"\
+      " name: #{@name.inspect}, tax_percentage: #{@tax_percentage.inspect}, tax_amount:"\
+      " #{@tax_amount.inspect}, taxable_amount: #{@taxable_amount.inspect}, non_taxable_amount:"\
+      " #{@non_taxable_amount.inspect}, exempt_amount: #{@exempt_amount.inspect},"\
+      " state_assigned_no: #{@state_assigned_no.inspect}, jurisdiction_region:"\
+      " #{@jurisdiction_region.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/tax_component.rb

@@ -0,0 +1,108 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # TaxComponent Model.
+  class TaxComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of Tax Component
+    # @return [String]
+    attr_accessor :name
+
+    # Tax Rate (up to 4dp)
+    # @return [Float]
+    attr_accessor :rate
+
+    # Boolean to describe if Tax rate is compounded.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_compound
+
+    # Boolean to describe if tax rate is non-recoverable. Non-recoverable rates
+    # are only applicable to Canadian organisations
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_non_recoverable
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'Name'
+      @_hash['rate'] = 'Rate'
+      @_hash['is_compound'] = 'IsCompound'
+      @_hash['is_non_recoverable'] = 'IsNonRecoverable'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        rate
+        is_compound
+        is_non_recoverable
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, rate: SKIP, is_compound: SKIP,
+                   is_non_recoverable: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @rate = rate unless rate == SKIP
+      @is_compound = is_compound unless is_compound == SKIP
+      @is_non_recoverable = is_non_recoverable unless is_non_recoverable == 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.
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      rate = hash.key?('Rate') ? hash['Rate'] : SKIP
+      is_compound = hash.key?('IsCompound') ? hash['IsCompound'] : SKIP
+      is_non_recoverable =
+        hash.key?('IsNonRecoverable') ? hash['IsNonRecoverable'] : 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.
+      TaxComponent.new(name: name,
+                       rate: rate,
+                       is_compound: is_compound,
+                       is_non_recoverable: is_non_recoverable,
+                       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} name: #{@name}, rate: #{@rate}, is_compound: #{@is_compound},"\
+      " is_non_recoverable: #{@is_non_recoverable}, 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} name: #{@name.inspect}, rate: #{@rate.inspect}, is_compound:"\
+      " #{@is_compound.inspect}, is_non_recoverable: #{@is_non_recoverable.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/tax_number_type.rb

@@ -0,0 +1,45 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Identifier of the regional type of tax number, such as US, UK, or other
+  # regional tax identifiers
+  class TaxNumberType
+    TAX_NUMBER_TYPE = [
+      # TODO: Write general description for SSN
+      SSN = 'SSN'.freeze,
+
+      # TODO: Write general description for EIN
+      EIN = 'EIN'.freeze,
+
+      # TODO: Write general description for ITIN
+      ITIN = 'ITIN'.freeze,
+
+      # TODO: Write general description for ATIN
+      ATIN = 'ATIN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TAX_NUMBER_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = SSN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ssn' then SSN
+      when 'ein' then EIN
+      when 'itin' then ITIN
+      when 'atin' then ATIN
+      else
+        default_value
+      end
+    end
+  end
+end