ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/controllers/log_controller.rb

@@ -0,0 +1,67 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # LogController
+  class LogController < BaseController
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Fetches security audit logs.
+    # Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the [Admin
+    # Control](https://developers.thoughtspot.com/docs/rbac#_admin_control)
+    # privileges are required.
+    # #### Usage guidelines
+    # By default, the API retrieves logs for the last 24 hours. You can set a
+    # custom duration in EPOCH time. Make sure the log duration specified in
+    # your API request doesn’t exceed 24 hours. If you must fetch logs for a
+    # longer time range, modify the duration and make multiple sequential API
+    # requests.
+    # Upon successful execution, the API returns logs with the following
+    # information:
+    # * timestamp of the event
+    # * event ID
+    # * event type
+    # * name and GUID of the user
+    # * IP address of ThoughtSpot instance
+    # For more information see [Audit logs
+    # Documentation](https://developers.thoughtspot.com/docs/audit-logs).
+    # #### Endpoint URL
+    # @param [FetchLogsRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_logs(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/logs/fetch',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LogResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Invalid request.',
+                                 ErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized access.',
+                                 ErrorResponseException)
+                    .local_error('403',
+                                 'Forbidden access.',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Unexpected error',
+                                 ErrorResponseException))
+        .execute
+    end
+  end
+end