xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/cis_setting.rb

@@ -0,0 +1,86 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # CisSetting Model.
+  class CisSetting < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boolean that describes if the contact is a CIS Subcontractor
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cis_enabled
+
+    # CIS Deduction rate for the contact if he is a subcontractor. If the
+    # contact is not CISEnabled, then the rate is not returned
+    # @return [Float]
+    attr_accessor :rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cis_enabled'] = 'CISEnabled'
+      @_hash['rate'] = 'Rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cis_enabled
+        rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cis_enabled: SKIP, rate: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cis_enabled = cis_enabled unless cis_enabled == SKIP
+      @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_enabled = hash.key?('CISEnabled') ? hash['CISEnabled'] : 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.
+      CisSetting.new(cis_enabled: cis_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_enabled: #{@cis_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_enabled: #{@cis_enabled.inspect}, rate: #{@rate.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/cis_settings.rb

@@ -0,0 +1,85 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # CisSettings Model.
+  class CisSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CisSetting]]
+    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 << (CisSetting.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.
+      CisSettings.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

data/lib/xero_ap_is/models/class1.rb

@@ -0,0 +1,113 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Organisation Classes describe which plan the Xero organisation is on (e.g.
+  # DEMO, TRIAL, PREMIUM)
+  class Class1
+    CLASS1 = [
+      # TODO: Write general description for DEMO
+      DEMO = 'DEMO'.freeze,
+
+      # TODO: Write general description for TRIAL
+      TRIAL = 'TRIAL'.freeze,
+
+      # TODO: Write general description for STARTER
+      STARTER = 'STARTER'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for PREMIUM
+      PREMIUM = 'PREMIUM'.freeze,
+
+      # TODO: Write general description for PREMIUM_20
+      PREMIUM_20 = 'PREMIUM_20'.freeze,
+
+      # TODO: Write general description for PREMIUM_50
+      PREMIUM_50 = 'PREMIUM_50'.freeze,
+
+      # TODO: Write general description for PREMIUM_100
+      PREMIUM_100 = 'PREMIUM_100'.freeze,
+
+      # TODO: Write general description for LEDGER
+      LEDGER = 'LEDGER'.freeze,
+
+      # TODO: Write general description for GST_CASHBOOK
+      GST_CASHBOOK = 'GST_CASHBOOK'.freeze,
+
+      # TODO: Write general description for NON_GST_CASHBOOK
+      NON_GST_CASHBOOK = 'NON_GST_CASHBOOK'.freeze,
+
+      # TODO: Write general description for ULTIMATE
+      ULTIMATE = 'ULTIMATE'.freeze,
+
+      # TODO: Write general description for LITE
+      LITE = 'LITE'.freeze,
+
+      # TODO: Write general description for ULTIMATE_10
+      ULTIMATE_10 = 'ULTIMATE_10'.freeze,
+
+      # TODO: Write general description for ULTIMATE_20
+      ULTIMATE_20 = 'ULTIMATE_20'.freeze,
+
+      # TODO: Write general description for ULTIMATE_50
+      ULTIMATE_50 = 'ULTIMATE_50'.freeze,
+
+      # TODO: Write general description for ULTIMATE_100
+      ULTIMATE_100 = 'ULTIMATE_100'.freeze,
+
+      # TODO: Write general description for IGNITE
+      IGNITE = 'IGNITE'.freeze,
+
+      # TODO: Write general description for GROW
+      GROW = 'GROW'.freeze,
+
+      # TODO: Write general description for COMPREHENSIVE
+      COMPREHENSIVE = 'COMPREHENSIVE'.freeze,
+
+      # TODO: Write general description for SIMPLE
+      SIMPLE = 'SIMPLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CLASS1.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEMO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'demo' then DEMO
+      when 'trial' then TRIAL
+      when 'starter' then STARTER
+      when 'standard' then STANDARD
+      when 'premium' then PREMIUM
+      when 'premium_20' then PREMIUM_20
+      when 'premium_50' then PREMIUM_50
+      when 'premium_100' then PREMIUM_100
+      when 'ledger' then LEDGER
+      when 'gst_cashbook' then GST_CASHBOOK
+      when 'non_gst_cashbook' then NON_GST_CASHBOOK
+      when 'ultimate' then ULTIMATE
+      when 'lite' then LITE
+      when 'ultimate_10' then ULTIMATE_10
+      when 'ultimate_20' then ULTIMATE_20
+      when 'ultimate_50' then ULTIMATE_50
+      when 'ultimate_100' then ULTIMATE_100
+      when 'ignite' then IGNITE
+      when 'grow' then GROW
+      when 'comprehensive' then COMPREHENSIVE
+      when 'simple' then SIMPLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/connection.rb

@@ -0,0 +1,155 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module XeroApIs
+  # Connection Model.
+  class Connection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Xero identifier
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Xero identifier of organisation
+    # @return [UUID | String]
+    attr_accessor :tenant_id
+
+    # Identifier shared across connections authorised at the same time
+    # @return [UUID | String]
+    attr_accessor :auth_event_id
+
+    # Xero tenant type (i.e. ORGANISATION, PRACTICE)
+    # @return [String]
+    attr_accessor :tenant_type
+
+    # Xero tenant name
+    # @return [String]
+    attr_accessor :tenant_name
+
+    # The date when the user connected this tenant to your app
+    # @return [DateTime]
+    attr_accessor :created_date_utc
+
+    # The date when the user most recently connected this tenant to your app.
+    # May differ to the created date if the user has disconnected and
+    # subsequently reconnected this tenant to your app.
+    # @return [DateTime]
+    attr_accessor :updated_date_utc
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['tenant_id'] = 'tenantId'
+      @_hash['auth_event_id'] = 'authEventId'
+      @_hash['tenant_type'] = 'tenantType'
+      @_hash['tenant_name'] = 'tenantName'
+      @_hash['created_date_utc'] = 'createdDateUtc'
+      @_hash['updated_date_utc'] = 'updatedDateUtc'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        tenant_id
+        auth_event_id
+        tenant_type
+        tenant_name
+        created_date_utc
+        updated_date_utc
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, tenant_id: SKIP, auth_event_id: SKIP,
+                   tenant_type: SKIP, tenant_name: SKIP, created_date_utc: SKIP,
+                   updated_date_utc: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @tenant_id = tenant_id unless tenant_id == SKIP
+      @auth_event_id = auth_event_id unless auth_event_id == SKIP
+      @tenant_type = tenant_type unless tenant_type == SKIP
+      @tenant_name = tenant_name unless tenant_name == SKIP
+      @created_date_utc = created_date_utc unless created_date_utc == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      tenant_id = hash.key?('tenantId') ? hash['tenantId'] : SKIP
+      auth_event_id = hash.key?('authEventId') ? hash['authEventId'] : SKIP
+      tenant_type = hash.key?('tenantType') ? hash['tenantType'] : SKIP
+      tenant_name = hash.key?('tenantName') ? hash['tenantName'] : SKIP
+      created_date_utc = if hash.key?('createdDateUtc')
+                           (DateTimeHelper.from_rfc3339(hash['createdDateUtc']) if hash['createdDateUtc'])
+                         else
+                           SKIP
+                         end
+      updated_date_utc = if hash.key?('updatedDateUtc')
+                           (DateTimeHelper.from_rfc3339(hash['updatedDateUtc']) if hash['updatedDateUtc'])
+                         else
+                           SKIP
+                         end
+
+      # 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.
+      Connection.new(id: id,
+                     tenant_id: tenant_id,
+                     auth_event_id: auth_event_id,
+                     tenant_type: tenant_type,
+                     tenant_name: tenant_name,
+                     created_date_utc: created_date_utc,
+                     updated_date_utc: updated_date_utc,
+                     additional_properties: additional_properties)
+    end
+
+    def to_custom_created_date_utc
+      DateTimeHelper.to_rfc3339(created_date_utc)
+    end
+
+    def to_custom_updated_date_utc
+      DateTimeHelper.to_rfc3339(updated_date_utc)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, tenant_id: #{@tenant_id}, auth_event_id: #{@auth_event_id},"\
+      " tenant_type: #{@tenant_type}, tenant_name: #{@tenant_name}, created_date_utc:"\
+      " #{@created_date_utc}, updated_date_utc: #{@updated_date_utc}, 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} id: #{@id.inspect}, tenant_id: #{@tenant_id.inspect}, auth_event_id:"\
+      " #{@auth_event_id.inspect}, tenant_type: #{@tenant_type.inspect}, tenant_name:"\
+      " #{@tenant_name.inspect}, created_date_utc: #{@created_date_utc.inspect}, updated_date_utc:"\
+      " #{@updated_date_utc.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end