xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/report_with_rows.rb

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

data/lib/xero_ap_is/models/reports.rb

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

data/lib/xero_ap_is/models/request_empty.rb

@@ -0,0 +1,75 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # RequestEmpty Model.
+  class RequestEmpty < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Need at least one field to create an empty JSON payload
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'Status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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.
+      RequestEmpty.new(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} 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} status: #{@status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/resource_validation_errors_element.rb

@@ -0,0 +1,116 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # ResourceValidationErrorsElement Model.
+  class ResourceValidationErrorsElement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The field name of the erroneous field
+    # @return [String]
+    attr_accessor :resource_name
+
+    # Explanation of the resource validation error
+    # @return [String]
+    attr_accessor :localised_message
+
+    # Internal type of the resource error message
+    # @return [String]
+    attr_accessor :type
+
+    # Title of the resource validation error
+    # @return [String]
+    attr_accessor :title
+
+    # Detail of the resource validation error
+    # @return [String]
+    attr_accessor :detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['resource_name'] = 'resourceName'
+      @_hash['localised_message'] = 'localisedMessage'
+      @_hash['type'] = 'type'
+      @_hash['title'] = 'title'
+      @_hash['detail'] = 'detail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        resource_name
+        localised_message
+        type
+        title
+        detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(resource_name: SKIP, localised_message: SKIP, type: SKIP,
+                   title: SKIP, detail: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @resource_name = resource_name unless resource_name == SKIP
+      @localised_message = localised_message unless localised_message == SKIP
+      @type = type unless type == SKIP
+      @title = title unless title == SKIP
+      @detail = detail unless detail == 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.
+      resource_name = hash.key?('resourceName') ? hash['resourceName'] : SKIP
+      localised_message =
+        hash.key?('localisedMessage') ? hash['localisedMessage'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      detail = hash.key?('detail') ? hash['detail'] : 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.
+      ResourceValidationErrorsElement.new(resource_name: resource_name,
+                                          localised_message: localised_message,
+                                          type: type,
+                                          title: title,
+                                          detail: detail,
+                                          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} resource_name: #{@resource_name}, localised_message: #{@localised_message},"\
+      " type: #{@type}, title: #{@title}, detail: #{@detail}, 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} resource_name: #{@resource_name.inspect}, localised_message:"\
+      " #{@localised_message.inspect}, type: #{@type.inspect}, title: #{@title.inspect}, detail:"\
+      " #{@detail.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/row_type.rb

@@ -0,0 +1,44 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # RowType.
+  class RowType
+    ROW_TYPE = [
+      # TODO: Write general description for HEADER
+      HEADER = 'Header'.freeze,
+
+      # TODO: Write general description for SECTION
+      SECTION = 'Section'.freeze,
+
+      # TODO: Write general description for ROW
+      ROW = 'Row'.freeze,
+
+      # TODO: Write general description for SUMMARYROW
+      SUMMARYROW = 'SummaryRow'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ROW_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = HEADER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'header' then HEADER
+      when 'section' then SECTION
+      when 'row' then ROW
+      when 'summaryrow' then SUMMARYROW
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/sales_default_line_amount_type.rb

@@ -0,0 +1,42 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The default sales line amount type for a contact. Only available when
+  # summaryOnly parameter or paging is used, or when fetch by ContactId or
+  # ContactNumber.
+  class SalesDefaultLineAmountType
+    SALES_DEFAULT_LINE_AMOUNT_TYPE = [
+      # TODO: Write general description for INCLUSIVE
+      INCLUSIVE = 'INCLUSIVE'.freeze,
+
+      # TODO: Write general description for EXCLUSIVE
+      EXCLUSIVE = 'EXCLUSIVE'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SALES_DEFAULT_LINE_AMOUNT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = INCLUSIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'inclusive' then INCLUSIVE
+      when 'exclusive' then EXCLUSIVE
+      when 'none' then NONE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/sales_tax_basis.rb

@@ -0,0 +1,60 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The accounting basis used for tax returns. See Sales Tax Basis
+  class SalesTaxBasis
+    SALES_TAX_BASIS = [
+      # TODO: Write general description for PAYMENTS
+      PAYMENTS = 'PAYMENTS'.freeze,
+
+      # TODO: Write general description for INVOICE
+      INVOICE = 'INVOICE'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'CASH'.freeze,
+
+      # TODO: Write general description for ACCRUAL
+      ACCRUAL = 'ACCRUAL'.freeze,
+
+      # TODO: Write general description for FLATRATECASH
+      FLATRATECASH = 'FLATRATECASH'.freeze,
+
+      # TODO: Write general description for FLATRATEACCRUAL
+      FLATRATEACCRUAL = 'FLATRATEACCRUAL'.freeze,
+
+      # TODO: Write general description for ACCRUALS
+      ACCRUALS = 'ACCRUALS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SALES_TAX_BASIS.include?(value)
+    end
+
+    def self.from_value(value, default_value = PAYMENTS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'payments' then PAYMENTS
+      when 'invoice' then INVOICE
+      when 'none' then NONE
+      when 'cash' then CASH
+      when 'accrual' then ACCRUAL
+      when 'flatratecash' then FLATRATECASH
+      when 'flatrateaccrual' then FLATRATEACCRUAL
+      when 'accruals' then ACCRUALS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/sales_tax_period.rb

@@ -0,0 +1,88 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The frequency with which tax returns are processed. See Sales Tax Period
+  class SalesTaxPeriod
+    SALES_TAX_PERIOD = [
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY1
+      QUARTERLY1 = 'QUARTERLY1'.freeze,
+
+      # TODO: Write general description for QUARTERLY2
+      QUARTERLY2 = 'QUARTERLY2'.freeze,
+
+      # TODO: Write general description for QUARTERLY3
+      QUARTERLY3 = 'QUARTERLY3'.freeze,
+
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for ONEMONTHS
+      ONEMONTHS = 'ONEMONTHS'.freeze,
+
+      # TODO: Write general description for TWOMONTHS
+      TWOMONTHS = 'TWOMONTHS'.freeze,
+
+      # TODO: Write general description for SIXMONTHS
+      SIXMONTHS = 'SIXMONTHS'.freeze,
+
+      # TODO: Write general description for ENUM_1MONTHLY
+      ENUM_1MONTHLY = '1MONTHLY'.freeze,
+
+      # TODO: Write general description for ENUM_2MONTHLY
+      ENUM_2MONTHLY = '2MONTHLY'.freeze,
+
+      # TODO: Write general description for ENUM_3MONTHLY
+      ENUM_3MONTHLY = '3MONTHLY'.freeze,
+
+      # TODO: Write general description for ENUM_6MONTHLY
+      ENUM_6MONTHLY = '6MONTHLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for YEARLY
+      YEARLY = 'YEARLY'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SALES_TAX_PERIOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = MONTHLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'monthly' then MONTHLY
+      when 'quarterly1' then QUARTERLY1
+      when 'quarterly2' then QUARTERLY2
+      when 'quarterly3' then QUARTERLY3
+      when 'annually' then ANNUALLY
+      when 'onemonths' then ONEMONTHS
+      when 'twomonths' then TWOMONTHS
+      when 'sixmonths' then SIXMONTHS
+      when 'enum_1monthly' then ENUM_1MONTHLY
+      when 'enum_2monthly' then ENUM_2MONTHLY
+      when 'enum_3monthly' then ENUM_3MONTHLY
+      when 'enum_6monthly' then ENUM_6MONTHLY
+      when 'quarterly' then QUARTERLY
+      when 'yearly' then YEARLY
+      when 'none' then NONE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/sales_tracking_category.rb

@@ -0,0 +1,89 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # SalesTrackingCategory Model.
+  class SalesTrackingCategory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The default sales tracking category name for contacts
+    # @return [String]
+    attr_accessor :tracking_category_name
+
+    # The default purchase tracking category name for contacts
+    # @return [String]
+    attr_accessor :tracking_option_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tracking_category_name'] = 'TrackingCategoryName'
+      @_hash['tracking_option_name'] = 'TrackingOptionName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tracking_category_name
+        tracking_option_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tracking_category_name: SKIP, tracking_option_name: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tracking_category_name = tracking_category_name unless tracking_category_name == SKIP
+      @tracking_option_name = tracking_option_name unless tracking_option_name == 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.
+      tracking_category_name =
+        hash.key?('TrackingCategoryName') ? hash['TrackingCategoryName'] : SKIP
+      tracking_option_name =
+        hash.key?('TrackingOptionName') ? hash['TrackingOptionName'] : 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.
+      SalesTrackingCategory.new(tracking_category_name: tracking_category_name,
+                                tracking_option_name: tracking_option_name,
+                                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} tracking_category_name: #{@tracking_category_name}, tracking_option_name:"\
+      " #{@tracking_option_name}, 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} tracking_category_name: #{@tracking_category_name.inspect},"\
+      " tracking_option_name: #{@tracking_option_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end