xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/purchase_order.rb

@@ -0,0 +1,408 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # PurchaseOrder Model.
+  class PurchaseOrder < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Contact]
+    attr_accessor :contact
+
+    # See LineItems
+    # @return [Array[LineItem]]
+    attr_accessor :line_items
+
+    # Date purchase order was issued – YYYY-MM-DD. If the Date element is not
+    # specified then it will default to the current date based on the timezone
+    # setting of the organisation
+    # @return [String]
+    attr_accessor :date
+
+    # Date the goods are to be delivered – YYYY-MM-DD
+    # @return [String]
+    attr_accessor :delivery_date
+
+    # 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
+
+    # Unique alpha numeric code identifying purchase order (when missing will
+    # auto-generate from your Organisation Invoice Settings)
+    # @return [String]
+    attr_accessor :purchase_order_number
+
+    # Additional reference number
+    # @return [String]
+    attr_accessor :reference
+
+    # See BrandingThemes
+    # @return [UUID | String]
+    attr_accessor :branding_theme_id
+
+    # 3 letter alpha code for the currency – see list of currency codes
+    # @return [CurrencyCode]
+    attr_accessor :currency_code
+
+    # See Purchase Order Status Codes
+    # @return [Status17]
+    attr_accessor :status
+
+    # Boolean to set whether the purchase order should be marked as “sent”. This
+    # can be set only on purchase orders that have been approved or billed
+    # @return [TrueClass | FalseClass]
+    attr_accessor :sent_to_contact
+
+    # The address the goods are to be delivered to
+    # @return [String]
+    attr_accessor :delivery_address
+
+    # The person that the delivery is going to
+    # @return [String]
+    attr_accessor :attention_to
+
+    # The phone number for the person accepting the delivery
+    # @return [String]
+    attr_accessor :telephone
+
+    # A free text feild for instructions (500 characters max)
+    # @return [String]
+    attr_accessor :delivery_instructions
+
+    # The date the goods are expected to arrive.
+    # @return [String]
+    attr_accessor :expected_arrival_date
+
+    # Xero generated unique identifier for purchase order
+    # @return [UUID | String]
+    attr_accessor :purchase_order_id
+
+    # The currency rate for a multicurrency purchase order. If no rate is
+    # specified, the XE.com day rate is used.
+    # @return [Float]
+    attr_accessor :currency_rate
+
+    # Total of purchase order excluding taxes
+    # @return [Float]
+    attr_accessor :sub_total
+
+    # Total tax on purchase order
+    # @return [Float]
+    attr_accessor :total_tax
+
+    # Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)
+    # @return [Float]
+    attr_accessor :total
+
+    # Total of discounts applied on the purchase order line items
+    # @return [Float]
+    attr_accessor :total_discount
+
+    # boolean to indicate if a purchase order has an attachment
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_attachments
+
+    # Last modified date UTC format
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # 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
+
+    # 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['contact'] = 'Contact'
+      @_hash['line_items'] = 'LineItems'
+      @_hash['date'] = 'Date'
+      @_hash['delivery_date'] = 'DeliveryDate'
+      @_hash['line_amount_types'] = 'LineAmountTypes'
+      @_hash['purchase_order_number'] = 'PurchaseOrderNumber'
+      @_hash['reference'] = 'Reference'
+      @_hash['branding_theme_id'] = 'BrandingThemeID'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['status'] = 'Status'
+      @_hash['sent_to_contact'] = 'SentToContact'
+      @_hash['delivery_address'] = 'DeliveryAddress'
+      @_hash['attention_to'] = 'AttentionTo'
+      @_hash['telephone'] = 'Telephone'
+      @_hash['delivery_instructions'] = 'DeliveryInstructions'
+      @_hash['expected_arrival_date'] = 'ExpectedArrivalDate'
+      @_hash['purchase_order_id'] = 'PurchaseOrderID'
+      @_hash['currency_rate'] = 'CurrencyRate'
+      @_hash['sub_total'] = 'SubTotal'
+      @_hash['total_tax'] = 'TotalTax'
+      @_hash['total'] = 'Total'
+      @_hash['total_discount'] = 'TotalDiscount'
+      @_hash['has_attachments'] = 'HasAttachments'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['status_attribute_string'] = 'StatusAttributeString'
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash['warnings'] = 'Warnings'
+      @_hash['attachments'] = 'Attachments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact
+        line_items
+        date
+        delivery_date
+        line_amount_types
+        purchase_order_number
+        reference
+        branding_theme_id
+        currency_code
+        status
+        sent_to_contact
+        delivery_address
+        attention_to
+        telephone
+        delivery_instructions
+        expected_arrival_date
+        purchase_order_id
+        currency_rate
+        sub_total
+        total_tax
+        total
+        total_discount
+        has_attachments
+        updated_date_utc
+        status_attribute_string
+        validation_errors
+        warnings
+        attachments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contact: SKIP, line_items: SKIP, date: SKIP,
+                   delivery_date: SKIP, line_amount_types: SKIP,
+                   purchase_order_number: SKIP, reference: SKIP,
+                   branding_theme_id: SKIP, currency_code: SKIP, status: SKIP,
+                   sent_to_contact: SKIP, delivery_address: SKIP,
+                   attention_to: SKIP, telephone: SKIP,
+                   delivery_instructions: SKIP, expected_arrival_date: SKIP,
+                   purchase_order_id: SKIP, currency_rate: SKIP,
+                   sub_total: SKIP, total_tax: SKIP, total: SKIP,
+                   total_discount: SKIP, has_attachments: false,
+                   updated_date_utc: SKIP, status_attribute_string: SKIP,
+                   validation_errors: SKIP, warnings: SKIP, attachments: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contact = contact unless contact == SKIP
+      @line_items = line_items unless line_items == SKIP
+      @date = date unless date == SKIP
+      @delivery_date = delivery_date unless delivery_date == SKIP
+      @line_amount_types = line_amount_types unless line_amount_types == SKIP
+      @purchase_order_number = purchase_order_number unless purchase_order_number == SKIP
+      @reference = reference unless reference == SKIP
+      @branding_theme_id = branding_theme_id unless branding_theme_id == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @status = status unless status == SKIP
+      @sent_to_contact = sent_to_contact unless sent_to_contact == SKIP
+      @delivery_address = delivery_address unless delivery_address == SKIP
+      @attention_to = attention_to unless attention_to == SKIP
+      @telephone = telephone unless telephone == SKIP
+      @delivery_instructions = delivery_instructions unless delivery_instructions == SKIP
+      @expected_arrival_date = expected_arrival_date unless expected_arrival_date == SKIP
+      @purchase_order_id = purchase_order_id unless purchase_order_id == 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
+      @has_attachments = has_attachments unless has_attachments == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @status_attribute_string = status_attribute_string unless status_attribute_string == 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.
+      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
+      delivery_date = hash.key?('DeliveryDate') ? hash['DeliveryDate'] : SKIP
+      line_amount_types =
+        hash.key?('LineAmountTypes') ? hash['LineAmountTypes'] : SKIP
+      purchase_order_number =
+        hash.key?('PurchaseOrderNumber') ? hash['PurchaseOrderNumber'] : SKIP
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+      branding_theme_id =
+        hash.key?('BrandingThemeID') ? hash['BrandingThemeID'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      sent_to_contact =
+        hash.key?('SentToContact') ? hash['SentToContact'] : SKIP
+      delivery_address =
+        hash.key?('DeliveryAddress') ? hash['DeliveryAddress'] : SKIP
+      attention_to = hash.key?('AttentionTo') ? hash['AttentionTo'] : SKIP
+      telephone = hash.key?('Telephone') ? hash['Telephone'] : SKIP
+      delivery_instructions =
+        hash.key?('DeliveryInstructions') ? hash['DeliveryInstructions'] : SKIP
+      expected_arrival_date =
+        hash.key?('ExpectedArrivalDate') ? hash['ExpectedArrivalDate'] : SKIP
+      purchase_order_id =
+        hash.key?('PurchaseOrderID') ? hash['PurchaseOrderID'] : 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
+      has_attachments = hash['HasAttachments'] ||= false
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : 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')
+      # 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.
+      PurchaseOrder.new(contact: contact,
+                        line_items: line_items,
+                        date: date,
+                        delivery_date: delivery_date,
+                        line_amount_types: line_amount_types,
+                        purchase_order_number: purchase_order_number,
+                        reference: reference,
+                        branding_theme_id: branding_theme_id,
+                        currency_code: currency_code,
+                        status: status,
+                        sent_to_contact: sent_to_contact,
+                        delivery_address: delivery_address,
+                        attention_to: attention_to,
+                        telephone: telephone,
+                        delivery_instructions: delivery_instructions,
+                        expected_arrival_date: expected_arrival_date,
+                        purchase_order_id: purchase_order_id,
+                        currency_rate: currency_rate,
+                        sub_total: sub_total,
+                        total_tax: total_tax,
+                        total: total,
+                        total_discount: total_discount,
+                        has_attachments: has_attachments,
+                        updated_date_utc: updated_date_utc,
+                        status_attribute_string: status_attribute_string,
+                        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} contact: #{@contact}, line_items: #{@line_items}, date: #{@date},"\
+      " delivery_date: #{@delivery_date}, line_amount_types: #{@line_amount_types},"\
+      " purchase_order_number: #{@purchase_order_number}, reference: #{@reference},"\
+      " branding_theme_id: #{@branding_theme_id}, currency_code: #{@currency_code}, status:"\
+      " #{@status}, sent_to_contact: #{@sent_to_contact}, delivery_address: #{@delivery_address},"\
+      " attention_to: #{@attention_to}, telephone: #{@telephone}, delivery_instructions:"\
+      " #{@delivery_instructions}, expected_arrival_date: #{@expected_arrival_date},"\
+      " purchase_order_id: #{@purchase_order_id}, currency_rate: #{@currency_rate}, sub_total:"\
+      " #{@sub_total}, total_tax: #{@total_tax}, total: #{@total}, total_discount:"\
+      " #{@total_discount}, has_attachments: #{@has_attachments}, updated_date_utc:"\
+      " #{@updated_date_utc}, status_attribute_string: #{@status_attribute_string},"\
+      " 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} contact: #{@contact.inspect}, line_items: #{@line_items.inspect}, date:"\
+      " #{@date.inspect}, delivery_date: #{@delivery_date.inspect}, line_amount_types:"\
+      " #{@line_amount_types.inspect}, purchase_order_number: #{@purchase_order_number.inspect},"\
+      " reference: #{@reference.inspect}, branding_theme_id: #{@branding_theme_id.inspect},"\
+      " currency_code: #{@currency_code.inspect}, status: #{@status.inspect}, sent_to_contact:"\
+      " #{@sent_to_contact.inspect}, delivery_address: #{@delivery_address.inspect}, attention_to:"\
+      " #{@attention_to.inspect}, telephone: #{@telephone.inspect}, delivery_instructions:"\
+      " #{@delivery_instructions.inspect}, expected_arrival_date:"\
+      " #{@expected_arrival_date.inspect}, purchase_order_id: #{@purchase_order_id.inspect},"\
+      " currency_rate: #{@currency_rate.inspect}, sub_total: #{@sub_total.inspect}, total_tax:"\
+      " #{@total_tax.inspect}, total: #{@total.inspect}, total_discount:"\
+      " #{@total_discount.inspect}, has_attachments: #{@has_attachments.inspect},"\
+      " updated_date_utc: #{@updated_date_utc.inspect}, status_attribute_string:"\
+      " #{@status_attribute_string.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/purchase_orders.rb

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

data/lib/xero_ap_is/models/purchases_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 purchases line amount type for a contact Only available when
+  # summaryOnly parameter or paging is used, or when fetch by ContactId or
+  # ContactNumber.
+  class PurchasesDefaultLineAmountType
+    PURCHASES_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?
+
+      PURCHASES_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