ChatKittyPlatformAPI.Api.Application (chatkitty_platform_sdk v0.1.0)
API calls for all endpoints tagged Application
.
Link to this section Summary
Functions
Retrieve the authenticated application Returns the ChatKitty application associated with the authentication credentials used. You must use an OAuth V2 Bearer token to access this endpoint.
Retrieve the authenticated application settings Returns the current settings configuring this application
Update the authenticated application settings Update the settings configuring this application
Link to this section Functions
retrieve_authenticated_application(connection, opts \\ [])
@spec retrieve_authenticated_application( Tesla.Env.client(), keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ApplicationResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Retrieve the authenticated application Returns the ChatKitty application associated with the authentication credentials used. You must use an OAuth V2 Bearer token to access this endpoint.
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
retrieve_authenticated_application_settings(connection, opts \\ [])
@spec retrieve_authenticated_application_settings( Tesla.Env.client(), keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ApplicationSettingsResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Retrieve the authenticated application settings Returns the current settings configuring this application
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
update_authenticated_application_settings(connection, application_settings_properties, opts \\ [])
@spec update_authenticated_application_settings( Tesla.Env.client(), ChatKittyPlatformAPI.Model.ApplicationSettingsProperties.t(), keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ApplicationSettingsResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Update the authenticated application settings Update the settings configuring this application
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- application_settings_properties (ApplicationSettingsProperties):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure