xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/oauth_scope_oauth_2.rb

@@ -0,0 +1,113 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # OAuth 2 scopes supported by the API
+  class OauthScopeOauth2
+    OAUTH_SCOPE_OAUTH_2 = [
+      # Grant read-only access to your email
+      EMAIL = 'email'.freeze,
+
+      # Grant read-only access to your open id
+      OPENID = 'openid'.freeze,
+
+      # your profile information
+      PROFILE = 'profile'.freeze,
+
+      # Grant read-write access to attachments
+      ACCOUNTING_ATTACHMENTS = 'accounting.attachments'.freeze,
+
+      # Grant read-only access to attachments
+      ACCOUNTING_ATTACHMENTS_READ = 'accounting.attachments.read'.freeze,
+
+      # Grant read-only access to read budgets
+      ACCOUNTING_BUDGETS_READ = 'accounting.budgets.read'.freeze,
+
+      # Grant read-write access to contacts and contact groups
+      ACCOUNTING_CONTACTS = 'accounting.contacts'.freeze,
+
+      # Grant read-only access to contacts and contact groups
+      ACCOUNTING_CONTACTS_READ = 'accounting.contacts.read'.freeze,
+
+      # Grant read-only access to journals
+      ACCOUNTING_JOURNALS_READ = 'accounting.journals.read'.freeze,
+
+      # Grant read-only access to accounting reports
+      ACCOUNTING_REPORTS_READ = 'accounting.reports.read'.freeze,
+
+      # Grant read-only access to 1099 reports
+      ACCOUNTING_REPORTS_TENNINETYNINE_READ = 'accounting.reports.tenninetynine.read'.freeze,
+
+      # Grant read-write access to organisation and account settings
+      ACCOUNTING_SETTINGS = 'accounting.settings'.freeze,
+
+      # Grant read-only access to organisation and account settings
+      ACCOUNTING_SETTINGS_READ = 'accounting.settings.read'.freeze,
+
+      # Grant read-write access to bank transactions, credit notes, invoices,
+      # repeating invoices
+      ACCOUNTING_TRANSACTIONS = 'accounting.transactions'.freeze,
+
+      # Grant read-only access to invoices
+      ACCOUNTING_TRANSACTIONS_READ = 'accounting.transactions.read'.freeze,
+
+      # Grant read-write access to payment services
+      PAYMENTSERVICES = 'paymentservices'.freeze,
+
+      # Grant read-write access to fixed assets
+      ASSETS = 'assets'.freeze,
+
+      # Grant read-only access to fixed assets
+      ASSETS_READ = 'assets.read'.freeze,
+
+      # Grant read-write access to bankfeeds
+      BANKFEEDS = 'bankfeeds'.freeze,
+
+      # Grant read-write access to projects
+      PROJECTS = 'projects'.freeze,
+
+      # Grant read-only access to projects
+      PROJECTS_READ = 'projects.read'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OAUTH_SCOPE_OAUTH_2.include?(value)
+    end
+
+    def self.from_value(value, default_value = EMAIL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'email' then EMAIL
+      when 'openid' then OPENID
+      when 'profile' then PROFILE
+      when 'accounting_attachments' then ACCOUNTING_ATTACHMENTS
+      when 'accounting_attachments_read' then ACCOUNTING_ATTACHMENTS_READ
+      when 'accounting_budgets_read' then ACCOUNTING_BUDGETS_READ
+      when 'accounting_contacts' then ACCOUNTING_CONTACTS
+      when 'accounting_contacts_read' then ACCOUNTING_CONTACTS_READ
+      when 'accounting_journals_read' then ACCOUNTING_JOURNALS_READ
+      when 'accounting_reports_read' then ACCOUNTING_REPORTS_READ
+      when 'accounting_reports_tenninetynine_read' then ACCOUNTING_REPORTS_TENNINETYNINE_READ
+      when 'accounting_settings' then ACCOUNTING_SETTINGS
+      when 'accounting_settings_read' then ACCOUNTING_SETTINGS_READ
+      when 'accounting_transactions' then ACCOUNTING_TRANSACTIONS
+      when 'accounting_transactions_read' then ACCOUNTING_TRANSACTIONS_READ
+      when 'paymentservices' then PAYMENTSERVICES
+      when 'assets' then ASSETS
+      when 'assets_read' then ASSETS_READ
+      when 'bankfeeds' then BANKFEEDS
+      when 'projects' then PROJECTS
+      when 'projects_read' then PROJECTS_READ
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/oauth_token.rb

@@ -0,0 +1,96 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # OAuth 2 Authorization endpoint response
+  class OauthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, token_type:, expires_in: SKIP, scope: SKIP,
+                   expiry: SKIP, refresh_token: SKIP)
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+
+      # Create object from extracted values.
+      OauthToken.new(access_token: access_token,
+                     token_type: token_type,
+                     expires_in: expires_in,
+                     scope: scope,
+                     expiry: expiry,
+                     refresh_token: refresh_token)
+    end
+  end
+end

data/lib/xero_ap_is/models/online_invoice.rb

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

data/lib/xero_ap_is/models/online_invoices.rb

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

data/lib/xero_ap_is/models/order_by.rb

@@ -0,0 +1,56 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # orderBy.
+  class OrderBy
+    ORDER_BY = [
+      # TODO: Write general description for ASSETTYPE
+      ASSETTYPE = 'AssetType'.freeze,
+
+      # TODO: Write general description for ASSETNAME
+      ASSETNAME = 'AssetName'.freeze,
+
+      # TODO: Write general description for ASSETNUMBER
+      ASSETNUMBER = 'AssetNumber'.freeze,
+
+      # TODO: Write general description for PURCHASEDATE
+      PURCHASEDATE = 'PurchaseDate'.freeze,
+
+      # TODO: Write general description for PURCHASEPRICE
+      PURCHASEPRICE = 'PurchasePrice'.freeze,
+
+      # TODO: Write general description for DISPOSALDATE
+      DISPOSALDATE = 'DisposalDate'.freeze,
+
+      # TODO: Write general description for DISPOSALPRICE
+      DISPOSALPRICE = 'DisposalPrice'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORDER_BY.include?(value)
+    end
+
+    def self.from_value(value, default_value = ASSETTYPE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'assettype' then ASSETTYPE
+      when 'assetname' then ASSETNAME
+      when 'assetnumber' then ASSETNUMBER
+      when 'purchasedate' then PURCHASEDATE
+      when 'purchaseprice' then PURCHASEPRICE
+      when 'disposaldate' then DISPOSALDATE
+      when 'disposalprice' then DISPOSALPRICE
+      else
+        default_value
+      end
+    end
+  end
+end