openemail.provider_imports
Jede Methode in diesem Namespace: ihre Signatur, ihre Parameter, was sie zurückgibt und ein Beispiel.
Methoden
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
def inspect( provider_key: str, *, api_key: str | None = None, timeout: float | None = None,) -> ProviderInventoryResourceReads 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 raises a 400 restricted_key: create a full-access key at Resend for the import and revoke it afterwards.
Parameter
provider_keystrErforderlichA full-access Resend API key,
re_…. The SDK sends it asapiKeyin the request body.api_keystrOverrides the OpenEmail API key of the client for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Rückgabe
ProviderInventoryResource, a dict with object, provider and counts, which maps each resource name to a dict with count and more.
Beispiel
from openemail import openemail inventory = openemail.provider_imports.inspect('re_123456789') for resource, found in inventory['counts'].items(): suffix = ' or more' if found['more'] else '' print(f'{resource}: {found["count"]}{suffix}')Hinweise
An OpenEmail key limited to particular addresses or domains is refused with 422
capability_unsupported, since audiences, suppressions and templates belong to the whole workspace.A key Resend does not accept raises a 400
invalid_key, and a Resend that cannot be reached a 503unreachable.
Auch verfügbar über
provider_imports.create()
Import from Resend
def create( body: ProviderImportCreate, *, api_key: str | None = None, timeout: float | None = None,) -> ProviderImportResourceQueues 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.
Parameter
body['apiKey']strErforderlichA full-access Resend API key.
body['resources']list[ProviderImportResourceKind]ErforderlichA list of one or more of
'suppressions','audiences','contacts','templates','webhooks','domains'and'api-keys'.api_keystrOverrides the OpenEmail API key of the client for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Rückgabe
ProviderImportResource with status set to 'queued'.
Beispiel
from openemail import openemail job = openemail.provider_imports.create( { 'apiKey': 're_123456789', 'resources': [ 'suppressions', 'audiences', 'contacts', 'templates', 'webhooks', 'domains', 'api-keys', ], }) print(job['id'], job['status'])Hinweise
One import runs per workspace at a time, and a second raises a 409
already_running.Contacts who unsubscribed at Resend are left out and counted in
report['contacts']['unsubscribed'].Besides
settings:write, the key needs the scope behind each resource it brings across:audiences:writefor audiences,contacts:writeandaudiences:writefor contacts,templates:write,webhooks:writeanddomains:read. A missing one is a 403insufficient_scope.Not retried by the SDK. Poll
getwith the returnedidrather than calling it again.
Auch verfügbar über
provider_imports.list()
List one page of imports from sending providers
def list( *, limit: int | None = None, cursor: str | None = None, api_key: str | None = None, timeout: float | None = None,) -> Page[ProviderImportResource]One page of the provider imports in the workspace, newest first, each with its report. Nothing is dropped from the history: follow nextCursor while hasMore is True to reach the first one, or let list_all and iterate do that walk.
Parameter
limitintRows per page, a whole number from 1 to 100. The server defaults to 25.
cursorstrThe
nextCursorfrom the previous page. One that names no provider import in the workspace raises a 400invalid_cursor.api_keystrOverrides the OpenEmail API key of the client for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Rückgabe
Page[ProviderImportResource], a dict with items, hasMore and nextCursor.
Beispiel
from openemail import openemail page = openemail.provider_imports.list(limit=10) for job in page['items']: print(job['id'], job['status'], job['createdAt']) print(page['hasMore'], page['nextCursor'])Auch verfügbar über
provider_imports.list_all()
Collect every provider import into one list
def list_all( *, limit: int | None = None, cursor: str | None = None, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[ProviderImportResource]Follows nextCursor from page to page and returns every provider import in the workspace as one list, newest first, each with its report.
Parameter
limitintPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorstrA provider import id to start after.
api_keystrOverrides the OpenEmail API key of the client for every page of this walk.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Rückgabe
list[ProviderImportResource] holding every provider import across all pages.
Beispiel
from openemail import openemail jobs = openemail.provider_imports.list_all() completed = [job for job in jobs if job['status'] == 'completed']print(f'{len(completed)} of {len(jobs)} imports completed')Hinweise
A failure on any page raises out of the whole call, and the imports already fetched are discarded.
timeout=applies to each page request on its own, not to the whole walk.
Auch verfügbar über
provider_imports.iterate()
Stream provider imports one at a time
def iterate( *, limit: int | None = None, cursor: str | None = None, api_key: str | None = None, timeout: float | None = None,) -> Iterator[ProviderImportResource]Returns a generator that yields provider imports one at a time, newest first, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests.
Parameter
limitintPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorstrA provider import id to start after.
api_keystrOverrides the OpenEmail API key of the client for every page of this walk.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Rückgabe
Iterator[ProviderImportResource], a generator yielding one provider import per step.
Beispiel
from openemail import openemail for job in openemail.provider_imports.iterate(): if job['status'] == 'running': print(job['id'], job['step'])Hinweise
The generator is lazy, so an abandoned loop costs only the pages you consumed.
A page that fails raises out of the
forloop, after the imports of the earlier pages have been yielded.
Auch verfügbar über
provider_imports.get()
Read one import from a sending provider
def get( id: str, *, api_key: str | None = None, timeout: float | None = None,) -> ProviderImportResourceStatus, the step it is on and the report so far. Poll it while status is 'queued' or 'running'.
Parameter
idstrErforderlichProvider import id,
pimp_followed by 24 hex characters.api_keystrOverrides the OpenEmail API key of the client for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Rückgabe
ProviderImportResource, a dict with id, provider, status, resources, step, report, lastError, createdAt, startedAt and finishedAt.
Beispiel
from openemail import openemail job = openemail.provider_imports.get('pimp_3f9c2a7b1e4d8f60a5c7b92d') contacts = job['report']['contacts']print(job['status'], job['step'], contacts['added'], contacts['unsubscribed'])Hinweise
An id that names no import in the workspace raises a 404, so
is_not_foundis the check to make.
Auch verfügbar über
provider_imports.cancel()
Cancel an import from a sending provider
def cancel( id: str, *, api_key: str | None = None, timeout: float | None = None,) -> ProviderImportResourceStops the import and erases the Resend key. What already came across stays.
Parameter
idstrErforderlichProvider import id,
pimp_followed by 24 hex characters.api_keystrOverrides the OpenEmail API key of the client for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Rückgabe
ProviderImportResource with status set to 'cancelled'.
Beispiel
from openemail import OpenEmailApiError, openemail try: job = openemail.provider_imports.cancel('pimp_3f9c2a7b1e4d8f60a5c7b92d') print(job['status'], job['finishedAt'])except OpenEmailApiError as error: if not error.is_conflict: raise print('That import has already finished')Hinweise
An import that has already finished raises a 409
not_cancellable.