xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/client.rb

@@ -0,0 +1,110 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  #  xero_ap_is client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Returns the configured authentication OAuth2 instance.
+    def oauth_2
+      @auth_managers['OAuth2']
+    end
+
+    # Access to accounting controller.
+    # @return [AccountingApi] Returns the controller instance.
+    def accounting
+      @accounting ||= AccountingApi.new @global_configuration
+    end
+
+    # Access to asset controller.
+    # @return [AssetApi] Returns the controller instance.
+    def asset
+      @asset ||= AssetApi.new @global_configuration
+    end
+
+    # Access to bank_feeds controller.
+    # @return [BankFeedsApi] Returns the controller instance.
+    def bank_feeds
+      @bank_feeds ||= BankFeedsApi.new @global_configuration
+    end
+
+    # Access to identity controller.
+    # @return [IdentityApi] Returns the controller instance.
+    def identity
+      @identity ||= IdentityApi.new @global_configuration
+    end
+
+    # Access to project controller.
+    # @return [ProjectApi] Returns the controller instance.
+    def project
+      @project ||= ProjectApi.new @global_configuration
+    end
+
+    # Access to oauth_authorization controller.
+    # @return [OauthAuthorizationApi] Returns the controller instance.
+    def oauth_authorization
+      @oauth_authorization ||= OauthAuthorizationApi.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      oauth_2_credentials: nil, basic_auth_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    oauth_2_credentials: oauth_2_credentials,
+                    basic_auth_credentials: basic_auth_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseApi.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[OAuth2 BasicAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['OAuth2'] = Oauth2.new(http_client_config.oauth_2_credentials, global_config)
+      @auth_managers['BasicAuth'] = BasicAuth.new(http_client_config.basic_auth_credentials)
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end

data/lib/xero_ap_is/configuration.rb

@@ -0,0 +1,196 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: The Xero Accounting API exposes accounting and related functions of the main Xero application and can be used for a variety of purposes such as creating transactions like invoices and credit notes, right through to extracting accounting data via our reports endpoint., Xero API servers, Xero Bank Feeds API base url, Xero Identity service API, Xero API server for projects
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze,
+      AUTH_SERVER = 'auth server'.freeze,
+      ACCESS_TOKEN_SERVER = 'access token server'.freeze,
+      DEFAULT1 = 'default1'.freeze,
+      DEFAULT2 = 'default2'.freeze,
+      DEFAULT3 = 'default3'.freeze,
+      DEFAULT4 = 'default4'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'default' then DEFAULT
+      when 'auth_server' then AUTH_SERVER
+      when 'access_token_server' then ACCESS_TOKEN_SERVER
+      when 'default1' then DEFAULT1
+      when 'default2' then DEFAULT2
+      when 'default3' then DEFAULT3
+      when 'default4' then DEFAULT4
+
+      else
+        warn "[Server] Unknown server '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :oauth_2_credentials, :basic_auth_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      oauth_2_credentials: nil, basic_auth_credentials: nil
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding OAuth 2 Authorization Code Grant credentials
+      @oauth_2_credentials = oauth_2_credentials
+
+      # The object holding Basic Authentication credentials
+      @basic_auth_credentials = basic_auth_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, oauth_2_credentials: nil,
+                   basic_auth_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+      oauth_2_credentials ||= self.oauth_2_credentials
+      basic_auth_credentials ||= self.basic_auth_credentials
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback,
+                        proxy_settings: proxy_settings,
+                        logging_configuration: logging_configuration,
+                        environment: environment,
+                        oauth_2_credentials: oauth_2_credentials,
+                        basic_auth_credentials: basic_auth_credentials)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api.xero.com/api.xro/2.0',
+        Server::AUTH_SERVER => 'https://login.xero.com/identity/connect',
+        Server::ACCESS_TOKEN_SERVER => 'https://identity.xero.com/connect',
+        Server::DEFAULT1 => 'https://api.xero.com/assets.xro/1.0',
+        Server::DEFAULT2 => 'https://api.xero.com/bankfeeds.xro/1.0',
+        Server::DEFAULT3 => 'https://api.xero.com',
+        Server::DEFAULT4 => 'https://api.xero.com/projects.xro/2.0'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
+      timeout = (ENV['TIMEOUT'] || 30).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      oauth_2_credentials = Oauth2Credentials.from_env
+      basic_auth_credentials = BasicAuthCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        oauth_2_credentials: oauth_2_credentials,
+        basic_auth_credentials: basic_auth_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/xero_ap_is/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/xero_ap_is/exceptions/asset_types400_error_exception.rb

@@ -0,0 +1,72 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # AssetTypes 400 Error class.
+  class AssetTypes400ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :resource_validation_errors
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :field_validation_errors
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @resource_validation_errors =
+        hash.key?('resourceValidationErrors') ? hash['resourceValidationErrors'] : nil
+      @field_validation_errors =
+        hash.key?('fieldValidationErrors') ? hash['fieldValidationErrors'] : nil
+      @type = hash.key?('type') ? hash['type'] : nil
+      @title = hash.key?('title') ? hash['title'] : nil
+      @detail = hash.key?('detail') ? hash['detail'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} resource_validation_errors: #{@resource_validation_errors},"\
+      " field_validation_errors: #{@field_validation_errors}, type: #{@type}, title: #{@title},"\
+      " detail: #{@detail}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} resource_validation_errors: #{@resource_validation_errors.inspect},"\
+      " field_validation_errors: #{@field_validation_errors.inspect}, type: #{@type.inspect},"\
+      " title: #{@title.inspect}, detail: #{@detail.inspect}>"
+    end
+  end
+end

data/lib/xero_ap_is/exceptions/assets400_error_exception.rb

@@ -0,0 +1,72 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Assets 400 Error class.
+  class Assets400ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :resource_validation_errors
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :field_validation_errors
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @resource_validation_errors =
+        hash.key?('resourceValidationErrors') ? hash['resourceValidationErrors'] : nil
+      @field_validation_errors =
+        hash.key?('fieldValidationErrors') ? hash['fieldValidationErrors'] : nil
+      @type = hash.key?('type') ? hash['type'] : nil
+      @title = hash.key?('title') ? hash['title'] : nil
+      @detail = hash.key?('detail') ? hash['detail'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} resource_validation_errors: #{@resource_validation_errors},"\
+      " field_validation_errors: #{@field_validation_errors}, type: #{@type}, title: #{@title},"\
+      " detail: #{@detail}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} resource_validation_errors: #{@resource_validation_errors.inspect},"\
+      " field_validation_errors: #{@field_validation_errors.inspect}, type: #{@type.inspect},"\
+      " title: #{@title.inspect}, detail: #{@detail.inspect}>"
+    end
+  end
+end

data/lib/xero_ap_is/exceptions/error_error1_exception.rb

@@ -0,0 +1,63 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # On error, the API consumer will receive an HTTP response with a HTTP Status
+  # Code of 4xx or 5xx and a Content-Type of application/problem+json.
+  class ErrorError1Exception < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Human readable high level error description.
+    # @return [String]
+    attr_accessor :title
+
+    # The numeric HTTP Status Code, e.g. 404
+    # @return [Integer]
+    attr_accessor :status
+
+    # Human readable detailed error description.
+    # @return [String]
+    attr_accessor :detail
+
+    # Identifies the type of error.
+    # @return [Type11]
+    attr_accessor :type
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @title = hash.key?('title') ? hash['title'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
+      @detail = hash.key?('detail') ? hash['detail'] : SKIP
+      @type = hash.key?('type') ? hash['type'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} title: #{@title}, status: #{@status}, detail: #{@detail}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} title: #{@title.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/xero_ap_is/exceptions/error_error2_exception.rb

@@ -0,0 +1,51 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Error_Error2 class.
+  class ErrorError2Exception < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Exception message
+    # @return [String]
+    attr_accessor :message
+
+    # Array of Elements of validation Errors
+    # @return [Object]
+    attr_accessor :model_state
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @message = hash.key?('message') ? hash['message'] : SKIP
+      @model_state = hash.key?('modelState') ? hash['modelState'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}, model_state: #{@model_state}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message.inspect}, model_state: #{@model_state.inspect}>"
+    end
+  end
+end

data/lib/xero_ap_is/exceptions/error_exception.rb

@@ -0,0 +1,72 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Error class.
+  class ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Exception number
+    # @return [Integer]
+    attr_accessor :error_number
+
+    # Exception type
+    # @return [String]
+    attr_accessor :type
+
+    # Exception message
+    # @return [String]
+    attr_accessor :message
+
+    # Array of Elements of validation Errors
+    # @return [Array[Element]]
+    attr_accessor :elements
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_number = hash.key?('ErrorNumber') ? hash['ErrorNumber'] : SKIP
+      @type = hash.key?('Type') ? hash['Type'] : SKIP
+      @message = hash.key?('Message') ? hash['Message'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      @elements = nil
+      unless hash['Elements'].nil?
+        @elements = []
+        hash['Elements'].each do |structure|
+          @elements << (Element.from_hash(structure) if structure)
+        end
+      end
+
+      @elements = SKIP unless hash.key?('Elements')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_number: #{@error_number}, type: #{@type}, message: #{@message},"\
+      " elements: #{@elements}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_number: #{@error_number.inspect}, type: #{@type.inspect}, message:"\
+      " #{@message.inspect}, elements: #{@elements.inspect}>"
+    end
+  end
+end