ExStreamClient.Operations.ExternalStorage (ExStreamClient v0.1.3)

View Source

Modules for interacting with the external_storage group of Stream APIs

API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2

Summary

Functions

check_external_storage(name, opts \\ [])

@spec check_external_storage(String.t(), [{:client, module()}]) ::
  {:ok, ExStreamClient.Model.CheckExternalStorageResponse.t()} | {:error, any()}

Required Arguments:

  • name

Optional Arguments:

create_external_storage(payload, opts \\ [])

@spec create_external_storage(
  ExStreamClient.Model.CreateExternalStorageRequest.t(),
  [{:client, module()}]
) ::
  {:ok, ExStreamClient.Model.CreateExternalStorageResponse.t()}
  | {:error, any()}

Creates new external storage

Required Arguments:

Optional Arguments:

delete_external_storage(name, opts \\ [])

@spec delete_external_storage(String.t(), [{:client, module()}]) ::
  {:ok, ExStreamClient.Model.DeleteExternalStorageResponse.t()}
  | {:error, any()}

Deletes external storage

Required Arguments:

  • name

Optional Arguments:

list_external_storage(opts \\ [])

@spec list_external_storage([{:client, module()}]) ::
  {:ok, ExStreamClient.Model.ListExternalStorageResponse.t()} | {:error, any()}

Lists external storage

Optional Arguments:

update_external_storage(name, payload, opts \\ [])

@spec update_external_storage(
  String.t(),
  ExStreamClient.Model.UpdateExternalStorageRequest.t(),
  [
    {:client, module()}
  ]
) ::
  {:ok, ExStreamClient.Model.UpdateExternalStorageResponse.t()}
  | {:error, any()}

Required Arguments:

Optional Arguments: