client.provider_imports
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
Move from Resend: suppressions, audiences, contacts, templates and webhooks come across with one key, with a checklist for domains and API keys.
provider_imports.inspect
Look inside a Resend account before importing
inspect(provider_key = nil, api_key: nil) -> HashReads the first page of every resource with a full-access Resend key and returns a count for each, with more set where a resource runs past its first page. Nothing is stored, and the key is not kept.
A sending-only key is 400 restricted_key: create a full-access key at Resend for the import and revoke it afterwards.
Parameters
provider_keyStringRequiredA full-access Resend API key,
re_…. It goes in the request body and is not the OpenEmail key the call authenticates with.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with provider and counts, which holds one Hash per resource (suppressions, audiences, contacts, templates, webhooks, domains and api-keys), each with count and more.
Example
inventory = client.provider_imports.inspect("re_8Rk2Lq5T_7nVwX3yZp9QhMcB4dFs6JgA") p inventory[:counts][:contacts]Notes
A key restricted to addresses or domains is refused, since audiences, suppressions and templates belong to the whole workspace.
Called with no argument,
inspectis Ruby's own and describes the resource object without calling the API, so always pass the Resend key.
Also available in
provider_imports.create
Import from Resend
create(body = nil, api_key: nil, **fields) -> HashQueues an import from a Resend account. Suppressions keep their reason, segments become audiences, subscribed contacts arrive with their names, templates arrive as HTML templates with their variables declared, and webhooks are registered switched off because deliveries here are signed differently. Domains and API keys come back as a checklist in the report, since a signing key or a token cannot leave Resend.
The key is held encrypted only while the import runs and is erased when it ends, fails or is cancelled. Running it twice duplicates nothing.
Parameters
apiKeyStringRequiredA full-access Resend API key. This is the body field
apiKey:, which is not theapi_key:option that overrides the OpenEmail key.resourcesArray<String>RequiredAny of
suppressions,audiences,contacts,templates,webhooks,domainsandapi-keys.api_keyStringOverrides the client API key for this call only.
Returns
A Hash for the provider import, shaped like the one get returns, with status set to queued.
Example
job = client.provider_imports.create( apiKey: "re_8Rk2Lq5T_7nVwX3yZp9QhMcB4dFs6JgA", resources: ["suppressions", "audiences", "contacts", "templates", "webhooks", "domains", "api-keys"]) puts job[:id], job[:status]Notes
One import runs per workspace at a time; a second is 409
already_running.Contacts who unsubscribed at Resend are left out and counted in
report[:contacts][:unsubscribed].
Also available in
provider_imports.list
List one page of imports from sending providers
list(limit: nil, cursor: nil, api_key: nil) -> OpenEmail::PageOne page of the provider imports in the workspace, newest first, each with its report. Nothing is dropped from the history: follow next_cursor while has_more? is true to reach the first one, or let list_all and iterate do that walk.
Parameters
limitIntegerRows per page, a whole number from 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorfrom the previous page. One that names no provider import in the workspace is a 400invalid_cursor.api_keyStringOverrides the client API key for this call only.
Returns
An OpenEmail::Page of provider import Hashes, with items, has_more? and next_cursor.
Example
page = client.provider_imports.list p page.items.map { |job| job[:status] }, page.has_more?Also available in
provider_imports.list_all
Collect every provider import into one array
list_all(limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Follows next_cursor from page to page and returns every provider import in the workspace, newest first, each with its report.
Parameters
limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringA provider import id to start after.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Array of provider import Hashes holding every provider import across all pages.
Example
jobs = client.provider_imports.list_all puts jobs.count { |job| job[:status] == "completed" }Notes
A failure on any page raises out of the whole call, and none of the pages already read are returned.
Also available in
- API
GET /provider-imports- TypeScript
providerImports.listAll()- Python
provider_imports.list_all()
provider_imports.iterate
Stream provider imports one at a time
iterate(limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator that yields provider imports individually, newest first, or yields each one to a block when given one, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests.
Parameters
limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringA provider import id to start after.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Enumerator of provider import Hashes (or yields each one to a block), one provider import per step.
Example
client.provider_imports.iterate do |job| puts job[:id] if job[:status] == "running"endNotes
The Enumerator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
- API
GET /provider-imports- TypeScript
providerImports.iterate()- Python
provider_imports.iterate()
provider_imports.get
Read one import from a sending provider
get(id, api_key: nil) -> HashStatus, the step it is on and the report so far. Poll it while status is queued or running.
Parameters
idStringRequiredProvider import id,
pimp_followed by 24 hex characters.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with id, provider, status, resources, step, report, lastError, createdAt, startedAt and finishedAt. report holds a Hash for each resource, such as report[:contacts][:added].
Example
job = client.provider_imports.get("pimp_3f9c2a7b1e4d8f60a5c7b92d") puts job[:status], job[:report][:contacts][:added]Also available in
provider_imports.cancel
Cancel an import from a sending provider
cancel(id, api_key: nil) -> HashStops the import and erases the Resend key. What already came across stays.
Parameters
idStringRequiredProvider import id,
pimp_followed by 24 hex characters.api_keyStringOverrides the client API key for this call only.
Returns
The provider import Hash, shaped like the one get returns, with status set to cancelled.
Example
client.provider_imports.cancel("pimp_3f9c2a7b1e4d8f60a5c7b92d")