xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/receipt.rb

@@ -0,0 +1,287 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Receipt Model.
+  class Receipt < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date of receipt – YYYY-MM-DD
+    # @return [String]
+    attr_accessor :date
+
+    # Date of receipt – YYYY-MM-DD
+    # @return [Contact]
+    attr_accessor :contact
+
+    # Date of receipt – YYYY-MM-DD
+    # @return [Array[LineItem]]
+    attr_accessor :line_items
+
+    # Date of receipt – YYYY-MM-DD
+    # @return [User]
+    attr_accessor :user
+
+    # Additional reference number
+    # @return [String]
+    attr_accessor :reference
+
+    # Line amounts are exclusive of tax by default if you don’t specify this
+    # element. See Line Amount Types
+    # @return [LineAmountTypes]
+    attr_accessor :line_amount_types
+
+    # Total of receipt excluding taxes
+    # @return [Float]
+    attr_accessor :sub_total
+
+    # Total tax on receipt
+    # @return [Float]
+    attr_accessor :total_tax
+
+    # Total of receipt tax inclusive (i.e. SubTotal + TotalTax)
+    # @return [Float]
+    attr_accessor :total
+
+    # Xero generated unique identifier for receipt
+    # @return [UUID | String]
+    attr_accessor :receipt_id
+
+    # Current status of receipt – see status types
+    # @return [Status13]
+    attr_accessor :status
+
+    # Xero generated sequence number for receipt in current claim for a given
+    # user
+    # @return [String]
+    attr_accessor :receipt_number
+
+    # Last modified date UTC format
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # boolean to indicate if a receipt has an attachment
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_attachments
+
+    # URL link to a source document – shown as “Go to [appName]” in the Xero app
+    # @return [String]
+    attr_accessor :url
+
+    # Displays array of validation error messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :validation_errors
+
+    # Displays array of warning messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :warnings
+
+    # Displays array of attachments from the API
+    # @return [Array[Attachment]]
+    attr_accessor :attachments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date'] = 'Date'
+      @_hash['contact'] = 'Contact'
+      @_hash['line_items'] = 'LineItems'
+      @_hash['user'] = 'User'
+      @_hash['reference'] = 'Reference'
+      @_hash['line_amount_types'] = 'LineAmountTypes'
+      @_hash['sub_total'] = 'SubTotal'
+      @_hash['total_tax'] = 'TotalTax'
+      @_hash['total'] = 'Total'
+      @_hash['receipt_id'] = 'ReceiptID'
+      @_hash['status'] = 'Status'
+      @_hash['receipt_number'] = 'ReceiptNumber'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['has_attachments'] = 'HasAttachments'
+      @_hash['url'] = 'Url'
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash['warnings'] = 'Warnings'
+      @_hash['attachments'] = 'Attachments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date
+        contact
+        line_items
+        user
+        reference
+        line_amount_types
+        sub_total
+        total_tax
+        total
+        receipt_id
+        status
+        receipt_number
+        updated_date_utc
+        has_attachments
+        url
+        validation_errors
+        warnings
+        attachments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date: SKIP, contact: SKIP, line_items: SKIP, user: SKIP,
+                   reference: SKIP, line_amount_types: SKIP, sub_total: SKIP,
+                   total_tax: SKIP, total: SKIP, receipt_id: SKIP, status: SKIP,
+                   receipt_number: SKIP, updated_date_utc: SKIP,
+                   has_attachments: false, url: SKIP, validation_errors: SKIP,
+                   warnings: SKIP, attachments: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @date = date unless date == SKIP
+      @contact = contact unless contact == SKIP
+      @line_items = line_items unless line_items == SKIP
+      @user = user unless user == SKIP
+      @reference = reference unless reference == SKIP
+      @line_amount_types = line_amount_types unless line_amount_types == SKIP
+      @sub_total = sub_total unless sub_total == SKIP
+      @total_tax = total_tax unless total_tax == SKIP
+      @total = total unless total == SKIP
+      @receipt_id = receipt_id unless receipt_id == SKIP
+      @status = status unless status == SKIP
+      @receipt_number = receipt_number unless receipt_number == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @has_attachments = has_attachments unless has_attachments == SKIP
+      @url = url unless url == SKIP
+      @validation_errors = validation_errors unless validation_errors == SKIP
+      @warnings = warnings unless warnings == SKIP
+      @attachments = attachments unless attachments == 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.
+      date = hash.key?('Date') ? hash['Date'] : 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')
+      user = User.from_hash(hash['User']) if hash['User']
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+      line_amount_types =
+        hash.key?('LineAmountTypes') ? hash['LineAmountTypes'] : SKIP
+      sub_total = hash.key?('SubTotal') ? hash['SubTotal'] : SKIP
+      total_tax = hash.key?('TotalTax') ? hash['TotalTax'] : SKIP
+      total = hash.key?('Total') ? hash['Total'] : SKIP
+      receipt_id = hash.key?('ReceiptID') ? hash['ReceiptID'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      receipt_number = hash.key?('ReceiptNumber') ? hash['ReceiptNumber'] : SKIP
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      has_attachments = hash['HasAttachments'] ||= false
+      url = hash.key?('Url') ? hash['Url'] : 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')
+      # Parameter is an array, so we need to iterate through it
+      warnings = nil
+      unless hash['Warnings'].nil?
+        warnings = []
+        hash['Warnings'].each do |structure|
+          warnings << (ValidationError.from_hash(structure) if structure)
+        end
+      end
+
+      warnings = SKIP unless hash.key?('Warnings')
+      # Parameter is an array, so we need to iterate through it
+      attachments = nil
+      unless hash['Attachments'].nil?
+        attachments = []
+        hash['Attachments'].each do |structure|
+          attachments << (Attachment.from_hash(structure) if structure)
+        end
+      end
+
+      attachments = SKIP unless hash.key?('Attachments')
+
+      # 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.
+      Receipt.new(date: date,
+                  contact: contact,
+                  line_items: line_items,
+                  user: user,
+                  reference: reference,
+                  line_amount_types: line_amount_types,
+                  sub_total: sub_total,
+                  total_tax: total_tax,
+                  total: total,
+                  receipt_id: receipt_id,
+                  status: status,
+                  receipt_number: receipt_number,
+                  updated_date_utc: updated_date_utc,
+                  has_attachments: has_attachments,
+                  url: url,
+                  validation_errors: validation_errors,
+                  warnings: warnings,
+                  attachments: attachments,
+                  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} date: #{@date}, contact: #{@contact}, line_items: #{@line_items}, user:"\
+      " #{@user}, reference: #{@reference}, line_amount_types: #{@line_amount_types}, sub_total:"\
+      " #{@sub_total}, total_tax: #{@total_tax}, total: #{@total}, receipt_id: #{@receipt_id},"\
+      " status: #{@status}, receipt_number: #{@receipt_number}, updated_date_utc:"\
+      " #{@updated_date_utc}, has_attachments: #{@has_attachments}, url: #{@url},"\
+      " validation_errors: #{@validation_errors}, warnings: #{@warnings}, attachments:"\
+      " #{@attachments}, 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} date: #{@date.inspect}, contact: #{@contact.inspect}, line_items:"\
+      " #{@line_items.inspect}, user: #{@user.inspect}, reference: #{@reference.inspect},"\
+      " line_amount_types: #{@line_amount_types.inspect}, sub_total: #{@sub_total.inspect},"\
+      " total_tax: #{@total_tax.inspect}, total: #{@total.inspect}, receipt_id:"\
+      " #{@receipt_id.inspect}, status: #{@status.inspect}, receipt_number:"\
+      " #{@receipt_number.inspect}, updated_date_utc: #{@updated_date_utc.inspect},"\
+      " has_attachments: #{@has_attachments.inspect}, url: #{@url.inspect}, validation_errors:"\
+      " #{@validation_errors.inspect}, warnings: #{@warnings.inspect}, attachments:"\
+      " #{@attachments.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/receipts.rb

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

data/lib/xero_ap_is/models/refresh_token.rb

@@ -0,0 +1,106 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # RefreshToken Model.
+  class RefreshToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Xero grant type
+    # @return [String]
+    attr_accessor :grant_type
+
+    # refresh token provided during authentication flow
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # client id for Xero app
+    # @return [String]
+    attr_accessor :client_id
+
+    # client secret for Xero app 2
+    # @return [String]
+    attr_accessor :client_secret
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grant_type'] = 'grant_type'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash['client_id'] = 'client_id'
+      @_hash['client_secret'] = 'client_secret'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        grant_type
+        refresh_token
+        client_id
+        client_secret
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grant_type: SKIP, refresh_token: SKIP, client_id: SKIP,
+                   client_secret: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @grant_type = grant_type unless grant_type == SKIP
+      @refresh_token = refresh_token unless refresh_token == SKIP
+      @client_id = client_id unless client_id == SKIP
+      @client_secret = client_secret unless client_secret == 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.
+      grant_type = hash.key?('grant_type') ? hash['grant_type'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      client_secret = hash.key?('client_secret') ? hash['client_secret'] : 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.
+      RefreshToken.new(grant_type: grant_type,
+                       refresh_token: refresh_token,
+                       client_id: client_id,
+                       client_secret: client_secret,
+                       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} grant_type: #{@grant_type}, refresh_token: #{@refresh_token}, client_id:"\
+      " #{@client_id}, client_secret: #{@client_secret}, 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} grant_type: #{@grant_type.inspect}, refresh_token:"\
+      " #{@refresh_token.inspect}, client_id: #{@client_id.inspect}, client_secret:"\
+      " #{@client_secret.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end