# ovok_sdk.resources.platform

Canonical page: https://docs.ovok.com/python-sdk/reference/resources/platform

Platform administration: accounts, projects, locales, localizations and email templates.

## AccountsResource [#accountsresource]

```python
AccountsResource(http: HttpClient)
```

The signed-in user's accounts; access it as `ovok.accounts`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `http` | `HttpClient` |  | The client's HTTP client. |

### list() [#list]

```python
list() -> Any
```

List the accounts the signed-in user can access.

**Returns**

- `Any`: The accounts.

## ProjectFeaturesResource [#projectfeaturesresource]

```python
ProjectFeaturesResource(http: HttpClient)
```

The current project's features; access it as `ovok.projects.features`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `http` | `HttpClient` |  | The client's HTTP client. |

### retrieve() [#retrieve]

```python
retrieve() -> Any
```

Read the current project's features.

**Returns**

- `Any`: The project's features.

### update() [#update]

```python
update(features: list[Any]) -> Any
```

Replace the current project's features.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `features` | `list[Any]` |  | The full feature list. |

**Returns**

- `Any`: The updated features.

## ProjectMembersResource [#projectmembersresource]

```python
ProjectMembersResource(http: HttpClient)
```

Members of the current project; access it as `ovok.projects.members`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `http` | `HttpClient` |  | The client's HTTP client. |

### list() [#list-1]

```python
list(query: QueryParams | None = None) -> Page[Any]
```

List the project's members.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `query` | `QueryParams \| None` | `None` | Optional query parameters; `page` is the 0-based first page. |

**Returns**

- `Page[Any]`: A page of memberships that loads later pages on demand.

### invite() [#invite]

```python
invite(body: JsonObject) -> Any
```

Invite a member to the project.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `body` | `JsonObject` |  | The invitation as the API takes it. |

**Returns**

- `Any`: The created membership.

### update() [#update-1]

```python
update(membership_id: str, body: JsonObject) -> Any
```

Update a membership.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `membership_id` | `str` |  | The membership ID. |
| `body` | `JsonObject` |  | The fields to change. |

**Returns**

- `Any`: The updated membership.

### remove() [#remove]

```python
remove(membership_id: str) -> Any
```

Remove a member from the project.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `membership_id` | `str` |  | The membership ID. |

**Returns**

- `Any`: The API's delete response.

## ProjectSettingsResource [#projectsettingsresource]

```python
ProjectSettingsResource(http: HttpClient)
```

The current project's settings; access it as `ovok.projects.settings`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `http` | `HttpClient` |  | The client's HTTP client. |

### retrieve() [#retrieve-1]

```python
retrieve() -> Any
```

Read the project's settings.

**Returns**

- `Any`: The settings.

### update() [#update-2]

```python
update(key: str, enabled: bool) -> Any
```

Turn an on/off setting on or off.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `key` | `str` |  | The setting key. |
| `enabled` | `bool` |  | The new state. |

**Returns**

- `Any`: The updated setting.

### update_text() [#update_text]

```python
update_text(key: str, value: str | None) -> Any
```

Set or clear a text setting.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `key` | `str` |  | The setting key. |
| `value` | `str \| None` |  | The new value, or None to clear it. |

**Returns**

- `Any`: The updated setting.

## ProjectsResource [#projectsresource]

```python
ProjectsResource(http: HttpClient)
```

Administered projects, and the current project's members, features and settings.

Created by `Ovok`; access it as `ovok.projects`.

### list() [#list-2]

```python
list(query: QueryParams | None = None) -> Page[Any]
```

List the projects the signed-in user administers.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `query` | `QueryParams \| None` | `None` | Optional query parameters; `page` is the 0-based first page. |

**Returns**

- `Page[Any]`: A page of projects that loads later pages on demand.

## LocalesResource [#localesresource]

```python
LocalesResource(http: HttpClient)
```

The project's enabled locales; access it as `ovok.locales`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `http` | `HttpClient` |  | The client's HTTP client. |

### retrieve() [#retrieve-2]

```python
retrieve() -> Any
```

Read the project's locales.

**Returns**

- `Any`: The locales.

### update() [#update-3]

```python
update(locales: JsonObject) -> Any
```

Update the project's locales.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `locales` | `JsonObject` |  | The locale fields to change. |

**Returns**

- `Any`: The updated locales.

## I18nextResource [#i18nextresource]

```python
I18nextResource(http: HttpClient)
```

Localizations as i18next documents; access it as `ovok.localizations.i18next`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `http` | `HttpClient` |  | The client's HTTP client. |

### retrieve() [#retrieve-3]

```python
retrieve(language: str) -> Any
```

Read a language's localizations as one i18next document.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `language` | `str` |  | The language code, such as `"en"`. |

**Returns**

- `Any`: The i18next document.

### update() [#update-4]

```python
update(language: str, document: JsonObject) -> None
```

Update a language's localizations from an i18next document.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `language` | `str` |  | The language code. |
| `document` | `JsonObject` |  | The i18next document. |

## LocalizationsResource [#localizationsresource]

```python
LocalizationsResource(http: HttpClient)
```

The project's localization entries by language and key.

Created by `Ovok`; access it as `ovok.localizations`.

### list() [#list-3]

```python
list(language: str, query: QueryParams | None = None) -> Any
```

List a language's localization entries.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `language` | `str` |  | The language code. |
| `query` | `QueryParams \| None` | `None` | Optional query parameters passed to the API. |

**Returns**

- `Any`: The entries.

### retrieve() [#retrieve-4]

```python
retrieve(language: str, key: str) -> Any
```

Read one localization entry.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `language` | `str` |  | The language code. |
| `key` | `str` |  | The entry key. |

**Returns**

- `Any`: The entry.

### update() [#update-5]

```python
update(language: str, key: str, body: JsonObject) -> Any
```

Create or replace one localization entry.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `language` | `str` |  | The language code. |
| `key` | `str` |  | The entry key. |
| `body` | `JsonObject` |  | The entry as the API takes it. |

**Returns**

- `Any`: The stored entry.

### delete() [#delete]

```python
delete(language: str, key: str) -> None
```

Delete one localization entry.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `language` | `str` |  | The language code. |
| `key` | `str` |  | The entry key. |

## EmailTemplatesResource [#emailtemplatesresource]

```python
EmailTemplatesResource(http: HttpClient)
```

The project's email templates; access it as `ovok.email.templates`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `http` | `HttpClient` |  | The client's HTTP client. |

### list() [#list-4]

```python
list() -> Any
```

List the project's email templates.

**Returns**

- `Any`: The templates.

## EmailResource [#emailresource]

```python
EmailResource(http: HttpClient)
```

Project email settings.

Created by `Ovok`; access it as `ovok.email`.