Twilio.Memory.V1.Store.Profile.ImportService (twilio_elixir v0.1.3)

Service for Import API operations.

Operations: list, create, fetch

Summary

Functions

create(client, store_id, params \\ %{}, opts \\ [])

fetch(client, store_id, sid, opts \\ [])

list(client, store_id, params \\ %{}, opts \\ [])

stream(client, store_id, params \\ %{}, opts \\ [])

Stream: Retrieve a list of profile import task IDs that have been submitted for this service. Use these IDs to query individual import status details. (lazy auto-pagination).

Functions

create(client, store_id, params \\ %{}, opts \\ [])

@spec create(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Memory.V1.Store.Profile.Import.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

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

Initiate a profile import by requesting a pre-signed upload URL and an associated importId. Upload your CSV to the returned URL (single PUT). Query the import status endpoint to track processing progress. This endpoint creates the import task and allocates resources for subsequent ingestion.

Operation: CreateProfilesImportV2 | Tags: Profile

Required Parameters

Parameter	Type	Description
`columnMappings`	array	Mappings of CSV header columns to traits' fields
`fileSize`	integer	The size of the file in bytes (1 byte to 100 MiB)
`filename`	string	The name of the file to generate a presigned URL

fetch(client, store_id, sid, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Memory.V1.Store.Profile.Import.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

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

Retrieve the current processing status of a previously submitted bulk import task. Query this endpoint using the importId returned from the upload URL request until a terminal state (COMPLETED or FAILED) is reached.

Operation: FetchProfileImportV2 | Tags: Profile

list(client, store_id, params \\ %{}, opts \\ [])

@spec list(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Page.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

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

Retrieve a list of profile import task IDs that have been submitted for this service. Use these IDs to query individual import status details.

Operation: ListProfileImportsV2 | Tags: Profile

stream(client, store_id, params \\ %{}, opts \\ [])

@spec stream(Twilio.Client.t(), String.t(), map(), keyword()) :: Enumerable.t()

Stream: Retrieve a list of profile import task IDs that have been submitted for this service. Use these IDs to query individual import status details. (lazy auto-pagination).