KapsoEx.Platform.DisplayNames (kapso_ex v0.1.0)

Copy Markdown View Source

Display name change requests. Meta reviews most changes within 24-48 hours; poll get/3 to follow the review.

Summary

Functions

Requests a display name change.

Gets a display name request and its review status.

Lists display name requests for a number, most recent first. Params: page, per_page.

Types

result()

@type result() :: {:ok, map()} | {:error, KapsoEx.Error.t()}

Functions

create(client, phone_number_id, new_display_name)

@spec create(KapsoEx.Client.t(), String.t(), String.t()) :: result()

Requests a display name change.

get(client, phone_number_id, request_id)

@spec get(KapsoEx.Client.t(), String.t(), String.t()) :: result()

Gets a display name request and its review status.

list(client, phone_number_id, params \\ [])

@spec list(KapsoEx.Client.t(), String.t(), map() | keyword()) :: result()

Lists display name requests for a number, most recent first. Params: page, per_page.