XmtpElixirSdk.Conversations (xmtp_elixir_sdk v0.1.2)

@spec create_dm(
  XmtpElixirSdk.Client.t(),
  String.t(),
  XmtpElixirSdk.Types.CreateDmOptions.t() | nil
) ::
  {:ok, XmtpElixirSdk.Conversation.t()} | {:error, XmtpElixirSdk.Error.t()}

create_dm_with_identifier(client, identifier, opts \\ %Types.CreateDmOptions{})

@spec create_dm_with_identifier(
  XmtpElixirSdk.Client.t(),
  XmtpElixirSdk.Types.Identifier.t(),
  XmtpElixirSdk.Types.CreateDmOptions.t() | nil
) :: {:ok, XmtpElixirSdk.Conversation.t()} | {:error, XmtpElixirSdk.Error.t()}

create_group(client, inbox_ids, opts \\ %Types.CreateGroupOptions{})

@spec create_group(
  XmtpElixirSdk.Client.t(),
  [String.t()],
  XmtpElixirSdk.Types.CreateGroupOptions.t() | nil
) :: {:ok, XmtpElixirSdk.Conversation.t()} | {:error, XmtpElixirSdk.Error.t()}

create_group_optimistic(client, opts \\ %Types.CreateGroupOptions{})

@spec create_group_optimistic(
  XmtpElixirSdk.Client.t(),
  XmtpElixirSdk.Types.CreateGroupOptions.t() | nil
) :: {:ok, XmtpElixirSdk.Conversation.t()} | {:error, XmtpElixirSdk.Error.t()}

create_group_with_identifiers(client, identifiers, opts \\ %Types.CreateGroupOptions{})

@spec create_group_with_identifiers(
  XmtpElixirSdk.Client.t(),
  [XmtpElixirSdk.Types.Identifier.t()],
  XmtpElixirSdk.Types.CreateGroupOptions.t() | nil
) :: {:ok, XmtpElixirSdk.Conversation.t()} | {:error, XmtpElixirSdk.Error.t()}

duplicate_dms(conversation)

@spec duplicate_dms(XmtpElixirSdk.Conversation.t()) ::
  {:ok, [XmtpElixirSdk.Conversation.t()]} | {:error, XmtpElixirSdk.Error.t()}

fetch_dm_by_identifier(client, identifier)

@spec fetch_dm_by_identifier(
  XmtpElixirSdk.Client.t(),
  XmtpElixirSdk.Types.Identifier.t()
) ::
  {:ok, XmtpElixirSdk.Conversation.t() | nil}
  | {:error, XmtpElixirSdk.Error.t()}

get_by_id(client, id)

@spec get_by_id(XmtpElixirSdk.Client.t(), String.t()) ::
  {:ok, XmtpElixirSdk.Conversation.t() | nil}
  | {:error, XmtpElixirSdk.Error.t()}

get_dm_by_inbox_id(client, inbox_id)

@spec get_dm_by_inbox_id(XmtpElixirSdk.Client.t(), String.t()) ::
  {:ok, XmtpElixirSdk.Conversation.t() | nil}
  | {:error, XmtpElixirSdk.Error.t()}

get_message_by_id(client, id, registry \\ CodecRegistry.new())

@spec get_message_by_id(
  XmtpElixirSdk.Client.t(),
  String.t(),
  XmtpElixirSdk.CodecRegistry.t()
) ::
  {:ok, XmtpElixirSdk.DecodedMessage.t() | nil}
  | {:error, XmtpElixirSdk.Error.t()}

hmac_keys(client)

@spec hmac_keys(XmtpElixirSdk.Client.t()) ::
  {:ok, [XmtpElixirSdk.Types.HmacKeyEntry.t()]}
  | {:error, XmtpElixirSdk.Error.t()}

list(client, opts \\ %Types.ListConversationsOptions{})

@spec list(
  XmtpElixirSdk.Client.t(),
  XmtpElixirSdk.Types.ListConversationsOptions.t() | nil
) ::
  {:ok, [XmtpElixirSdk.Conversation.t()]} | {:error, XmtpElixirSdk.Error.t()}

list_dms(client, opts \\ %Types.ListConversationsOptions{})

@spec list_dms(
  XmtpElixirSdk.Client.t(),
  XmtpElixirSdk.Types.ListConversationsOptions.t() | nil
) ::
  {:ok, [XmtpElixirSdk.Conversation.t()]} | {:error, XmtpElixirSdk.Error.t()}

list_groups(client, opts \\ %Types.ListConversationsOptions{})

@spec list_groups(
  XmtpElixirSdk.Client.t(),
  XmtpElixirSdk.Types.ListConversationsOptions.t() | nil
) ::
  {:ok, [XmtpElixirSdk.Conversation.t()]} | {:error, XmtpElixirSdk.Error.t()}

sync(client)

@spec sync(XmtpElixirSdk.Client.t()) ::
  {:ok, XmtpElixirSdk.Types.SyncResult.t()} | {:error, XmtpElixirSdk.Error.t()}

sync_all(client, consent_states \\ [])

@spec sync_all(XmtpElixirSdk.Client.t(), [XmtpElixirSdk.Types.consent_state()] | nil) ::
  {:ok, XmtpElixirSdk.Types.SyncResult.t()} | {:error, XmtpElixirSdk.Error.t()}

topic(client)

@spec topic(XmtpElixirSdk.Client.t()) :: String.t() | nil