newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/configuration.rb

@@ -0,0 +1,244 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      STAGING = 'staging'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = STAGING)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      API = 'api'.freeze,
+      ACCESS_TOKEN_SERVER = 'access token server'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = API)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'api' then API
+      when 'access_token_server' then ACCESS_TOKEN_SERVER
+
+      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
+    def o_auth_client_id
+      @client_credentials_auth_credentials.o_auth_client_id
+    end
+
+    def o_auth_client_secret
+      @client_credentials_auth_credentials.o_auth_client_secret
+    end
+
+    def o_auth_token
+      @client_credentials_auth_credentials.o_auth_token
+    end
+
+    def o_auth_scopes
+      @client_credentials_auth_credentials.o_auth_scopes
+    end
+
+    # The attribute readers for properties.
+    attr_reader :environment, :tenant, :client_credentials_auth_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      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,
+      environment: Environment::STAGING, tenant: 'dodici',
+      o_auth_client_id: nil, o_auth_client_secret: nil, o_auth_token: nil,
+      o_auth_scopes: nil, client_credentials_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
+
+      # Current API environment
+      @environment = String(environment)
+
+      # tenant value
+      @tenant = tenant
+
+      # OAuth 2 Client ID
+      @o_auth_client_id = o_auth_client_id
+
+      # OAuth 2 Client Secret
+      @o_auth_client_secret = o_auth_client_secret
+
+      # Object for storing information about the OAuth token
+      @o_auth_token = if o_auth_token.is_a? OAuthToken
+                        OAuthToken.from_hash o_auth_token.to_hash
+                      else
+                        o_auth_token
+                      end
+
+      # List of scopes that apply to the OAuth token
+      @o_auth_scopes = o_auth_scopes
+
+      # Initializing OAuth 2 Client Credentials Grant credentials with the provided auth parameters
+      @client_credentials_auth_credentials = create_auth_credentials_object(
+        o_auth_client_id, o_auth_client_secret, o_auth_token, o_auth_scopes,
+        client_credentials_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, environment: nil, tenant: nil,
+                   o_auth_client_id: nil, o_auth_client_secret: nil,
+                   o_auth_token: nil, o_auth_scopes: nil,
+                   client_credentials_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
+      environment ||= self.environment
+      tenant ||= self.tenant
+      client_credentials_auth_credentials = create_auth_credentials_object(
+        o_auth_client_id, o_auth_client_secret, o_auth_token, o_auth_scopes,
+        client_credentials_auth_credentials || self.client_credentials_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, environment: environment,
+        tenant: tenant,
+        client_credentials_auth_credentials: client_credentials_auth_credentials
+      )
+    end
+
+    def create_auth_credentials_object(o_auth_client_id, o_auth_client_secret,
+                                       o_auth_token, o_auth_scopes,
+                                       client_credentials_auth_credentials)
+      return client_credentials_auth_credentials if o_auth_client_id.nil? &&
+                                                    o_auth_client_secret.nil? &&
+                                                    o_auth_token.nil? &&
+                                                    o_auth_scopes.nil?
+
+      warn('The \'o_auth_client_id\', \'o_auth_client_secret\', \'o_auth_token'\
+           '\', \'o_auth_scopes\' params are deprecated. Use \'client_credenti'\
+           'als_auth_credentials\' param instead.')
+
+      unless client_credentials_auth_credentials.nil?
+        return client_credentials_auth_credentials.clone_with(
+          o_auth_client_id: o_auth_client_id,
+          o_auth_client_secret: o_auth_client_secret,
+          o_auth_token: o_auth_token,
+          o_auth_scopes: o_auth_scopes
+        )
+      end
+
+      ClientCredentialsAuthCredentials.new(
+        o_auth_client_id: o_auth_client_id,
+        o_auth_client_secret: o_auth_client_secret, o_auth_token: o_auth_token,
+        o_auth_scopes: o_auth_scopes
+      )
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::STAGING => {
+        Server::API => 'https://{tenant}.s.newstore.net',
+        Server::ACCESS_TOKEN_SERVER => 'https://id.s.newstore.net/auth/realms/{tenant}/protocol/openid-connect'
+      }
+    }.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::API)
+      parameters = {
+        'tenant' => { 'value' => tenant, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'staging'))
+      tenant = ENV.fetch('TENANT', 'dodici')
+      timeout = (ENV['TIMEOUT'] || 60).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 ===
+      client_credentials_auth_credentials = ClientCredentialsAuthCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+
+      Configuration.new(
+        environment: environment,
+        tenant: tenant,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        client_credentials_auth_credentials: client_credentials_auth_credentials,
+        proxy_settings: proxy_settings
+      )
+    end
+  end
+end

data/lib/new_store_api/controllers/address_completion_controller.rb

@@ -0,0 +1,24 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # AddressCompletionController
+  class AddressCompletionController < BaseController
+    # Completes addresses to structured results from query input
+    # @return [CompletionResponse] Response from the API call.
+    def list_addresses
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/retail-org/address-completions/addresses',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CompletionResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/address_controller.rb

@@ -0,0 +1,131 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # AddressController
+  class AddressController < BaseController
+    # Returns a list of addresses for given customer `profile_id`.
+    # @param [String] profile_id Required parameter: Profile ID
+    # @param [Integer] offset Optional parameter: The addresses page offset.
+    # @param [Integer] count Optional parameter: The number of requested
+    # addresses.
+    # @return [ListAddressesResponse] Response from the API call.
+    def list_addresses(profile_id,
+                       offset: 0,
+                       count: 10)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/profiles/{profile_id}/addresses',
+                                     Server::API)
+                   .template_param(new_parameter(profile_id, key: 'profile_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(count, key: 'count'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListAddressesResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Retrieves an existing address or creates a new address in case it has not
+    # been added yet.
+    # **Note:**
+    # A maximum of 1000 addresses can be stored per customer profile.
+    # When a new address is added after reaching the 1000 limit, the oldest
+    # address will be automatically replaced.
+    # @param [String] profile_id Required parameter: Profile ID
+    # @param [AddressModel] body Required parameter: Request payload
+    # @return [AddressResponse] Response from the API call.
+    def create_or_show_address(profile_id,
+                               body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customer/profiles/{profile_id}/addresses',
+                                     Server::API)
+                   .template_param(new_parameter(profile_id, key: 'profile_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AddressResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Deletes address from the latest customer profile.
+    # @param [String] profile_id Required parameter: Profile ID
+    # @param [String] address_id Required parameter: Address ID
+    # @return [void] Response from the API call.
+    def destroy_address(profile_id,
+                        address_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/customer/profiles/{profile_id}/addresses/{address_id}',
+                                     Server::API)
+                   .template_param(new_parameter(profile_id, key: 'profile_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(address_id, key: 'address_id')
+                                    .should_encode(true))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Returns an address for the given customer `profile_id` and `address_id`.
+    # @param [String] profile_id Required parameter: Profile ID
+    # @param [String] address_id Required parameter: Address ID
+    # @return [AddressResponse] Response from the API call.
+    def show_address(profile_id,
+                     address_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customer/profiles/{profile_id}/addresses/{address_id}',
+                                     Server::API)
+                   .template_param(new_parameter(profile_id, key: 'profile_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(address_id, key: 'address_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AddressResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Updates address for the given customer `profile_id` and `address_id`.
+    # @param [String] profile_id Required parameter: Profile ID
+    # @param [String] address_id Required parameter: Address ID
+    # @param [UpdateAddressRequest] body Required parameter: Request payload
+    # @return [AddressResponse] Response from the API call.
+    def update_address(profile_id,
+                       address_id,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/customer/profiles/{profile_id}/addresses/{address_id}',
+                                     Server::API)
+                   .template_param(new_parameter(profile_id, key: 'profile_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(address_id, key: 'address_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AddressResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/adyen_adapter_controller.rb

@@ -0,0 +1,43 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # AdyenAdapterController
+  class AdyenAdapterController < BaseController
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # Retrieves the notifications the platform received from Adyen for a given
+    # psp_reference or merchant_reference. Although each of these filters is
+    # optional to get a meaningful response one of them needs to be present in
+    # the request
+    # @param [String] psp_reference Optional parameter: TODO: type description
+    # here
+    # @param [String] merchant_reference Optional parameter: TODO: type
+    # description here
+    # @return [GetNotificationsResponse] Response from the API call.
+    def list_notifications(psp_reference: nil,
+                           merchant_reference: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/payment/tools/notifications',
+                                     Server::API)
+                   .query_param(new_parameter(psp_reference, key: 'psp_reference'))
+                   .query_param(new_parameter(merchant_reference, key: 'merchant_reference'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetNotificationsResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/associate_app_experiments_configuration_controller.rb

@@ -0,0 +1,132 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # AssociateAppExperimentsConfigurationController
+  class AssociateAppExperimentsConfigurationController < BaseController
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # Deletes the current experiments configuration values for Associate App in
+    # your business.
+    # @param [String] app_id Required parameter: TODO: type description here
+    # @return [Experiment] Response from the API call.
+    def destroy_experiments(app_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/retail-org/apps/{appId}/experiments',
+                                     Server::API)
+                   .template_param(new_parameter(app_id, key: 'appId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Experiment.method(:from_hash)))
+        .execute
+    end
+
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # Returns the current experiments configured for Associate App in your
+    # business.
+    # @param [String] app_id Required parameter: TODO: type description here
+    # @return [Experiment] Response from the API call.
+    def list_experiments(app_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/retail-org/apps/{appId}/experiments',
+                                     Server::API)
+                   .template_param(new_parameter(app_id, key: 'appId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Experiment.method(:from_hash)))
+        .execute
+    end
+
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # Updates the current experiments configuration values for Associate App in
+    # your business.
+    # @param [String] app_id Required parameter: TODO: type description here
+    # @param [Experiment] body Optional parameter: TODO: type description here
+    # @return [Experiment] Response from the API call.
+    def update_experiments(app_id,
+                           body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/retail-org/apps/{appId}/experiments',
+                                     Server::API)
+                   .template_param(new_parameter(app_id, key: 'appId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Experiment.method(:from_hash)))
+        .execute
+    end
+
+    # <div style="background-color: rgba(243, 156, 18, 0.15); border: 1px solid
+    # #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #f39c12;">
+    #   <strong>🚧 BETA:</strong> This endpoint is in beta and may change.
+    #   <br />
+    #   See <a href="https://docs.newstore.com/docs/api-lifecycle"
+    # target="_blank" style="color: #f39c12; text-decoration: underline;">API
+    # Lifecycle Documentation</a> for details.
+    # </div>
+    # Updates and replaces the current experiments configuration values for
+    # Associate App in
+    # your business.
+    # @param [String] app_id Required parameter: TODO: type description here
+    # @param [Experiment] body Optional parameter: TODO: type description here
+    # @return [Experiment] Response from the API call.
+    def replace_experiments(app_id,
+                            body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/retail-org/apps/{appId}/experiments',
+                                     Server::API)
+                   .template_param(new_parameter(app_id, key: 'appId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Experiment.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/audit_events_controller.rb

@@ -0,0 +1,73 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # AuditEventsController
+  class AuditEventsController < BaseController
+    # <div style="background-color: rgba(23, 162, 184, 0.15); border: 1px solid
+    # #17a2b8; border-left: 4px solid #17a2b8; padding: 12px; margin: 10px 0;
+    # border-radius: 4px; color: #17a2b8;">
+    #   <strong>ℹ️ Rate Limit:</strong> This endpoint is rate limited to 1
+    # requests per second.
+    # </div>
+    # List audit events for the tenant.
+    # @param [DateTime] from Optional parameter: Only return events at or after
+    # this RFC 3339 timestamp (inclusive start of the time range). Required
+    # together with `to` for a fresh query; omit both when paginating with
+    # `cursor`, which resumes the original query and ignores them.
+    # @param [DateTime] to Optional parameter: Only return events at or before
+    # this RFC 3339 timestamp (inclusive end of the time range). Required
+    # together with `from` for a fresh query; omit both when paginating with
+    # `cursor`, which resumes the original query and ignores them.
+    # @param [String] resource Optional parameter: Filter events by the resource
+    # type or identifier affected.
+    # @param [AuditOperationEnum] operation Optional parameter: Filter events by
+    # the operation performed.
+    # @param [String] actor_id Optional parameter: Filter events by the actor's
+    # NewStore user id (actor.user_id).
+    # @param [String] actor_name Optional parameter: Filter events by a
+    # case-insensitive substring of the actor's display name
+    # (actor.display_name).
+    # @param [String] resource_id Optional parameter: Filter events by the
+    # identifier of the specific resource affected.
+    # @param [String] cursor Optional parameter: Opaque pagination token. Pass
+    # the `next_cursor` from a previous response to fetch the next page; omit it
+    # to fetch the first page. The other filter parameters must be unchanged
+    # across a paged sequence.
+    # @param [Integer] page_size Optional parameter: Maximum number of events to
+    # return in this page. Defaults to 25; capped at 100. Pagination via
+    # `cursor` walks the full result set this many at a time.
+    # @return [AuditEventList] Response from the API call.
+    def list_audit_events(from: nil,
+                          to: nil,
+                          resource: nil,
+                          operation: nil,
+                          actor_id: nil,
+                          actor_name: nil,
+                          resource_id: nil,
+                          cursor: nil,
+                          page_size: 25)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/system/audit-events',
+                                     Server::API)
+                   .query_param(new_parameter(from, key: 'from'))
+                   .query_param(new_parameter(to, key: 'to'))
+                   .query_param(new_parameter(resource, key: 'resource'))
+                   .query_param(new_parameter(operation, key: 'operation'))
+                   .query_param(new_parameter(actor_id, key: 'actor_id'))
+                   .query_param(new_parameter(actor_name, key: 'actor_name'))
+                   .query_param(new_parameter(resource_id, key: 'resource_id'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(page_size, key: 'page_size'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AuditEventList.method(:from_hash)))
+        .execute
+    end
+  end
+end