ChatKittyPlatformAPI.Api.Imports (chatkitty_platform_sdk v0.1.0)
API calls for all endpoints tagged Imports
.
Link to this section Summary
Functions
Import channel members Batch imports channel members from a JSON array file
Import channels Batch imports channels from a JSON array file
Import messages Batch imports messages from a JSON array file
Import users Batch imports users from a JSON array file
Link to this section Functions
import_channel_members(connection, id, file, opts \\ [])
@spec import_channel_members(Tesla.Env.client(), integer(), String.t(), keyword()) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ApplicationJobResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Import channel members Batch imports channel members from a JSON array file
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- id (integer()):
- file (String.t): JSON array file with user references to be added as members
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
import_channels(connection, file, opts \\ [])
@spec import_channels(Tesla.Env.client(), String.t(), keyword()) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ApplicationJobResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Import channels Batch imports channels from a JSON array file
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- file (String.t): JSON array file with channels
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
import_messages(connection, file, opts \\ [])
@spec import_messages(Tesla.Env.client(), String.t(), keyword()) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ApplicationJobResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Import messages Batch imports messages from a JSON array file
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- file (String.t): JSON array file with messages
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
import_users(connection, file, opts \\ [])
@spec import_users(Tesla.Env.client(), String.t(), keyword()) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ApplicationJobResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Import users Batch imports users from a JSON array file
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- file (String.t): JSON array file with users
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure