---
title: "client.provider_imports"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://openemail.uk/docs/ruby/reference/provider-imports"
area: "Ruby"
category: "Reference"
---

# 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

```ruby
inspect(provider_key = nil, api_key: nil) -> Hash
```

Reads 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.

Scopes: `settings:write`.

**Parameters**

- `provider_key` (`String`, required): A full-access Resend API key, `re_…`. It goes in the request body and is not the OpenEmail key the call authenticates with.
- `api_key` (`String`): Overrides 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**

```ruby
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, `inspect` is Ruby's own and describes the resource object without calling the API, so always pass the Resend key.

Also available in: API [`POST /provider-imports/inspect`](https://openemail.uk/docs/api/reference/imports#post-provider-imports-inspect); TypeScript [`providerImports.inspect()`](https://openemail.uk/docs/sdk/reference/provider-imports#inspect); Python [`provider_imports.inspect()`](https://openemail.uk/docs/python/reference/provider-imports#inspect); CLI [`openemail provider-imports inspect`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-inspect).

### `provider_imports.create`

Import from Resend

```ruby
create(body = nil, api_key: nil, **fields) -> Hash
```

Queues 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.

Scopes: `settings:write`.

**Parameters**

- `apiKey` (`String`, required): A full-access Resend API key. This is the body field `apiKey:`, which is not the `api_key:` option that overrides the OpenEmail key.
- `resources` (`Array<String>`, required): Any of `suppressions`, `audiences`, `contacts`, `templates`, `webhooks`, `domains` and `api-keys`.
- `api_key` (`String`): Overrides 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**

```ruby
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: API [`POST /provider-imports`](https://openemail.uk/docs/api/reference/imports#post-provider-imports); TypeScript [`providerImports.create()`](https://openemail.uk/docs/sdk/reference/provider-imports#create); Python [`provider_imports.create()`](https://openemail.uk/docs/python/reference/provider-imports#create); CLI [`openemail provider-imports create`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-create).

### `provider_imports.list`

List one page of imports from sending providers

```ruby
list(limit: nil, cursor: nil, api_key: nil) -> OpenEmail::Page
```

One 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.

Scopes: `settings:read`.

**Parameters**

- `limit` (`Integer`): Rows per page, a whole number from 1 to 100. The server defaults to 25.
- `cursor` (`String`): The `next_cursor` from the previous page. One that names no provider import in the workspace is a 400 `invalid_cursor`.
- `api_key` (`String`): Overrides the client API key for this call only.

**Returns**

An `OpenEmail::Page` of provider import Hashes, with `items`, `has_more?` and `next_cursor`.

**Example**

```ruby
page = client.provider_imports.list

p page.items.map { |job| job[:status] }, page.has_more?
```

Also available in: API [`GET /provider-imports`](https://openemail.uk/docs/api/reference/imports#get-provider-imports); TypeScript [`providerImports.list()`](https://openemail.uk/docs/sdk/reference/provider-imports#list); Python [`provider_imports.list()`](https://openemail.uk/docs/python/reference/provider-imports#list); CLI [`openemail provider-imports list`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-list).

### `provider_imports.list_all`

Collect every provider import into one array

```ruby
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.

Scopes: `settings:read`.

**Parameters**

- `limit` (`Integer`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `cursor` (`String`): A provider import id to start after.
- `api_key` (`String`): Overrides 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**

```ruby
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`](https://openemail.uk/docs/api/reference/imports#get-provider-imports); TypeScript [`providerImports.listAll()`](https://openemail.uk/docs/sdk/reference/provider-imports#listAll); Python [`provider_imports.list_all()`](https://openemail.uk/docs/python/reference/provider-imports#listAll).

### `provider_imports.iterate`

Stream provider imports one at a time

```ruby
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.

Scopes: `settings:read`.

**Parameters**

- `limit` (`Integer`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `cursor` (`String`): A provider import id to start after.
- `api_key` (`String`): Overrides 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**

```ruby
client.provider_imports.iterate do |job|
  puts job[:id] if job[:status] == "running"
end
```

**Notes**

- The Enumerator is lazy, so an abandoned loop costs only the pages you consumed.

Also available in: API [`GET /provider-imports`](https://openemail.uk/docs/api/reference/imports#get-provider-imports); TypeScript [`providerImports.iterate()`](https://openemail.uk/docs/sdk/reference/provider-imports#iterate); Python [`provider_imports.iterate()`](https://openemail.uk/docs/python/reference/provider-imports#iterate).

### `provider_imports.get`

Read one import from a sending provider

```ruby
get(id, api_key: nil) -> Hash
```

Status, the step it is on and the report so far. Poll it while `status` is `queued` or `running`.

Scopes: `settings:read`.

**Parameters**

- `id` (`String`, required): Provider import id, `pimp_` followed by 24 hex characters.
- `api_key` (`String`): Overrides 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**

```ruby
job = client.provider_imports.get("pimp_3f9c2a7b1e4d8f60a5c7b92d")

puts job[:status], job[:report][:contacts][:added]
```

Also available in: API [`GET /provider-imports/{id}`](https://openemail.uk/docs/api/reference/imports#get-provider-imports-id); TypeScript [`providerImports.get()`](https://openemail.uk/docs/sdk/reference/provider-imports#get); Python [`provider_imports.get()`](https://openemail.uk/docs/python/reference/provider-imports#get); CLI [`openemail provider-imports get`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-get).

### `provider_imports.cancel`

Cancel an import from a sending provider

```ruby
cancel(id, api_key: nil) -> Hash
```

Stops the import and erases the Resend key. What already came across stays.

Scopes: `settings:write`.

**Parameters**

- `id` (`String`, required): Provider import id, `pimp_` followed by 24 hex characters.
- `api_key` (`String`): Overrides 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**

```ruby
client.provider_imports.cancel("pimp_3f9c2a7b1e4d8f60a5c7b92d")
```

Also available in: API [`POST /provider-imports/{id}/cancel`](https://openemail.uk/docs/api/reference/imports#post-provider-imports-id-cancel); TypeScript [`providerImports.cancel()`](https://openemail.uk/docs/sdk/reference/provider-imports#cancel); Python [`provider_imports.cancel()`](https://openemail.uk/docs/python/reference/provider-imports#cancel); CLI [`openemail provider-imports cancel`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-cancel).