ChatKittyPlatformAPI.Api.Runtime (chatkitty_platform_sdk v0.1.0)
API calls for all endpoints tagged Runtime
.
Link to this section Summary
Functions
Create a NodeJS chat runtime function Creates a NodeJS chat function for this runtime
List NodeJS chat runtime functions Returns a page of functions for this application's NodeJS chat runtime
Retrieve NodeJS chat runtime Return this application's NodeJS chat runtime
Update NodeJS chat runtime NPM dependencies Updates the NPM dependencies for this application's NodeJS chat runtime
Update NodeJS chat runtime environment variables Updates the runtime environment variables of this application's NodeJS chat runtime
Update NodeJS chat runtime initialization script Updates the initialization script for this application's NodeJS chat runtime
Link to this section Functions
create_nodejs_runtime_function(connection, create_chat_function_resource, opts \\ [])
@spec create_nodejs_runtime_function( Tesla.Env.client(), ChatKittyPlatformAPI.Model.CreateChatFunctionResource.t(), keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ChatFunctionResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Create a NodeJS chat runtime function Creates a NodeJS chat function for this runtime
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- create_chat_function_resource (CreateChatFunctionResource):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
list_nodejs_runtime_functions(connection, opts \\ [])
@spec list_nodejs_runtime_functions( Tesla.Env.client(), keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.PagedModelChatFunctionResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
List NodeJS chat runtime functions Returns a page of functions for this application's NodeJS chat runtime
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.
returns
Returns
on success {:error, Tesla.Env.t} on failure
retrieve_nodejs_runtime(connection, opts \\ [])
@spec retrieve_nodejs_runtime( Tesla.Env.client(), keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ChatRuntimeResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Retrieve NodeJS chat runtime Return this application's NodeJS chat runtime
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
update_nodejs_runtime_dependencies(connection, chat_runtime_dependency_properties, opts \\ [])
@spec update_nodejs_runtime_dependencies( Tesla.Env.client(), [ChatKittyPlatformAPI.Model.ChatRuntimeDependencyProperties.t()], keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ChatRuntimeResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Update NodeJS chat runtime NPM dependencies Updates the NPM dependencies for this application's NodeJS chat runtime
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- chat_runtime_dependency_properties ([ChatKittyPlatformAPI.Model.ChatRuntimeDependencyProperties.t]):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
update_nodejs_runtime_environment_variables(connection, request_body, opts \\ [])
@spec update_nodejs_runtime_environment_variables( Tesla.Env.client(), %{optional(String.t()) => String.t()}, keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ChatRuntimeResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Update NodeJS chat runtime environment variables Updates the runtime environment variables of this application's NodeJS chat runtime
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- request_body (%{optional(String.t) => String.t}):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
update_nodejs_runtime_initialization_script(connection, chat_runtime_script_properties, opts \\ [])
@spec update_nodejs_runtime_initialization_script( Tesla.Env.client(), ChatKittyPlatformAPI.Model.ChatRuntimeScriptProperties.t(), keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.ChatRuntimeResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
Update NodeJS chat runtime initialization script Updates the initialization script for this application's NodeJS chat runtime
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- chat_runtime_script_properties (ChatRuntimeScriptProperties):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure