Twilio.Bulkexports.V1.Export.ConfigurationService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for Configuration API operations.

Operations: fetch, update

Summary

Functions

Fetch a specific Export Configuration.

Update a specific Export Configuration.

Functions

fetch(client, resource_type, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Bulkexports.V1.Export.Configuration.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Fetch a specific Export Configuration.

Operation: FetchExportConfiguration | Tags: BulkexportsV1ExportConfiguration

update(client, resource_type, params \\ %{}, opts \\ [])

@spec update(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Bulkexports.V1.Export.Configuration.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Update a specific Export Configuration.

Operation: UpdateExportConfiguration | Tags: BulkexportsV1ExportConfiguration

Optional Parameters

ParameterTypeDescription
EnabledbooleanIf true, Twilio will automatically generate every day's file when the day is over.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

WebhookMethodstringSets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url
WebhookUrlstring (uri)Stores the URL destination for the method specified in webhook_method.