xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/repeating_invoice.rb

@@ -0,0 +1,290 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # RepeatingInvoice Model.
+  class RepeatingInvoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # See Invoice Types
+    # @return [Type10]
+    attr_accessor :type
+
+    # See Invoice Types
+    # @return [Contact]
+    attr_accessor :contact
+
+    # See Invoice Types
+    # @return [Schedule]
+    attr_accessor :schedule
+
+    # See LineItems
+    # @return [Array[LineItem]]
+    attr_accessor :line_items
+
+    # 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
+
+    # ACCREC only – 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
+
+    # One of the following - DRAFT or AUTHORISED – See Invoice Status Codes
+    # @return [Status18]
+    attr_accessor :status
+
+    # Total of invoice excluding taxes
+    # @return [Float]
+    attr_accessor :sub_total
+
+    # Total tax on invoice
+    # @return [Float]
+    attr_accessor :total_tax
+
+    # Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)
+    # @return [Float]
+    attr_accessor :total
+
+    # Xero generated unique identifier for repeating invoice template
+    # @return [UUID | String]
+    attr_accessor :repeating_invoice_id
+
+    # Xero generated unique identifier for repeating invoice template
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Boolean to indicate if an invoice has an attachment
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_attachments
+
+    # Displays array of attachments from the API
+    # @return [Array[Attachment]]
+    attr_accessor :attachments
+
+    # Boolean to indicate whether the invoice has been approved for sending
+    # @return [TrueClass | FalseClass]
+    attr_accessor :approved_for_sending
+
+    # Boolean to indicate whether a copy is sent to sender's email
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_copy
+
+    # Boolean to indicate whether the invoice in the Xero app displays as "sent"
+    # @return [TrueClass | FalseClass]
+    attr_accessor :mark_as_sent
+
+    # Boolean to indicate whether to include PDF attachment
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_pdf
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'Type'
+      @_hash['contact'] = 'Contact'
+      @_hash['schedule'] = 'Schedule'
+      @_hash['line_items'] = 'LineItems'
+      @_hash['line_amount_types'] = 'LineAmountTypes'
+      @_hash['reference'] = 'Reference'
+      @_hash['branding_theme_id'] = 'BrandingThemeID'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['status'] = 'Status'
+      @_hash['sub_total'] = 'SubTotal'
+      @_hash['total_tax'] = 'TotalTax'
+      @_hash['total'] = 'Total'
+      @_hash['repeating_invoice_id'] = 'RepeatingInvoiceID'
+      @_hash['id'] = 'ID'
+      @_hash['has_attachments'] = 'HasAttachments'
+      @_hash['attachments'] = 'Attachments'
+      @_hash['approved_for_sending'] = 'ApprovedForSending'
+      @_hash['send_copy'] = 'SendCopy'
+      @_hash['mark_as_sent'] = 'MarkAsSent'
+      @_hash['include_pdf'] = 'IncludePDF'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        contact
+        schedule
+        line_items
+        line_amount_types
+        reference
+        branding_theme_id
+        currency_code
+        status
+        sub_total
+        total_tax
+        total
+        repeating_invoice_id
+        id
+        has_attachments
+        attachments
+        approved_for_sending
+        send_copy
+        mark_as_sent
+        include_pdf
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, contact: SKIP, schedule: SKIP, line_items: SKIP,
+                   line_amount_types: SKIP, reference: SKIP,
+                   branding_theme_id: SKIP, currency_code: SKIP, status: SKIP,
+                   sub_total: SKIP, total_tax: SKIP, total: SKIP,
+                   repeating_invoice_id: SKIP, id: SKIP, has_attachments: false,
+                   attachments: SKIP, approved_for_sending: false,
+                   send_copy: false, mark_as_sent: false, include_pdf: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @contact = contact unless contact == SKIP
+      @schedule = schedule unless schedule == SKIP
+      @line_items = line_items unless line_items == SKIP
+      @line_amount_types = line_amount_types unless line_amount_types == 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
+      @sub_total = sub_total unless sub_total == SKIP
+      @total_tax = total_tax unless total_tax == SKIP
+      @total = total unless total == SKIP
+      @repeating_invoice_id = repeating_invoice_id unless repeating_invoice_id == SKIP
+      @id = id unless id == SKIP
+      @has_attachments = has_attachments unless has_attachments == SKIP
+      @attachments = attachments unless attachments == SKIP
+      @approved_for_sending = approved_for_sending unless approved_for_sending == SKIP
+      @send_copy = send_copy unless send_copy == SKIP
+      @mark_as_sent = mark_as_sent unless mark_as_sent == SKIP
+      @include_pdf = include_pdf unless include_pdf == 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.
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      contact = Contact.from_hash(hash['Contact']) if hash['Contact']
+      schedule = Schedule.from_hash(hash['Schedule']) if hash['Schedule']
+      # 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')
+      line_amount_types =
+        hash.key?('LineAmountTypes') ? hash['LineAmountTypes'] : 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
+      sub_total = hash.key?('SubTotal') ? hash['SubTotal'] : SKIP
+      total_tax = hash.key?('TotalTax') ? hash['TotalTax'] : SKIP
+      total = hash.key?('Total') ? hash['Total'] : SKIP
+      repeating_invoice_id =
+        hash.key?('RepeatingInvoiceID') ? hash['RepeatingInvoiceID'] : SKIP
+      id = hash.key?('ID') ? hash['ID'] : SKIP
+      has_attachments = hash['HasAttachments'] ||= false
+      # 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')
+      approved_for_sending = hash['ApprovedForSending'] ||= false
+      send_copy = hash['SendCopy'] ||= false
+      mark_as_sent = hash['MarkAsSent'] ||= false
+      include_pdf = hash['IncludePDF'] ||= false
+
+      # 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.
+      RepeatingInvoice.new(type: type,
+                           contact: contact,
+                           schedule: schedule,
+                           line_items: line_items,
+                           line_amount_types: line_amount_types,
+                           reference: reference,
+                           branding_theme_id: branding_theme_id,
+                           currency_code: currency_code,
+                           status: status,
+                           sub_total: sub_total,
+                           total_tax: total_tax,
+                           total: total,
+                           repeating_invoice_id: repeating_invoice_id,
+                           id: id,
+                           has_attachments: has_attachments,
+                           attachments: attachments,
+                           approved_for_sending: approved_for_sending,
+                           send_copy: send_copy,
+                           mark_as_sent: mark_as_sent,
+                           include_pdf: include_pdf,
+                           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} type: #{@type}, contact: #{@contact}, schedule: #{@schedule}, line_items:"\
+      " #{@line_items}, line_amount_types: #{@line_amount_types}, reference: #{@reference},"\
+      " branding_theme_id: #{@branding_theme_id}, currency_code: #{@currency_code}, status:"\
+      " #{@status}, sub_total: #{@sub_total}, total_tax: #{@total_tax}, total: #{@total},"\
+      " repeating_invoice_id: #{@repeating_invoice_id}, id: #{@id}, has_attachments:"\
+      " #{@has_attachments}, attachments: #{@attachments}, approved_for_sending:"\
+      " #{@approved_for_sending}, send_copy: #{@send_copy}, mark_as_sent: #{@mark_as_sent},"\
+      " include_pdf: #{@include_pdf}, 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} type: #{@type.inspect}, contact: #{@contact.inspect}, schedule:"\
+      " #{@schedule.inspect}, line_items: #{@line_items.inspect}, line_amount_types:"\
+      " #{@line_amount_types.inspect}, reference: #{@reference.inspect}, branding_theme_id:"\
+      " #{@branding_theme_id.inspect}, currency_code: #{@currency_code.inspect}, status:"\
+      " #{@status.inspect}, sub_total: #{@sub_total.inspect}, total_tax: #{@total_tax.inspect},"\
+      " total: #{@total.inspect}, repeating_invoice_id: #{@repeating_invoice_id.inspect}, id:"\
+      " #{@id.inspect}, has_attachments: #{@has_attachments.inspect}, attachments:"\
+      " #{@attachments.inspect}, approved_for_sending: #{@approved_for_sending.inspect},"\
+      " send_copy: #{@send_copy.inspect}, mark_as_sent: #{@mark_as_sent.inspect}, include_pdf:"\
+      " #{@include_pdf.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/repeating_invoices.rb

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

data/lib/xero_ap_is/models/report.rb

@@ -0,0 +1,136 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Report Model.
+  class Report < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # See Prepayment Types
+    # @return [String]
+    attr_accessor :report_name
+
+    # See Prepayment Types
+    # @return [ReportType]
+    attr_accessor :report_type
+
+    # See Prepayment Types
+    # @return [String]
+    attr_accessor :report_title
+
+    # Date of report
+    # @return [String]
+    attr_accessor :report_date
+
+    # Updated Date
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # Updated Date
+    # @return [Array[TenNinetyNineContact]]
+    attr_accessor :contacts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['report_name'] = 'ReportName'
+      @_hash['report_type'] = 'ReportType'
+      @_hash['report_title'] = 'ReportTitle'
+      @_hash['report_date'] = 'ReportDate'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['contacts'] = 'Contacts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        report_name
+        report_type
+        report_title
+        report_date
+        updated_date_utc
+        contacts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(report_name: SKIP, report_type: SKIP, report_title: SKIP,
+                   report_date: SKIP, updated_date_utc: SKIP, contacts: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @report_name = report_name unless report_name == SKIP
+      @report_type = report_type unless report_type == SKIP
+      @report_title = report_title unless report_title == SKIP
+      @report_date = report_date unless report_date == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @contacts = contacts unless contacts == 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.
+      report_name = hash.key?('ReportName') ? hash['ReportName'] : SKIP
+      report_type = hash.key?('ReportType') ? hash['ReportType'] : SKIP
+      report_title = hash.key?('ReportTitle') ? hash['ReportTitle'] : SKIP
+      report_date = hash.key?('ReportDate') ? hash['ReportDate'] : SKIP
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      contacts = nil
+      unless hash['Contacts'].nil?
+        contacts = []
+        hash['Contacts'].each do |structure|
+          contacts << (TenNinetyNineContact.from_hash(structure) if structure)
+        end
+      end
+
+      contacts = SKIP unless hash.key?('Contacts')
+
+      # 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.
+      Report.new(report_name: report_name,
+                 report_type: report_type,
+                 report_title: report_title,
+                 report_date: report_date,
+                 updated_date_utc: updated_date_utc,
+                 contacts: contacts,
+                 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} report_name: #{@report_name}, report_type: #{@report_type}, report_title:"\
+      " #{@report_title}, report_date: #{@report_date}, updated_date_utc: #{@updated_date_utc},"\
+      " contacts: #{@contacts}, 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} report_name: #{@report_name.inspect}, report_type: #{@report_type.inspect},"\
+      " report_title: #{@report_title.inspect}, report_date: #{@report_date.inspect},"\
+      " updated_date_utc: #{@updated_date_utc.inspect}, contacts: #{@contacts.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/report_attribute.rb

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

data/lib/xero_ap_is/models/report_cell.rb

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