ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/controllers/users_controller.rb

@@ -0,0 +1,467 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # UsersController
+  class UsersController < BaseController
+    #  <span class="since-beta-tag">Version: 9.7.0.cl or later</span>
+    # Activates a deactivated user account.
+    # Requires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is
+    # required.
+    # To activate an inactive user account, the API request body must include
+    # the following information:
+    # - Username or the GUID of the user account.
+    # - Auth token generated for the deactivated user. The auth token is sent in
+    # the API response when a user is deactivated.
+    # - Password for the user account.
+    # #### Endpoint URL
+    # @param [ActivateUserRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def activate_user(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/users/activate',
+                                     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(User.method(:from_hash))
+                    .is_api_response(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
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Updates the current password of the user.
+    # Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is
+    # required.
+    # #### Endpoint URL
+    # @param [ChangeUserPasswordRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def change_user_password(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/users/change-password',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(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
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Creates a user in ThoughtSpot.
+    # The API endpoint allows you to configure several user properties such as
+    # email address, account status, share notification preferences, and sharing
+    # visibility. You can provision the user to
+    # [groups](https://docs.thoughtspot.com/cloud/latest/groups-privileges) and
+    # [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview). You can
+    # also add Liveboard, Answer, and Worksheet objects to the user’s favorites
+    # list, assign a default Liveboard for the user, and set user preferences.
+    # Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is
+    # required.
+    # #### Endpoint URL
+    # @param [CreateUserRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_user(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/users/create',
+                                     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(User.method(:from_hash))
+                    .is_api_response(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
+
+    #  <span class="since-beta-tag">Version: 9.7.0.cl or later</span>
+    # Deactivates a user account.
+    # Requires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege. If
+    # [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is
+    # required.
+    # To deactivate a user account, the API request body must include the
+    # following information:
+    # - Username or the GUID of the user account
+    # - Base URL of the ThoughtSpot instance
+    # If the API request is successful, ThoughtSpot returns the activation URL
+    # in the response. The activation URL is valid for 14 days and can be used
+    # to re-activate the account and reset the password of the deactivated
+    # account.
+    # #### Endpoint URL
+    # @param [DeactivateUserRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def deactivate_user(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/users/deactivate',
+                                     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(ResponseActivationUrl.method(:from_hash))
+                    .is_api_response(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
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Deletes a user from the ThoughtSpot system.
+    # If you want to remove a user from a specific Org but not from ThoughtSpot,
+    # update the group and Org mapping properties of the user object via a POST
+    # API call to the
+    # [/api/rest/2.0/users/{user_identifier}/update](#/http/api-endpoints/users/
+    # update-user) endpoint.
+    # Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is
+    # required.
+    # #### Endpoint URL
+    # @param [String] user_identifier Required parameter: GUID / name of the
+    # user
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_user(user_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/users/{user_identifier}/delete',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(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
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Enforces logout on current user sessions.
+    # Use this API with caution as it may invalidate active user sessions and
+    # force users to re-login. Make sure you specify the usernames or GUIDs. If
+    # you pass null values in the API call, all user sessions on your cluster
+    # become invalid, and the users are forced to re-login.
+    # Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is
+    # required.
+    # #### Endpoint URL
+    # @param [ForceLogoutUsersRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def force_logout_users(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/users/force-logout',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(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
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Imports user data from external databases into ThoughtSpot. During the
+    # user import operation:
+    # * If the specified users are not available in ThoughtSpot, the users are
+    # created and assigned a default password. Defining a `default_password` in
+    # the API request is optional.
+    # * If `delete_unspecified_users` is set to `true`, the users not specified
+    # in the API request, excluding the `tsadmin`, `guest`, `system` and `su`
+    # users, are deleted.
+    # * If the specified user objects are already available in ThoughtSpot, the
+    # object properties are updated and synchronized as per the input data in
+    # the API request.
+    # A successful API call returns the object that represents the changes made
+    # in the ThoughtSpot system.
+    # Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is
+    # required.
+    # #### Endpoint URL
+    # @param [ImportUsersRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def import_users(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/users/import',
+                                     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(ImportUsersResponse.method(:from_hash))
+                    .is_api_response(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
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Resets the password of a user account. Administrators can reset password
+    # on behalf of a user.
+    # Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is
+    # required.
+    # #### Endpoint URL
+    # @param [ResetUserPasswordRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def reset_user_password(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/users/reset-password',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(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
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Gets a list of users available on the ThoughtSpot system.
+    # To get details of a specific user, specify the user GUID or name. You can
+    # also filter the API response based on groups, Org ID, user visibility,
+    # account status, user type, and user preference settings and favorites.
+    # Available to all users. Users with `ADMINISTRATION` (**Can administer
+    # ThoughtSpot**) privileges can view all users properties. If [Role-Based
+    # Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is
+    # enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**)
+    # privilege is required.
+    # **NOTE**: If the API returns an empty list, consider increasing the value
+    # of the `record_size` parameter. To search across all available users, set
+    # `record_size` to `-1`.
+    # #### Endpoint URL
+    # @param [SearchUsersRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_users(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/users/search',
+                                     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(User.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
+
+    #  <span class="since-beta-tag">Version: 9.0.0.cl or later</span>
+    # Updates the properties of a user object.
+    # You can modify user properties such as username, email, and share
+    # notification settings. You can also assign new groups and Orgs, remove the
+    # user from a group or Org, reset password, and modify user preferences.
+    # Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
+    # If [Role-Based Access Control
+    # (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your
+    # instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is
+    # required.
+    # #### Endpoint URL
+    # @param [String] user_identifier Required parameter: GUID / name of the
+    # user
+    # @param [UpdateUserRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_user(user_identifier,
+                    body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/rest/2.0/users/{user_identifier}/update',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(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