ChatKittyPlatformAPI.Api.Users (chatkitty_platform_sdk v0.1.0)

API calls for all endpoints tagged Users.

Link to this section Summary

Functions

Check a user exists Checks if a user exists

Delete a user Delets a user

List a user's channels Returns a page of channels for this user created or joined

List a user's messages Returns a page of messages sent by this user

List a user's notifications Returns a page of notifications received by this user

List users Returns a page of users belonging to this application

Remove a user secret Removes a user secret's value

Retrieve a user Returns a user by ID

Retrieve a user secret Returns a user secret

Set a user secret Sets a user secret's value

Update a user Updates a user

Update a user's display picture Updates a user's display picture

Link to this section Functions

Link to this function

check_user_exists(connection, name, opts \\ [])

@spec check_user_exists(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ChatKittyPlatformAPI.Model.ApiError.t()}
  | {:ok, Map.t()}
  | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()}
  | {:error, Tesla.Env.t()}

Check a user exists Checks if a user exists

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • name (String.t): Username of the user
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

create_user(connection, create_person_chat_user_resource, opts \\ [])

Create a user Creates a new user

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • create_person_chat_user_resource (CreatePersonChatUserResource):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

delete_user(connection, id, opts \\ [])

Delete a user Delets a user

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()): User ID
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

list_user_channels(connection, id, opts \\ [])

List a user's channels Returns a page of channels for this user created or joined

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()): User ID
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Zero-based page index (0..N)
    • :size (integer()): The size of the page to be returned
    • :sort ([String.t]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

list_user_messages(connection, id, opts \\ [])

List a user's messages Returns a page of messages sent by this user

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()): User ID
  • opts (KeywordList): [optional] Optional parameters
    • :size (integer()): The size of the page to be returned
    • :start (integer()): Start cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages
    • :next (integer()): Next page cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch subsequent pages
    • :relation (String.t): Page cursor relation. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages
    • :unread (boolean()): Filters by returning unread messages

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

list_user_notifications(connection, id, opts \\ [])

List a user's notifications Returns a page of notifications received by this user

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()): User ID
  • opts (KeywordList): [optional] Optional parameters
    • :size (integer()): The size of the page to be returned
    • :start (integer()): Start cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages
    • :next (integer()): Next page cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch subsequent pages
    • :relation (String.t): Page cursor relation. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

list_users(connection, opts \\ [])

List users Returns a page of users belonging to this application

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Zero-based page index (0..N)
    • :size (integer()): The size of the page to be returned
    • :sort ([String.t]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
    • :name (String.t): Filters by username

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

remove_user_secret(connection, id, name, opts \\ [])

Remove a user secret Removes a user secret's value

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()): User ID
  • name (String.t): The secret's name
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

retrieve_user(connection, id, opts \\ [])

Retrieve a user Returns a user by ID

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()): User ID
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

retrieve_user_secret(connection, id, name, opts \\ [])

Retrieve a user secret Returns a user secret

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()): User ID
  • name (String.t): The secret's name
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

set_user_secret(connection, id, name, secret_resource, opts \\ [])

Set a user secret Sets a user secret's value

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()): User ID
  • name (String.t): The secret's name
  • secret_resource (SecretResource):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

update_user(connection, id, opts \\ [])

Update a user Updates a user

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()): User ID
  • opts (KeywordList): [optional] Optional parameters
    • :body (ChatUserPropertiesPatch):

returns

Returns

on success {:error, Tesla.Env.t} on failure

Link to this function

update_user_display_picture(connection, id, create_external_file_properties, opts \\ [])

Update a user's display picture Updates a user's display picture

parameters

Parameters

  • connection (ChatKittyPlatformAPI.Connection): Connection to server
  • id (integer()): User ID
  • create_external_file_properties (CreateExternalFileProperties):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure