xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/quote.rb

@@ -0,0 +1,338 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Quote Model.
+  class Quote < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # QuoteID GUID is automatically generated and is returned after create or
+    # GET.
+    # @return [UUID | String]
+    attr_accessor :quote_id
+
+    # Unique alpha numeric code identifying a quote (Max Length = 255)
+    # @return [String]
+    attr_accessor :quote_number
+
+    # Additional reference number
+    # @return [String]
+    attr_accessor :reference
+
+    # Terms of the quote
+    # @return [String]
+    attr_accessor :terms
+
+    # Terms of the quote
+    # @return [Contact]
+    attr_accessor :contact
+
+    # See LineItems
+    # @return [Array[LineItem]]
+    attr_accessor :line_items
+
+    # Date quote was issued – YYYY-MM-DD. If the Date element is not specified
+    # it will default to the current date based on the timezone setting of the
+    # organisation
+    # @return [String]
+    attr_accessor :date
+
+    # Date the quote was issued (YYYY-MM-DD)
+    # @return [String]
+    attr_accessor :date_string
+
+    # Date the quote expires – YYYY-MM-DD.
+    # @return [String]
+    attr_accessor :expiry_date
+
+    # Date the quote expires – YYYY-MM-DD.
+    # @return [String]
+    attr_accessor :expiry_date_string
+
+    # The status of the quote.
+    # @return [QuoteStatusCodes]
+    attr_accessor :status
+
+    # 3 letter alpha code for the currency – see list of currency codes
+    # @return [CurrencyCode]
+    attr_accessor :currency_code
+
+    # The currency rate for a multicurrency quote
+    # @return [Float]
+    attr_accessor :currency_rate
+
+    # Total of quote excluding taxes.
+    # @return [Float]
+    attr_accessor :sub_total
+
+    # Total tax on quote
+    # @return [Float]
+    attr_accessor :total_tax
+
+    # Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be
+    # ignored if it doesn’t equal the sum of the LineAmounts
+    # @return [Float]
+    attr_accessor :total
+
+    # Total of discounts applied on the quote line items
+    # @return [Float]
+    attr_accessor :total_discount
+
+    # Title text for the quote
+    # @return [String]
+    attr_accessor :title
+
+    # Summary text for the quote
+    # @return [String]
+    attr_accessor :summary
+
+    # See BrandingThemes
+    # @return [UUID | String]
+    attr_accessor :branding_theme_id
+
+    # Last modified date UTC format
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # Line amounts are exclusive of tax by default if you don’t specify this
+    # element. See Line Amount Types
+    # @return [QuoteLineAmountTypes]
+    attr_accessor :line_amount_types
+
+    # A string to indicate if a invoice status
+    # @return [String]
+    attr_accessor :status_attribute_string
+
+    # Displays array of validation error messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :validation_errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['quote_id'] = 'QuoteID'
+      @_hash['quote_number'] = 'QuoteNumber'
+      @_hash['reference'] = 'Reference'
+      @_hash['terms'] = 'Terms'
+      @_hash['contact'] = 'Contact'
+      @_hash['line_items'] = 'LineItems'
+      @_hash['date'] = 'Date'
+      @_hash['date_string'] = 'DateString'
+      @_hash['expiry_date'] = 'ExpiryDate'
+      @_hash['expiry_date_string'] = 'ExpiryDateString'
+      @_hash['status'] = 'Status'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['currency_rate'] = 'CurrencyRate'
+      @_hash['sub_total'] = 'SubTotal'
+      @_hash['total_tax'] = 'TotalTax'
+      @_hash['total'] = 'Total'
+      @_hash['total_discount'] = 'TotalDiscount'
+      @_hash['title'] = 'Title'
+      @_hash['summary'] = 'Summary'
+      @_hash['branding_theme_id'] = 'BrandingThemeID'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['line_amount_types'] = 'LineAmountTypes'
+      @_hash['status_attribute_string'] = 'StatusAttributeString'
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        quote_id
+        quote_number
+        reference
+        terms
+        contact
+        line_items
+        date
+        date_string
+        expiry_date
+        expiry_date_string
+        status
+        currency_code
+        currency_rate
+        sub_total
+        total_tax
+        total
+        total_discount
+        title
+        summary
+        branding_theme_id
+        updated_date_utc
+        line_amount_types
+        status_attribute_string
+        validation_errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(quote_id: SKIP, quote_number: SKIP, reference: SKIP,
+                   terms: SKIP, contact: SKIP, line_items: SKIP, date: SKIP,
+                   date_string: SKIP, expiry_date: SKIP,
+                   expiry_date_string: SKIP, status: SKIP, currency_code: SKIP,
+                   currency_rate: SKIP, sub_total: SKIP, total_tax: SKIP,
+                   total: SKIP, total_discount: SKIP, title: SKIP,
+                   summary: SKIP, branding_theme_id: SKIP,
+                   updated_date_utc: SKIP, line_amount_types: SKIP,
+                   status_attribute_string: SKIP, validation_errors: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @quote_id = quote_id unless quote_id == SKIP
+      @quote_number = quote_number unless quote_number == SKIP
+      @reference = reference unless reference == SKIP
+      @terms = terms unless terms == SKIP
+      @contact = contact unless contact == SKIP
+      @line_items = line_items unless line_items == SKIP
+      @date = date unless date == SKIP
+      @date_string = date_string unless date_string == SKIP
+      @expiry_date = expiry_date unless expiry_date == SKIP
+      @expiry_date_string = expiry_date_string unless expiry_date_string == SKIP
+      @status = status unless status == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_rate = currency_rate unless currency_rate == SKIP
+      @sub_total = sub_total unless sub_total == SKIP
+      @total_tax = total_tax unless total_tax == SKIP
+      @total = total unless total == SKIP
+      @total_discount = total_discount unless total_discount == SKIP
+      @title = title unless title == SKIP
+      @summary = summary unless summary == SKIP
+      @branding_theme_id = branding_theme_id unless branding_theme_id == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @line_amount_types = line_amount_types unless line_amount_types == SKIP
+      @status_attribute_string = status_attribute_string unless status_attribute_string == SKIP
+      @validation_errors = validation_errors unless validation_errors == 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.
+      quote_id = hash.key?('QuoteID') ? hash['QuoteID'] : SKIP
+      quote_number = hash.key?('QuoteNumber') ? hash['QuoteNumber'] : SKIP
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+      terms = hash.key?('Terms') ? hash['Terms'] : SKIP
+      contact = Contact.from_hash(hash['Contact']) if hash['Contact']
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['LineItems'].nil?
+        line_items = []
+        hash['LineItems'].each do |structure|
+          line_items << (LineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('LineItems')
+      date = hash.key?('Date') ? hash['Date'] : SKIP
+      date_string = hash.key?('DateString') ? hash['DateString'] : SKIP
+      expiry_date = hash.key?('ExpiryDate') ? hash['ExpiryDate'] : SKIP
+      expiry_date_string =
+        hash.key?('ExpiryDateString') ? hash['ExpiryDateString'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      currency_rate = hash.key?('CurrencyRate') ? hash['CurrencyRate'] : SKIP
+      sub_total = hash.key?('SubTotal') ? hash['SubTotal'] : SKIP
+      total_tax = hash.key?('TotalTax') ? hash['TotalTax'] : SKIP
+      total = hash.key?('Total') ? hash['Total'] : SKIP
+      total_discount = hash.key?('TotalDiscount') ? hash['TotalDiscount'] : SKIP
+      title = hash.key?('Title') ? hash['Title'] : SKIP
+      summary = hash.key?('Summary') ? hash['Summary'] : SKIP
+      branding_theme_id =
+        hash.key?('BrandingThemeID') ? hash['BrandingThemeID'] : SKIP
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      line_amount_types =
+        hash.key?('LineAmountTypes') ? hash['LineAmountTypes'] : SKIP
+      status_attribute_string =
+        hash.key?('StatusAttributeString') ? hash['StatusAttributeString'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      validation_errors = nil
+      unless hash['ValidationErrors'].nil?
+        validation_errors = []
+        hash['ValidationErrors'].each do |structure|
+          validation_errors << (ValidationError.from_hash(structure) if structure)
+        end
+      end
+
+      validation_errors = SKIP unless hash.key?('ValidationErrors')
+
+      # 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.
+      Quote.new(quote_id: quote_id,
+                quote_number: quote_number,
+                reference: reference,
+                terms: terms,
+                contact: contact,
+                line_items: line_items,
+                date: date,
+                date_string: date_string,
+                expiry_date: expiry_date,
+                expiry_date_string: expiry_date_string,
+                status: status,
+                currency_code: currency_code,
+                currency_rate: currency_rate,
+                sub_total: sub_total,
+                total_tax: total_tax,
+                total: total,
+                total_discount: total_discount,
+                title: title,
+                summary: summary,
+                branding_theme_id: branding_theme_id,
+                updated_date_utc: updated_date_utc,
+                line_amount_types: line_amount_types,
+                status_attribute_string: status_attribute_string,
+                validation_errors: validation_errors,
+                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} quote_id: #{@quote_id}, quote_number: #{@quote_number}, reference:"\
+      " #{@reference}, terms: #{@terms}, contact: #{@contact}, line_items: #{@line_items}, date:"\
+      " #{@date}, date_string: #{@date_string}, expiry_date: #{@expiry_date}, expiry_date_string:"\
+      " #{@expiry_date_string}, status: #{@status}, currency_code: #{@currency_code},"\
+      " currency_rate: #{@currency_rate}, sub_total: #{@sub_total}, total_tax: #{@total_tax},"\
+      " total: #{@total}, total_discount: #{@total_discount}, title: #{@title}, summary:"\
+      " #{@summary}, branding_theme_id: #{@branding_theme_id}, updated_date_utc:"\
+      " #{@updated_date_utc}, line_amount_types: #{@line_amount_types}, status_attribute_string:"\
+      " #{@status_attribute_string}, validation_errors: #{@validation_errors},"\
+      " 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} quote_id: #{@quote_id.inspect}, quote_number: #{@quote_number.inspect},"\
+      " reference: #{@reference.inspect}, terms: #{@terms.inspect}, contact: #{@contact.inspect},"\
+      " line_items: #{@line_items.inspect}, date: #{@date.inspect}, date_string:"\
+      " #{@date_string.inspect}, expiry_date: #{@expiry_date.inspect}, expiry_date_string:"\
+      " #{@expiry_date_string.inspect}, status: #{@status.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, currency_rate: #{@currency_rate.inspect}, sub_total:"\
+      " #{@sub_total.inspect}, total_tax: #{@total_tax.inspect}, total: #{@total.inspect},"\
+      " total_discount: #{@total_discount.inspect}, title: #{@title.inspect}, summary:"\
+      " #{@summary.inspect}, branding_theme_id: #{@branding_theme_id.inspect}, updated_date_utc:"\
+      " #{@updated_date_utc.inspect}, line_amount_types: #{@line_amount_types.inspect},"\
+      " status_attribute_string: #{@status_attribute_string.inspect}, validation_errors:"\
+      " #{@validation_errors.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/quote_line_amount_types.rb

@@ -0,0 +1,41 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Line amounts are exclusive of tax by default if you don’t specify this
+  # element. See Line Amount Types
+  class QuoteLineAmountTypes
+    QUOTE_LINE_AMOUNT_TYPES = [
+      # TODO: Write general description for EXCLUSIVE
+      EXCLUSIVE = 'EXCLUSIVE'.freeze,
+
+      # TODO: Write general description for INCLUSIVE
+      INCLUSIVE = 'INCLUSIVE'.freeze,
+
+      # TODO: Write general description for NOTAX
+      NOTAX = 'NOTAX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      QUOTE_LINE_AMOUNT_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = EXCLUSIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'exclusive' then EXCLUSIVE
+      when 'inclusive' then INCLUSIVE
+      when 'notax' then NOTAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/quote_status_codes.rb

@@ -0,0 +1,52 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The status of the quote.
+  class QuoteStatusCodes
+    QUOTE_STATUS_CODES = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'DRAFT'.freeze,
+
+      # TODO: Write general description for SENT
+      SENT = 'SENT'.freeze,
+
+      # TODO: Write general description for DECLINED
+      DECLINED = 'DECLINED'.freeze,
+
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'ACCEPTED'.freeze,
+
+      # TODO: Write general description for INVOICED
+      INVOICED = 'INVOICED'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      QUOTE_STATUS_CODES.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 'sent' then SENT
+      when 'declined' then DECLINED
+      when 'accepted' then ACCEPTED
+      when 'invoiced' then INVOICED
+      when 'deleted' then DELETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/quotes.rb

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