ExStreamClient.Operations.Roles (ExStreamClient v0.1.2)

View Source
Modules for interacting with the `roles` group of Stream APIs

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

Summary

Functions

create_role(payload)

Creates custom role


### Required Arguments:
    - `payload`: CreateRoleRequest

delete_role(name)

@spec delete_role(String.t()) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes custom role


### Required Arguments:
    - `name`

list_roles()

@spec list_roles() ::
  {:ok, ExStreamClient.Model.ListRolesResponse.t()} | {:error, any()}
Lists all available roles


### Required Arguments: