diff --git a/README.md b/README.md
index aba6de0b..1a664411 100644
--- a/README.md
+++ b/README.md
@@ -255,3 +255,4 @@ while response.next is not None:
+
diff --git a/reference.md b/reference.md
index ff937ee4..d46addad 100644
--- a/reference.md
+++ b/reference.md
@@ -57047,6 +57047,4503 @@ client.chat.webhook_receivers.create(
+
+
+
+
+## Email AccountDetails
+client.email.account_details.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get details for a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.account_details.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.account_token.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the account token for the end user with the provided public token.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.account_token.retrieve(
+ public_token="public_token",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**public_token:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.account_token.regenerate_create()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Exchange Linked Account account tokens.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.account_token.regenerate_create()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.async_passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+from merge.resources.email import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.async_passthrough.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.audit_trail.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.audit_trail.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ end_date="end_date",
+ event_type="event_type",
+ page_size=1,
+ start_date="start_date",
+ user_email="user_email",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+
+
+
+
+
+-
+
+**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+
+
+
+
+
+-
+
+**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.available_actions.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.available_actions.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.scopes.default_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.scopes.default_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.scopes.linked_account_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.scopes.linked_account_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.scopes.linked_account_scopes_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+from merge.resources.email import (
+ FieldPermissionDeserializerRequest,
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.scopes.linked_account_scopes_create(
+ common_models=[
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Employee",
+ model_permissions={
+ "READ": ModelPermissionDeserializerRequest(
+ is_enabled=True,
+ ),
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ ),
+ },
+ field_permissions=FieldPermissionDeserializerRequest(
+ enabled_fields=["avatar", "home_location"],
+ disabled_fields=["work_location"],
+ ),
+ ),
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Benefit",
+ model_permissions={
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ )
+ },
+ ),
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.delete_account.delete()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.delete_account.delete()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.email_addresses.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `EmailAddress` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.email_addresses.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ email_address="email_address",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ page_size=1,
+ remote_id="remote_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**email_address:** `typing.Optional[str]` — If provided, will only return EmailAddresses matching this value (case insensitive).
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ EmailAddressesListRequestExpandItem,
+ typing.Sequence[EmailAddressesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.email_addresses.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `EmailAddress` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.email_addresses.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ EmailAddressesRetrieveRequestExpandItem,
+ typing.Sequence[EmailAddressesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.field_mapping.field_mappings_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.field_mapping.field_mappings_retrieve(
+ exclude_remote_field_metadata=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.field_mapping.field_mappings_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.field_mapping.field_mappings_create(
+ exclude_remote_field_metadata=True,
+ remote_data_iteration_count=1,
+ remote_field_traversal_path=["example_remote_field"],
+ remote_method="GET",
+ remote_url_path="/example-url-path",
+ common_model_name="ExampleCommonModel",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
+
+
+
+
+
+-
+
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+
+
+
+
+
+-
+
+**remote_data_iteration_count:** `typing.Optional[int]` — Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.
+
+
+
+
+
+-
+
+**target_field_name:** `typing.Optional[str]` — The name of the target field you want this remote field to map to. Required if organization_wide_target_field is not provided.
+
+
+
+
+
+-
+
+**target_field_description:** `typing.Optional[str]` — The description of the target field you want this remote field to map to. Required if organization_wide_target_field is not provided.
+
+
+
+
+
+-
+
+**organization_wide_target_field:** `typing.Optional[str]` — The name or key of an existing Organization-wide target field to map to. When provided, target_field_name and target_field_description are optional.
+
+
+
+
+
+-
+
+**is_integration_wide:** `typing.Optional[bool]` — If true, creates an integration-wide field mapping that applies to all Linked Accounts for the integration. Requires organization_wide_target_field.
+
+
+
+
+
+-
+
+**jmes_path:** `typing.Optional[str]` — DEPRECATED: Use 'advanced_mapping_expression' instead.
+
+
+
+
+
+-
+
+**advanced_mapping_expression:** `typing.Optional[str]` — A JSONata expression used to transform the remote field data.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.field_mapping.field_mappings_destroy(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.field_mapping.field_mappings_partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
+ remote_data_iteration_count=1,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**remote_data_iteration_count:** `typing.Optional[int]` — Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**jmes_path:** `typing.Optional[str]` — DEPRECATED: Use 'advanced_mapping_expression' instead.
+
+
+
+
+
+-
+
+**advanced_mapping_expression:** `typing.Optional[str]` — A JSONata expression used to transform the remote field data.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.field_mapping.remote_fields_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.field_mapping.remote_fields_retrieve(
+ common_models="common_models",
+ include_example_values="include_example_values",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+
+
+
+
+
+-
+
+**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.field_mapping.target_fields_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.field_mapping.target_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.field_mapping.target_fields_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a new organization-wide Target Field. Target Fields are custom fields that your organization defines to collect supplemental data from integrations. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.field_mapping.target_fields_create(
+ name="employee_favorite_team",
+ common_model="Employee",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the target field.
+
+
+
+
+
+-
+
+**common_model:** `str` — The name of the Common Model to associate the target field with.
+
+
+
+
+
+-
+
+**description:** `typing.Optional[str]` — The description of the target field.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.folders.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Folder` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.folders.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ name="name",
+ page_size=1,
+ remote_id="remote_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ FoldersListRequestExpandItem,
+ typing.Sequence[FoldersListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**name:** `typing.Optional[str]` — If provided, will only return Folders with this name.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.folders.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Folder` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.folders.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ FoldersRetrieveRequestExpandItem,
+ typing.Sequence[FoldersRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.generate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a remote key.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.generate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.groups.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Group` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.groups.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ page_size=1,
+ remote_id="remote_id",
+ user_id="user_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ GroupsListRequestExpandItem,
+ typing.Sequence[GroupsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**user_id:** `typing.Optional[str]` — If provided, will only return Groups containing this User.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.groups.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Group` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.groups.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ GroupsRetrieveRequestExpandItem,
+ typing.Sequence[GroupsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.issues.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets all issues for Organization.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+from merge.resources.email.resources.issues import IssuesListRequestStatus
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.issues.list(
+ account_token="account_token",
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ end_date="end_date",
+ end_user_organization_name="end_user_organization_name",
+ first_incident_time_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ first_incident_time_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ include_muted="include_muted",
+ integration_name="integration_name",
+ last_incident_time_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ last_incident_time_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ linked_account_id="linked_account_id",
+ page_size=1,
+ start_date="start_date",
+ status=IssuesListRequestStatus.ONGOING,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_token:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+
+
+
+
+
+-
+
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+
+
+
+
+
+-
+
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
+
+
+
+
+
+-
+
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+
+
+
+
+
+-
+
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+
+
+
+
+
+-
+
+**status:** `typing.Optional[IssuesListRequestStatus]` — Status of the issue.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.issues.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a specific issue.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.issues.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.link_token.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user. The link token expires after single use.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+from merge.resources.email import CategoriesEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.link_token.create(
+ end_user_email_address="example@gmail.com",
+ end_user_organization_name="Test Organization",
+ end_user_origin_id="12345",
+ categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `str` — Your end user's organization.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+
+
+
+
+
+-
+
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+
+
+
+
+
+-
+
+**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+
+
+
+
+
+-
+
+**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+
+
+
+
+
+-
+
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+
+
+
+
+-
+
+**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+
+
+
+
+-
+
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+
+
+
+
+-
+
+**category_common_model_scopes:** `typing.Optional[
+ typing.Dict[
+ str,
+ typing.Optional[
+ typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
+ ],
+ ]
+]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+
+
+
+
+-
+
+**language:** `typing.Optional[EndUserDetailsRequestLanguage]` — The following subset of IETF language tags can be used to configure localization.
+
+
+
+
+
+-
+
+**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
+
+
+
+
+
+-
+
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
+
+
+
+
+
+-
+
+**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` — When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account.
+
+
+
+
+
+-
+
+**linked_destination_id:** `typing.Optional[str]` — The UUID of the linked destination that you want this Linked Account to be tied to.
+
+
+
+
+
+-
+
+**credential_id:** `typing.Optional[str]` — The id of the credential that you want this Linked Account to be tied to.
+
+
+
+
+
+-
+
+**ekm_enabled:** `typing.Optional[bool]` — Whether to enable EKM (External Key Management) for this Linked Account.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.linked_accounts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+from merge.resources.email.resources.linked_accounts import (
+ LinkedAccountsListRequestCategory,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.linked_accounts.list(
+ category=LinkedAccountsListRequestCategory.ACCOUNTING,
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ end_user_email_address="end_user_email_address",
+ end_user_organization_name="end_user_organization_name",
+ end_user_origin_id="end_user_origin_id",
+ end_user_origin_ids="end_user_origin_ids",
+ id="id",
+ ids="ids",
+ include_duplicates=True,
+ integration_name="integration_name",
+ is_test_account="is_test_account",
+ page_size=1,
+ status="status",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]` — Options: `hris`, `ats`, `accounting`, `ticketing`, `crm`, `mktg`, `filestorage`, `knowledgebase`, `chat`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
+
+
+
+
+
+-
+
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+
+
+
+
+
+-
+
+**id:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+
+
+
+
+
+-
+
+**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
+
+
+
+
+
+-
+
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.mailboxes.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Mailbox` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.mailboxes.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ page_size=1,
+ primary_email_address_id="primary_email_address_id",
+ remote_id="remote_id",
+ user_id="user_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ MailboxesListRequestExpandItem,
+ typing.Sequence[MailboxesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**primary_email_address_id:** `typing.Optional[str]` — If provided, will only return Mailboxes with this primary EmailAddress.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**user_id:** `typing.Optional[str]` — If provided, will only return Mailboxes associated with this User.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.mailboxes.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Mailbox` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.mailboxes.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ MailboxesRetrieveRequestExpandItem,
+ typing.Sequence[MailboxesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.messages.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Message` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.messages.list(
+ bcc_address_id="bcc_address_id",
+ cc_address_id="cc_address_id",
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ from_address_id="from_address_id",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ mailbox_id="mailbox_id",
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ page_size=1,
+ remote_id="remote_id",
+ thread_id="thread_id",
+ to_address_id="to_address_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**bcc_address_id:** `typing.Optional[str]` — If provided, will only return Messages with this EmailAddress in BCC.
+
+
+
+
+
+-
+
+**cc_address_id:** `typing.Optional[str]` — If provided, will only return Messages with this EmailAddress in CC.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ MessagesListRequestExpandItem,
+ typing.Sequence[MessagesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**from_address_id:** `typing.Optional[str]` — If provided, will only return Messages sent from this EmailAddress.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**mailbox_id:** `typing.Optional[str]` — If provided, will only return Messages in this Mailbox.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**thread_id:** `typing.Optional[str]` — If provided, will only return Messages belonging to this Thread.
+
+
+
+
+
+-
+
+**to_address_id:** `typing.Optional[str]` — If provided, will only return Messages sent to this EmailAddress.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.messages.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Message` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.messages.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ MessagesRetrieveRequestExpandItem,
+ typing.Sequence[MessagesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+from merge.resources.email import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.regenerate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Exchange remote keys.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.regenerate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.sync_status.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.sync_status.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ page_size=1,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.force_resync.sync_status_resync_create()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.force_resync.sync_status_resync_create()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.users.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.users.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ email_address_id="email_address_id",
+ group_id="group_id",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ mailbox_id="mailbox_id",
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ page_size=1,
+ remote_id="remote_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**email_address_id:** `typing.Optional[str]` — If provided, will only return Users with this EmailAddress.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ UsersListRequestExpandItem, typing.Sequence[UsersListRequestExpandItem]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**group_id:** `typing.Optional[str]` — If provided, will only return Users belonging to this Group.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**mailbox_id:** `typing.Optional[str]` — If provided, will only return Users associated with this Mailbox.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.users.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `User` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.users.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ UsersRetrieveRequestExpandItem,
+ typing.Sequence[UsersRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.webhook_receivers.list()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `WebhookReceiver` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.webhook_receivers.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.email.webhook_receivers.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `WebhookReceiver` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.email.webhook_receivers.create(
+ event="event",
+ is_active=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
Example: Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors)
+ """
+
+ categories: typing.Optional[typing.List[CategoriesEnum]] = pydantic.Field(default=None)
+ """
+ Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris].
+ """
+
+ image: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Company logo in rectangular shape.
+ """
+
+ square_image: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Company logo in square shape.
+ """
+
+ color: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The color of this integration used for buttons and text throughout the app and landing pages. Choose a darker, saturated color.
+ """
+
+ slug: typing.Optional[str] = None
+ api_endpoints_to_documentation_urls: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = (
+ pydantic.Field(default=None)
+ )
+ """
+ Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []}
+ """
+
+ webhook_setup_guide_url: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Setup guide URL for third party webhook creation. Exposed in Merge Docs.
+ """
+
+ category_beta_status: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+ """
+ Category or categories this integration is in beta status for.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/account_token.py b/src/merge/resources/email/types/account_token.py
new file mode 100644
index 00000000..6e82c8ac
--- /dev/null
+++ b/src/merge/resources/email/types/account_token.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .account_integration import AccountIntegration
+
+
+class AccountToken(UncheckedBaseModel):
+ account_token: str
+ integration: AccountIntegration
+ id: str
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/actions_enum.py b/src/merge/resources/email/types/actions_enum.py
new file mode 100644
index 00000000..5481c548
--- /dev/null
+++ b/src/merge/resources/email/types/actions_enum.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ActionsEnum = typing.Literal["READ"]
diff --git a/src/merge/resources/email/types/advanced_metadata.py b/src/merge/resources/email/types/advanced_metadata.py
new file mode 100644
index 00000000..60b5d072
--- /dev/null
+++ b/src/merge/resources/email/types/advanced_metadata.py
@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class AdvancedMetadata(UncheckedBaseModel):
+ id: str
+ display_name: typing.Optional[str] = None
+ description: typing.Optional[str] = None
+ is_required: typing.Optional[bool] = None
+ is_custom: typing.Optional[bool] = None
+ field_choices: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/async_passthrough_reciept.py b/src/merge/resources/email/types/async_passthrough_reciept.py
new file mode 100644
index 00000000..21c95080
--- /dev/null
+++ b/src/merge/resources/email/types/async_passthrough_reciept.py
@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class AsyncPassthroughReciept(UncheckedBaseModel):
+ async_passthrough_receipt_id: str
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/audit_log_event.py b/src/merge/resources/email/types/audit_log_event.py
new file mode 100644
index 00000000..69063d10
--- /dev/null
+++ b/src/merge/resources/email/types/audit_log_event.py
@@ -0,0 +1,46 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .audit_log_event_event_type import AuditLogEventEventType
+from .audit_log_event_role import AuditLogEventRole
+
+
+class AuditLogEvent(UncheckedBaseModel):
+ id: typing.Optional[str] = None
+ user_name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The User's full name at the time of this Event occurring.
+ """
+
+ user_email: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The User's email at the time of this Event occurring.
+ """
+
+ role: AuditLogEventRole = pydantic.Field()
+ """
+ Designates the role of the user (or SYSTEM/API if action not taken by a user) at the time of this Event occurring.
+ """
+
+ ip_address: str
+ event_type: AuditLogEventEventType = pydantic.Field()
+ """
+ Designates the type of event that occurred.
+ """
+
+ event_description: str
+ created_at: typing.Optional[dt.datetime] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/audit_log_event_event_type.py b/src/merge/resources/email/types/audit_log_event_event_type.py
new file mode 100644
index 00000000..f9c9d2b3
--- /dev/null
+++ b/src/merge/resources/email/types/audit_log_event_event_type.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .event_type_enum import EventTypeEnum
+
+AuditLogEventEventType = typing.Union[EventTypeEnum, str]
diff --git a/src/merge/resources/email/types/audit_log_event_role.py b/src/merge/resources/email/types/audit_log_event_role.py
new file mode 100644
index 00000000..fe91ed6f
--- /dev/null
+++ b/src/merge/resources/email/types/audit_log_event_role.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .role_enum import RoleEnum
+
+AuditLogEventRole = typing.Union[RoleEnum, str]
diff --git a/src/merge/resources/email/types/available_actions.py b/src/merge/resources/email/types/available_actions.py
new file mode 100644
index 00000000..8b5019d7
--- /dev/null
+++ b/src/merge/resources/email/types/available_actions.py
@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .account_integration import AccountIntegration
+from .model_operation import ModelOperation
+
+
+class AvailableActions(UncheckedBaseModel):
+ """
+ # The AvailableActions Object
+ ### Description
+ The `Activity` object is used to see all available model/operation combinations for an integration.
+
+ ### Usage Example
+ Fetch all the actions available for the `Zenefits` integration.
+ """
+
+ integration: AccountIntegration
+ passthrough_available: bool
+ available_model_operations: typing.Optional[typing.List[ModelOperation]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/categories_enum.py b/src/merge/resources/email/types/categories_enum.py
new file mode 100644
index 00000000..b6575458
--- /dev/null
+++ b/src/merge/resources/email/types/categories_enum.py
@@ -0,0 +1,45 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class CategoriesEnum(str, enum.Enum):
+ HRIS = "hris"
+ ATS = "ats"
+ ACCOUNTING = "accounting"
+ TICKETING = "ticketing"
+ CRM = "crm"
+ MKTG = "mktg"
+ FILESTORAGE = "filestorage"
+ KNOWLEDGEBASE = "knowledgebase"
+
+ def visit(
+ self,
+ hris: typing.Callable[[], T_Result],
+ ats: typing.Callable[[], T_Result],
+ accounting: typing.Callable[[], T_Result],
+ ticketing: typing.Callable[[], T_Result],
+ crm: typing.Callable[[], T_Result],
+ mktg: typing.Callable[[], T_Result],
+ filestorage: typing.Callable[[], T_Result],
+ knowledgebase: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is CategoriesEnum.HRIS:
+ return hris()
+ if self is CategoriesEnum.ATS:
+ return ats()
+ if self is CategoriesEnum.ACCOUNTING:
+ return accounting()
+ if self is CategoriesEnum.TICKETING:
+ return ticketing()
+ if self is CategoriesEnum.CRM:
+ return crm()
+ if self is CategoriesEnum.MKTG:
+ return mktg()
+ if self is CategoriesEnum.FILESTORAGE:
+ return filestorage()
+ if self is CategoriesEnum.KNOWLEDGEBASE:
+ return knowledgebase()
diff --git a/src/merge/resources/email/types/category_enum.py b/src/merge/resources/email/types/category_enum.py
new file mode 100644
index 00000000..4ee2f4e4
--- /dev/null
+++ b/src/merge/resources/email/types/category_enum.py
@@ -0,0 +1,45 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class CategoryEnum(str, enum.Enum):
+ HRIS = "hris"
+ ATS = "ats"
+ ACCOUNTING = "accounting"
+ TICKETING = "ticketing"
+ CRM = "crm"
+ MKTG = "mktg"
+ FILESTORAGE = "filestorage"
+ KNOWLEDGEBASE = "knowledgebase"
+
+ def visit(
+ self,
+ hris: typing.Callable[[], T_Result],
+ ats: typing.Callable[[], T_Result],
+ accounting: typing.Callable[[], T_Result],
+ ticketing: typing.Callable[[], T_Result],
+ crm: typing.Callable[[], T_Result],
+ mktg: typing.Callable[[], T_Result],
+ filestorage: typing.Callable[[], T_Result],
+ knowledgebase: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is CategoryEnum.HRIS:
+ return hris()
+ if self is CategoryEnum.ATS:
+ return ats()
+ if self is CategoryEnum.ACCOUNTING:
+ return accounting()
+ if self is CategoryEnum.TICKETING:
+ return ticketing()
+ if self is CategoryEnum.CRM:
+ return crm()
+ if self is CategoryEnum.MKTG:
+ return mktg()
+ if self is CategoryEnum.FILESTORAGE:
+ return filestorage()
+ if self is CategoryEnum.KNOWLEDGEBASE:
+ return knowledgebase()
diff --git a/src/merge/resources/email/types/common_model_scope_api.py b/src/merge/resources/email/types/common_model_scope_api.py
new file mode 100644
index 00000000..5484808d
--- /dev/null
+++ b/src/merge/resources/email/types/common_model_scope_api.py
@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .individual_common_model_scope_deserializer import IndividualCommonModelScopeDeserializer
+
+
+class CommonModelScopeApi(UncheckedBaseModel):
+ common_models: typing.List[IndividualCommonModelScopeDeserializer] = pydantic.Field()
+ """
+ The common models you want to update the scopes for
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/common_model_scopes_body_request.py b/src/merge/resources/email/types/common_model_scopes_body_request.py
new file mode 100644
index 00000000..a9fed25b
--- /dev/null
+++ b/src/merge/resources/email/types/common_model_scopes_body_request.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .enabled_actions_enum import EnabledActionsEnum
+
+
+class CommonModelScopesBodyRequest(UncheckedBaseModel):
+ model_id: str
+ enabled_actions: typing.List[EnabledActionsEnum]
+ disabled_fields: typing.List[str]
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/completed_account_initial_screen_enum.py b/src/merge/resources/email/types/completed_account_initial_screen_enum.py
new file mode 100644
index 00000000..c112dfd1
--- /dev/null
+++ b/src/merge/resources/email/types/completed_account_initial_screen_enum.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CompletedAccountInitialScreenEnum = typing.Literal["SELECTIVE_SYNC"]
diff --git a/src/merge/resources/email/types/data_passthrough_request.py b/src/merge/resources/email/types/data_passthrough_request.py
new file mode 100644
index 00000000..5a60bfb6
--- /dev/null
+++ b/src/merge/resources/email/types/data_passthrough_request.py
@@ -0,0 +1,62 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .data_passthrough_request_method import DataPassthroughRequestMethod
+from .data_passthrough_request_request_format import DataPassthroughRequestRequestFormat
+from .multipart_form_field_request import MultipartFormFieldRequest
+
+
+class DataPassthroughRequest(UncheckedBaseModel):
+ """
+ # The DataPassthrough Object
+ ### Description
+ The `DataPassthrough` object is used to send information to an otherwise-unsupported third-party endpoint.
+
+ ### Usage Example
+ Create a `DataPassthrough` to get team hierarchies from your Rippling integration.
+ """
+
+ method: DataPassthroughRequestMethod
+ path: str = pydantic.Field()
+ """
+ The path of the request in the third party's platform.
+ """
+
+ base_url_override: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ An optional override of the third party's base url for the request.
+ """
+
+ data: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The data with the request. You must include a `request_format` parameter matching the data's format
+ """
+
+ multipart_form_data: typing.Optional[typing.List[MultipartFormFieldRequest]] = pydantic.Field(default=None)
+ """
+ Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`.
+ """
+
+ headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+ """
+ The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server.
+ """
+
+ request_format: typing.Optional[DataPassthroughRequestRequestFormat] = None
+ normalize_response: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Optional. If true, the response will always be an object of the form `{"type": T, "value": ...}` where `T` will be one of `string, boolean, number, null, array, object`.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/data_passthrough_request_method.py b/src/merge/resources/email/types/data_passthrough_request_method.py
new file mode 100644
index 00000000..58874cbf
--- /dev/null
+++ b/src/merge/resources/email/types/data_passthrough_request_method.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .method_enum import MethodEnum
+
+DataPassthroughRequestMethod = typing.Union[MethodEnum, str]
diff --git a/src/merge/resources/email/types/data_passthrough_request_request_format.py b/src/merge/resources/email/types/data_passthrough_request_request_format.py
new file mode 100644
index 00000000..13dc95f0
--- /dev/null
+++ b/src/merge/resources/email/types/data_passthrough_request_request_format.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .request_format_enum import RequestFormatEnum
+
+DataPassthroughRequestRequestFormat = typing.Union[RequestFormatEnum, str]
diff --git a/src/merge/resources/email/types/debug_mode_log.py b/src/merge/resources/email/types/debug_mode_log.py
new file mode 100644
index 00000000..9c7d2a3f
--- /dev/null
+++ b/src/merge/resources/email/types/debug_mode_log.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .debug_model_log_summary import DebugModelLogSummary
+
+
+class DebugModeLog(UncheckedBaseModel):
+ log_id: str
+ dashboard_view: str
+ log_summary: DebugModelLogSummary
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/debug_model_log_summary.py b/src/merge/resources/email/types/debug_model_log_summary.py
new file mode 100644
index 00000000..d7e1d3e6
--- /dev/null
+++ b/src/merge/resources/email/types/debug_model_log_summary.py
@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class DebugModelLogSummary(UncheckedBaseModel):
+ url: str
+ method: str
+ status_code: int
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/effect_enum.py b/src/merge/resources/email/types/effect_enum.py
new file mode 100644
index 00000000..781c7ad5
--- /dev/null
+++ b/src/merge/resources/email/types/effect_enum.py
@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class EffectEnum(str, enum.Enum):
+ ALLOWED = "ALLOWED"
+ DENIED = "DENIED"
+ INHERITED = "INHERITED"
+
+ def visit(
+ self,
+ allowed: typing.Callable[[], T_Result],
+ denied: typing.Callable[[], T_Result],
+ inherited: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is EffectEnum.ALLOWED:
+ return allowed()
+ if self is EffectEnum.DENIED:
+ return denied()
+ if self is EffectEnum.INHERITED:
+ return inherited()
diff --git a/src/merge/resources/email/types/email_address.py b/src/merge/resources/email/types/email_address.py
new file mode 100644
index 00000000..12ea8e3a
--- /dev/null
+++ b/src/merge/resources/email/types/email_address.py
@@ -0,0 +1,71 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .email_address_field_mappings import EmailAddressFieldMappings
+from .remote_data import RemoteData
+
+
+class EmailAddress(UncheckedBaseModel):
+ """
+ # The EmailAddress Object
+ ### Description
+ The `EmailAddress` object is used to represent an email address.
+ ### Usage Example
+ Fetch from the `GET /api/email/v1/email-addresses` endpoint and view their email addresses.
+ """
+
+ id: typing.Optional[str] = None
+ remote_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The third-party API ID of the matching object.
+ """
+
+ created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was created by Merge.
+ """
+
+ modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was modified by Merge.
+ """
+
+ email_address: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The location where emails are sent/received.
+ """
+
+ mailboxes: typing.Optional[typing.List[typing.Optional[str]]] = None
+ users: typing.Optional[typing.List[typing.Optional[str]]] = None
+ groups: typing.Optional[typing.List[typing.Optional[str]]] = None
+ remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the third party's email address was created.
+ """
+
+ remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the third party's email address was updated.
+ """
+
+ remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+ """
+
+ field_mappings: typing.Optional[EmailAddressFieldMappings] = None
+ remote_data: typing.Optional[typing.List[RemoteData]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/email_address_field_mappings.py b/src/merge/resources/email/types/email_address_field_mappings.py
new file mode 100644
index 00000000..29175058
--- /dev/null
+++ b/src/merge/resources/email/types/email_address_field_mappings.py
@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class EmailAddressFieldMappings(UncheckedBaseModel):
+ organization_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ linked_account_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/enabled_actions_enum.py b/src/merge/resources/email/types/enabled_actions_enum.py
new file mode 100644
index 00000000..cb19286a
--- /dev/null
+++ b/src/merge/resources/email/types/enabled_actions_enum.py
@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class EnabledActionsEnum(str, enum.Enum):
+ READ = "READ"
+ WRITE = "WRITE"
+
+ def visit(self, read: typing.Callable[[], T_Result], write: typing.Callable[[], T_Result]) -> T_Result:
+ if self is EnabledActionsEnum.READ:
+ return read()
+ if self is EnabledActionsEnum.WRITE:
+ return write()
diff --git a/src/merge/resources/email/types/encoding_enum.py b/src/merge/resources/email/types/encoding_enum.py
new file mode 100644
index 00000000..7d4b8977
--- /dev/null
+++ b/src/merge/resources/email/types/encoding_enum.py
@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class EncodingEnum(str, enum.Enum):
+ RAW = "RAW"
+ BASE_64 = "BASE64"
+ GZIP_BASE_64 = "GZIP_BASE64"
+
+ def visit(
+ self,
+ raw: typing.Callable[[], T_Result],
+ base_64: typing.Callable[[], T_Result],
+ gzip_base_64: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is EncodingEnum.RAW:
+ return raw()
+ if self is EncodingEnum.BASE_64:
+ return base_64()
+ if self is EncodingEnum.GZIP_BASE_64:
+ return gzip_base_64()
diff --git a/src/merge/resources/email/types/error_validation_problem.py b/src/merge/resources/email/types/error_validation_problem.py
new file mode 100644
index 00000000..eca8e811
--- /dev/null
+++ b/src/merge/resources/email/types/error_validation_problem.py
@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .validation_problem_source import ValidationProblemSource
+
+
+class ErrorValidationProblem(UncheckedBaseModel):
+ source: typing.Optional[ValidationProblemSource] = None
+ title: str
+ detail: str
+ problem_type: str
+ block_merge_link: typing.Optional[bool] = None
+ raw_error: typing.Optional[str] = None
+ error_code: typing.Optional[int] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/event_type_enum.py b/src/merge/resources/email/types/event_type_enum.py
new file mode 100644
index 00000000..a04b9681
--- /dev/null
+++ b/src/merge/resources/email/types/event_type_enum.py
@@ -0,0 +1,185 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class EventTypeEnum(str, enum.Enum):
+ CREATED_REMOTE_PRODUCTION_API_KEY = "CREATED_REMOTE_PRODUCTION_API_KEY"
+ DELETED_REMOTE_PRODUCTION_API_KEY = "DELETED_REMOTE_PRODUCTION_API_KEY"
+ CREATED_TEST_API_KEY = "CREATED_TEST_API_KEY"
+ DELETED_TEST_API_KEY = "DELETED_TEST_API_KEY"
+ REGENERATED_PRODUCTION_API_KEY = "REGENERATED_PRODUCTION_API_KEY"
+ REGENERATED_WEBHOOK_SIGNATURE = "REGENERATED_WEBHOOK_SIGNATURE"
+ INVITED_USER = "INVITED_USER"
+ TWO_FACTOR_AUTH_ENABLED = "TWO_FACTOR_AUTH_ENABLED"
+ TWO_FACTOR_AUTH_DISABLED = "TWO_FACTOR_AUTH_DISABLED"
+ DELETED_LINKED_ACCOUNT = "DELETED_LINKED_ACCOUNT"
+ DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT = "DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT"
+ CREATED_DESTINATION = "CREATED_DESTINATION"
+ DELETED_DESTINATION = "DELETED_DESTINATION"
+ CHANGED_DESTINATION = "CHANGED_DESTINATION"
+ CHANGED_SCOPES = "CHANGED_SCOPES"
+ CHANGED_PERSONAL_INFORMATION = "CHANGED_PERSONAL_INFORMATION"
+ CHANGED_ORGANIZATION_SETTINGS = "CHANGED_ORGANIZATION_SETTINGS"
+ ENABLED_INTEGRATION = "ENABLED_INTEGRATION"
+ DISABLED_INTEGRATION = "DISABLED_INTEGRATION"
+ ENABLED_CATEGORY = "ENABLED_CATEGORY"
+ DISABLED_CATEGORY = "DISABLED_CATEGORY"
+ CHANGED_PASSWORD = "CHANGED_PASSWORD"
+ RESET_PASSWORD = "RESET_PASSWORD"
+ ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION = "ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION"
+ ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT = "ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT"
+ DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION = "DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION"
+ DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT = "DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT"
+ CREATED_INTEGRATION_WIDE_FIELD_MAPPING = "CREATED_INTEGRATION_WIDE_FIELD_MAPPING"
+ CREATED_LINKED_ACCOUNT_FIELD_MAPPING = "CREATED_LINKED_ACCOUNT_FIELD_MAPPING"
+ CHANGED_INTEGRATION_WIDE_FIELD_MAPPING = "CHANGED_INTEGRATION_WIDE_FIELD_MAPPING"
+ CHANGED_LINKED_ACCOUNT_FIELD_MAPPING = "CHANGED_LINKED_ACCOUNT_FIELD_MAPPING"
+ DELETED_INTEGRATION_WIDE_FIELD_MAPPING = "DELETED_INTEGRATION_WIDE_FIELD_MAPPING"
+ DELETED_LINKED_ACCOUNT_FIELD_MAPPING = "DELETED_LINKED_ACCOUNT_FIELD_MAPPING"
+ CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE = "CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE"
+ CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE = "CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE"
+ DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE = "DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE"
+ FORCED_LINKED_ACCOUNT_RESYNC = "FORCED_LINKED_ACCOUNT_RESYNC"
+ MUTED_ISSUE = "MUTED_ISSUE"
+ GENERATED_MAGIC_LINK = "GENERATED_MAGIC_LINK"
+ ENABLED_MERGE_WEBHOOK = "ENABLED_MERGE_WEBHOOK"
+ DISABLED_MERGE_WEBHOOK = "DISABLED_MERGE_WEBHOOK"
+ MERGE_WEBHOOK_TARGET_CHANGED = "MERGE_WEBHOOK_TARGET_CHANGED"
+ END_USER_CREDENTIALS_ACCESSED = "END_USER_CREDENTIALS_ACCESSED"
+
+ def visit(
+ self,
+ created_remote_production_api_key: typing.Callable[[], T_Result],
+ deleted_remote_production_api_key: typing.Callable[[], T_Result],
+ created_test_api_key: typing.Callable[[], T_Result],
+ deleted_test_api_key: typing.Callable[[], T_Result],
+ regenerated_production_api_key: typing.Callable[[], T_Result],
+ regenerated_webhook_signature: typing.Callable[[], T_Result],
+ invited_user: typing.Callable[[], T_Result],
+ two_factor_auth_enabled: typing.Callable[[], T_Result],
+ two_factor_auth_disabled: typing.Callable[[], T_Result],
+ deleted_linked_account: typing.Callable[[], T_Result],
+ deleted_all_common_models_for_linked_account: typing.Callable[[], T_Result],
+ created_destination: typing.Callable[[], T_Result],
+ deleted_destination: typing.Callable[[], T_Result],
+ changed_destination: typing.Callable[[], T_Result],
+ changed_scopes: typing.Callable[[], T_Result],
+ changed_personal_information: typing.Callable[[], T_Result],
+ changed_organization_settings: typing.Callable[[], T_Result],
+ enabled_integration: typing.Callable[[], T_Result],
+ disabled_integration: typing.Callable[[], T_Result],
+ enabled_category: typing.Callable[[], T_Result],
+ disabled_category: typing.Callable[[], T_Result],
+ changed_password: typing.Callable[[], T_Result],
+ reset_password: typing.Callable[[], T_Result],
+ enabled_redact_unmapped_data_for_organization: typing.Callable[[], T_Result],
+ enabled_redact_unmapped_data_for_linked_account: typing.Callable[[], T_Result],
+ disabled_redact_unmapped_data_for_organization: typing.Callable[[], T_Result],
+ disabled_redact_unmapped_data_for_linked_account: typing.Callable[[], T_Result],
+ created_integration_wide_field_mapping: typing.Callable[[], T_Result],
+ created_linked_account_field_mapping: typing.Callable[[], T_Result],
+ changed_integration_wide_field_mapping: typing.Callable[[], T_Result],
+ changed_linked_account_field_mapping: typing.Callable[[], T_Result],
+ deleted_integration_wide_field_mapping: typing.Callable[[], T_Result],
+ deleted_linked_account_field_mapping: typing.Callable[[], T_Result],
+ created_linked_account_common_model_override: typing.Callable[[], T_Result],
+ changed_linked_account_common_model_override: typing.Callable[[], T_Result],
+ deleted_linked_account_common_model_override: typing.Callable[[], T_Result],
+ forced_linked_account_resync: typing.Callable[[], T_Result],
+ muted_issue: typing.Callable[[], T_Result],
+ generated_magic_link: typing.Callable[[], T_Result],
+ enabled_merge_webhook: typing.Callable[[], T_Result],
+ disabled_merge_webhook: typing.Callable[[], T_Result],
+ merge_webhook_target_changed: typing.Callable[[], T_Result],
+ end_user_credentials_accessed: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is EventTypeEnum.CREATED_REMOTE_PRODUCTION_API_KEY:
+ return created_remote_production_api_key()
+ if self is EventTypeEnum.DELETED_REMOTE_PRODUCTION_API_KEY:
+ return deleted_remote_production_api_key()
+ if self is EventTypeEnum.CREATED_TEST_API_KEY:
+ return created_test_api_key()
+ if self is EventTypeEnum.DELETED_TEST_API_KEY:
+ return deleted_test_api_key()
+ if self is EventTypeEnum.REGENERATED_PRODUCTION_API_KEY:
+ return regenerated_production_api_key()
+ if self is EventTypeEnum.REGENERATED_WEBHOOK_SIGNATURE:
+ return regenerated_webhook_signature()
+ if self is EventTypeEnum.INVITED_USER:
+ return invited_user()
+ if self is EventTypeEnum.TWO_FACTOR_AUTH_ENABLED:
+ return two_factor_auth_enabled()
+ if self is EventTypeEnum.TWO_FACTOR_AUTH_DISABLED:
+ return two_factor_auth_disabled()
+ if self is EventTypeEnum.DELETED_LINKED_ACCOUNT:
+ return deleted_linked_account()
+ if self is EventTypeEnum.DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT:
+ return deleted_all_common_models_for_linked_account()
+ if self is EventTypeEnum.CREATED_DESTINATION:
+ return created_destination()
+ if self is EventTypeEnum.DELETED_DESTINATION:
+ return deleted_destination()
+ if self is EventTypeEnum.CHANGED_DESTINATION:
+ return changed_destination()
+ if self is EventTypeEnum.CHANGED_SCOPES:
+ return changed_scopes()
+ if self is EventTypeEnum.CHANGED_PERSONAL_INFORMATION:
+ return changed_personal_information()
+ if self is EventTypeEnum.CHANGED_ORGANIZATION_SETTINGS:
+ return changed_organization_settings()
+ if self is EventTypeEnum.ENABLED_INTEGRATION:
+ return enabled_integration()
+ if self is EventTypeEnum.DISABLED_INTEGRATION:
+ return disabled_integration()
+ if self is EventTypeEnum.ENABLED_CATEGORY:
+ return enabled_category()
+ if self is EventTypeEnum.DISABLED_CATEGORY:
+ return disabled_category()
+ if self is EventTypeEnum.CHANGED_PASSWORD:
+ return changed_password()
+ if self is EventTypeEnum.RESET_PASSWORD:
+ return reset_password()
+ if self is EventTypeEnum.ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION:
+ return enabled_redact_unmapped_data_for_organization()
+ if self is EventTypeEnum.ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT:
+ return enabled_redact_unmapped_data_for_linked_account()
+ if self is EventTypeEnum.DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION:
+ return disabled_redact_unmapped_data_for_organization()
+ if self is EventTypeEnum.DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT:
+ return disabled_redact_unmapped_data_for_linked_account()
+ if self is EventTypeEnum.CREATED_INTEGRATION_WIDE_FIELD_MAPPING:
+ return created_integration_wide_field_mapping()
+ if self is EventTypeEnum.CREATED_LINKED_ACCOUNT_FIELD_MAPPING:
+ return created_linked_account_field_mapping()
+ if self is EventTypeEnum.CHANGED_INTEGRATION_WIDE_FIELD_MAPPING:
+ return changed_integration_wide_field_mapping()
+ if self is EventTypeEnum.CHANGED_LINKED_ACCOUNT_FIELD_MAPPING:
+ return changed_linked_account_field_mapping()
+ if self is EventTypeEnum.DELETED_INTEGRATION_WIDE_FIELD_MAPPING:
+ return deleted_integration_wide_field_mapping()
+ if self is EventTypeEnum.DELETED_LINKED_ACCOUNT_FIELD_MAPPING:
+ return deleted_linked_account_field_mapping()
+ if self is EventTypeEnum.CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE:
+ return created_linked_account_common_model_override()
+ if self is EventTypeEnum.CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE:
+ return changed_linked_account_common_model_override()
+ if self is EventTypeEnum.DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE:
+ return deleted_linked_account_common_model_override()
+ if self is EventTypeEnum.FORCED_LINKED_ACCOUNT_RESYNC:
+ return forced_linked_account_resync()
+ if self is EventTypeEnum.MUTED_ISSUE:
+ return muted_issue()
+ if self is EventTypeEnum.GENERATED_MAGIC_LINK:
+ return generated_magic_link()
+ if self is EventTypeEnum.ENABLED_MERGE_WEBHOOK:
+ return enabled_merge_webhook()
+ if self is EventTypeEnum.DISABLED_MERGE_WEBHOOK:
+ return disabled_merge_webhook()
+ if self is EventTypeEnum.MERGE_WEBHOOK_TARGET_CHANGED:
+ return merge_webhook_target_changed()
+ if self is EventTypeEnum.END_USER_CREDENTIALS_ACCESSED:
+ return end_user_credentials_accessed()
diff --git a/src/merge/resources/email/types/external_target_field_api.py b/src/merge/resources/email/types/external_target_field_api.py
new file mode 100644
index 00000000..c0fea1eb
--- /dev/null
+++ b/src/merge/resources/email/types/external_target_field_api.py
@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class ExternalTargetFieldApi(UncheckedBaseModel):
+ name: typing.Optional[str] = None
+ description: typing.Optional[str] = None
+ is_mapped: typing.Optional[str] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/external_target_field_api_response.py b/src/merge/resources/email/types/external_target_field_api_response.py
new file mode 100644
index 00000000..280fa60a
--- /dev/null
+++ b/src/merge/resources/email/types/external_target_field_api_response.py
@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .external_target_field_api import ExternalTargetFieldApi
+
+
+class ExternalTargetFieldApiResponse(UncheckedBaseModel):
+ user: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="User", default=None)
+ group: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Group", default=None)
+ mailbox: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Mailbox", default=None)
+ folder: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Folder", default=None)
+ email_address: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(
+ alias="EmailAddress", default=None
+ )
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/field_mapping_api_instance.py b/src/merge/resources/email/types/field_mapping_api_instance.py
new file mode 100644
index 00000000..5bac0110
--- /dev/null
+++ b/src/merge/resources/email/types/field_mapping_api_instance.py
@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .field_mapping_api_instance_remote_field import FieldMappingApiInstanceRemoteField
+from .field_mapping_api_instance_target_field import FieldMappingApiInstanceTargetField
+
+
+class FieldMappingApiInstance(UncheckedBaseModel):
+ id: typing.Optional[str] = None
+ is_integration_wide: typing.Optional[bool] = None
+ target_field: typing.Optional[FieldMappingApiInstanceTargetField] = None
+ remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] = None
+ jmes_path: typing.Optional[str] = None
+ advanced_mapping_expression: typing.Optional[str] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/field_mapping_api_instance_remote_field.py b/src/merge/resources/email/types/field_mapping_api_instance_remote_field.py
new file mode 100644
index 00000000..578a2b10
--- /dev/null
+++ b/src/merge/resources/email/types/field_mapping_api_instance_remote_field.py
@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .field_mapping_api_instance_remote_field_remote_endpoint_info import (
+ FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo,
+)
+
+
+class FieldMappingApiInstanceRemoteField(UncheckedBaseModel):
+ remote_key_name: typing.Optional[str] = None
+ schema_: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(
+ alias="schema", default=None
+ )
+ remote_endpoint_info: FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py b/src/merge/resources/email/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py
new file mode 100644
index 00000000..4171f08b
--- /dev/null
+++ b/src/merge/resources/email/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py
@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo(UncheckedBaseModel):
+ method: typing.Optional[str] = None
+ url_path: typing.Optional[str] = None
+ field_traversal_path: typing.Optional[typing.List[str]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/field_mapping_api_instance_response.py b/src/merge/resources/email/types/field_mapping_api_instance_response.py
new file mode 100644
index 00000000..c3c882de
--- /dev/null
+++ b/src/merge/resources/email/types/field_mapping_api_instance_response.py
@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .field_mapping_api_instance import FieldMappingApiInstance
+
+
+class FieldMappingApiInstanceResponse(UncheckedBaseModel):
+ user: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="User", default=None)
+ group: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Group", default=None)
+ mailbox: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Mailbox", default=None)
+ folder: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Folder", default=None)
+ email_address: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(
+ alias="EmailAddress", default=None
+ )
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/field_mapping_api_instance_target_field.py b/src/merge/resources/email/types/field_mapping_api_instance_target_field.py
new file mode 100644
index 00000000..e6474cba
--- /dev/null
+++ b/src/merge/resources/email/types/field_mapping_api_instance_target_field.py
@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class FieldMappingApiInstanceTargetField(UncheckedBaseModel):
+ name: str
+ description: str
+ is_organization_wide: bool
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/field_mapping_instance_response.py b/src/merge/resources/email/types/field_mapping_instance_response.py
new file mode 100644
index 00000000..f921e641
--- /dev/null
+++ b/src/merge/resources/email/types/field_mapping_instance_response.py
@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .debug_mode_log import DebugModeLog
+from .error_validation_problem import ErrorValidationProblem
+from .field_mapping_api_instance import FieldMappingApiInstance
+from .warning_validation_problem import WarningValidationProblem
+
+
+class FieldMappingInstanceResponse(UncheckedBaseModel):
+ model: FieldMappingApiInstance
+ warnings: typing.List[WarningValidationProblem]
+ errors: typing.List[ErrorValidationProblem]
+ logs: typing.Optional[typing.List[DebugModeLog]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/field_permission_deserializer.py b/src/merge/resources/email/types/field_permission_deserializer.py
new file mode 100644
index 00000000..1d71ae04
--- /dev/null
+++ b/src/merge/resources/email/types/field_permission_deserializer.py
@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class FieldPermissionDeserializer(UncheckedBaseModel):
+ enabled_fields: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None
+ disabled_fields: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/field_permission_deserializer_request.py b/src/merge/resources/email/types/field_permission_deserializer_request.py
new file mode 100644
index 00000000..a4113b46
--- /dev/null
+++ b/src/merge/resources/email/types/field_permission_deserializer_request.py
@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class FieldPermissionDeserializerRequest(UncheckedBaseModel):
+ enabled_fields: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None
+ disabled_fields: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/folder.py b/src/merge/resources/email/types/folder.py
new file mode 100644
index 00000000..af697568
--- /dev/null
+++ b/src/merge/resources/email/types/folder.py
@@ -0,0 +1,76 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .folder_field_mappings import FolderFieldMappings
+from .permission import Permission
+from .remote_data import RemoteData
+
+
+class Folder(UncheckedBaseModel):
+ """
+ # The Folder Object
+ ### Description
+ The `Folder` object is used to represent an email folder.
+ ### Usage Example
+ Fetch from the `GET /api/email/v1/folders` endpoint and view their folders.
+ """
+
+ id: typing.Optional[str] = None
+ remote_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The third-party API ID of the matching object.
+ """
+
+ created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was created by Merge.
+ """
+
+ modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was modified by Merge.
+ """
+
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The name of the folder.
+ """
+
+ parent_folder: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The folder that the folder belongs to.
+ """
+
+ permissions: typing.Optional[typing.List[Permission]] = None
+ mailboxes: typing.Optional[typing.List[typing.Optional[str]]] = None
+ remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the third party's folder was created.
+ """
+
+ remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the third party's folder was updated.
+ """
+
+ remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+ """
+
+ field_mappings: typing.Optional[FolderFieldMappings] = None
+ remote_data: typing.Optional[typing.List[RemoteData]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/folder_field_mappings.py b/src/merge/resources/email/types/folder_field_mappings.py
new file mode 100644
index 00000000..b55828f8
--- /dev/null
+++ b/src/merge/resources/email/types/folder_field_mappings.py
@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class FolderFieldMappings(UncheckedBaseModel):
+ organization_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ linked_account_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/group.py b/src/merge/resources/email/types/group.py
new file mode 100644
index 00000000..9731c129
--- /dev/null
+++ b/src/merge/resources/email/types/group.py
@@ -0,0 +1,71 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .group_field_mappings import GroupFieldMappings
+from .remote_data import RemoteData
+
+
+class Group(UncheckedBaseModel):
+ """
+ # The Group Object
+ ### Description
+ The `Group` object is used to represent an email group.
+ ### Usage Example
+ Fetch from the `GET /api/email/v1/groups` endpoint and view their groups.
+ """
+
+ id: typing.Optional[str] = None
+ remote_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The third-party API ID of the matching object.
+ """
+
+ created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was created by Merge.
+ """
+
+ modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was modified by Merge.
+ """
+
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The name of the group.
+ """
+
+ users: typing.Optional[typing.List[typing.Optional[str]]] = None
+ email_addresses: typing.Optional[typing.List[typing.Optional[str]]] = None
+ mailboxes: typing.Optional[typing.List[typing.Optional[str]]] = None
+ remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the third party's group was created.
+ """
+
+ remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the third party's group was updated.
+ """
+
+ remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+ """
+
+ field_mappings: typing.Optional[GroupFieldMappings] = None
+ remote_data: typing.Optional[typing.List[RemoteData]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/group_field_mappings.py b/src/merge/resources/email/types/group_field_mappings.py
new file mode 100644
index 00000000..3be990d2
--- /dev/null
+++ b/src/merge/resources/email/types/group_field_mappings.py
@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class GroupFieldMappings(UncheckedBaseModel):
+ organization_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ linked_account_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/individual_common_model_scope_deserializer.py b/src/merge/resources/email/types/individual_common_model_scope_deserializer.py
new file mode 100644
index 00000000..4b1ef6a4
--- /dev/null
+++ b/src/merge/resources/email/types/individual_common_model_scope_deserializer.py
@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .field_permission_deserializer import FieldPermissionDeserializer
+from .model_permission_deserializer import ModelPermissionDeserializer
+
+
+class IndividualCommonModelScopeDeserializer(UncheckedBaseModel):
+ model_name: str
+ model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializer]] = None
+ field_permissions: typing.Optional[FieldPermissionDeserializer] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/individual_common_model_scope_deserializer_request.py b/src/merge/resources/email/types/individual_common_model_scope_deserializer_request.py
new file mode 100644
index 00000000..1dcda203
--- /dev/null
+++ b/src/merge/resources/email/types/individual_common_model_scope_deserializer_request.py
@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .field_permission_deserializer_request import FieldPermissionDeserializerRequest
+from .model_permission_deserializer_request import ModelPermissionDeserializerRequest
+
+
+class IndividualCommonModelScopeDeserializerRequest(UncheckedBaseModel):
+ model_name: str
+ model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializerRequest]] = None
+ field_permissions: typing.Optional[FieldPermissionDeserializerRequest] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/issue.py b/src/merge/resources/email/types/issue.py
new file mode 100644
index 00000000..8f1027ca
--- /dev/null
+++ b/src/merge/resources/email/types/issue.py
@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .issue_status import IssueStatus
+
+
+class Issue(UncheckedBaseModel):
+ id: typing.Optional[str] = None
+ status: typing.Optional[IssueStatus] = pydantic.Field(default=None)
+ """
+ Status of the issue.
+ """
+
+ error_description: str
+ end_user: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ first_incident_time: typing.Optional[dt.datetime] = None
+ last_incident_time: typing.Optional[dt.datetime] = None
+ is_muted: typing.Optional[bool] = None
+ error_details: typing.Optional[typing.List[str]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/issue_status.py b/src/merge/resources/email/types/issue_status.py
new file mode 100644
index 00000000..8e4d6516
--- /dev/null
+++ b/src/merge/resources/email/types/issue_status.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .issue_status_enum import IssueStatusEnum
+
+IssueStatus = typing.Union[IssueStatusEnum, str]
diff --git a/src/merge/resources/email/types/issue_status_enum.py b/src/merge/resources/email/types/issue_status_enum.py
new file mode 100644
index 00000000..d75e26e2
--- /dev/null
+++ b/src/merge/resources/email/types/issue_status_enum.py
@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class IssueStatusEnum(str, enum.Enum):
+ ONGOING = "ONGOING"
+ RESOLVED = "RESOLVED"
+
+ def visit(self, ongoing: typing.Callable[[], T_Result], resolved: typing.Callable[[], T_Result]) -> T_Result:
+ if self is IssueStatusEnum.ONGOING:
+ return ongoing()
+ if self is IssueStatusEnum.RESOLVED:
+ return resolved()
diff --git a/src/merge/resources/email/types/language_enum.py b/src/merge/resources/email/types/language_enum.py
new file mode 100644
index 00000000..19f87fe0
--- /dev/null
+++ b/src/merge/resources/email/types/language_enum.py
@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class LanguageEnum(str, enum.Enum):
+ EN = "en"
+ DE = "de"
+
+ def visit(self, en: typing.Callable[[], T_Result], de: typing.Callable[[], T_Result]) -> T_Result:
+ if self is LanguageEnum.EN:
+ return en()
+ if self is LanguageEnum.DE:
+ return de()
diff --git a/src/merge/resources/email/types/last_sync_result_enum.py b/src/merge/resources/email/types/last_sync_result_enum.py
new file mode 100644
index 00000000..52ecd845
--- /dev/null
+++ b/src/merge/resources/email/types/last_sync_result_enum.py
@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class LastSyncResultEnum(str, enum.Enum):
+ SYNCING = "SYNCING"
+ DONE = "DONE"
+ FAILED = "FAILED"
+ DISABLED = "DISABLED"
+ PAUSED = "PAUSED"
+ PARTIALLY_SYNCED = "PARTIALLY_SYNCED"
+
+ def visit(
+ self,
+ syncing: typing.Callable[[], T_Result],
+ done: typing.Callable[[], T_Result],
+ failed: typing.Callable[[], T_Result],
+ disabled: typing.Callable[[], T_Result],
+ paused: typing.Callable[[], T_Result],
+ partially_synced: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is LastSyncResultEnum.SYNCING:
+ return syncing()
+ if self is LastSyncResultEnum.DONE:
+ return done()
+ if self is LastSyncResultEnum.FAILED:
+ return failed()
+ if self is LastSyncResultEnum.DISABLED:
+ return disabled()
+ if self is LastSyncResultEnum.PAUSED:
+ return paused()
+ if self is LastSyncResultEnum.PARTIALLY_SYNCED:
+ return partially_synced()
diff --git a/src/merge/resources/email/types/link_token.py b/src/merge/resources/email/types/link_token.py
new file mode 100644
index 00000000..f78dedeb
--- /dev/null
+++ b/src/merge/resources/email/types/link_token.py
@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class LinkToken(UncheckedBaseModel):
+ link_token: str
+ integration_name: typing.Optional[str] = None
+ magic_link_url: typing.Optional[str] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/mailbox.py b/src/merge/resources/email/types/mailbox.py
new file mode 100644
index 00000000..4159c457
--- /dev/null
+++ b/src/merge/resources/email/types/mailbox.py
@@ -0,0 +1,90 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .mailbox_field_mappings import MailboxFieldMappings
+from .mailbox_type import MailboxType
+from .permission import Permission
+from .remote_data import RemoteData
+
+
+class Mailbox(UncheckedBaseModel):
+ """
+ # The Mailbox Object
+ ### Description
+ The `Mailbox` object is used to represent an email mailbox.
+ ### Usage Example
+ Fetch from the `GET /api/email/v1/mailboxes` endpoint and view their mailboxes.
+ """
+
+ id: typing.Optional[str] = None
+ remote_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The third-party API ID of the matching object.
+ """
+
+ created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was created by Merge.
+ """
+
+ modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was modified by Merge.
+ """
+
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The name of the mailbox.
+ """
+
+ type: typing.Optional[MailboxType] = pydantic.Field(default=None)
+ """
+ The mailbox's type.
+ """
+
+ type_native: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Remote field for type.
+ """
+
+ folders: typing.Optional[typing.List[typing.Optional[str]]] = None
+ groups: typing.Optional[typing.List[typing.Optional[str]]] = None
+ users: typing.Optional[typing.List[typing.Optional[str]]] = None
+ primary_email_address: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The primary email address associated with the mailbox.
+ """
+
+ alias_email_addresses: typing.Optional[typing.List[typing.Optional[str]]] = None
+ permissions: typing.Optional[typing.List[Permission]] = None
+ remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the third party's mailbox was created.
+ """
+
+ remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the third party's mailbox was updated.
+ """
+
+ remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+ """
+
+ field_mappings: typing.Optional[MailboxFieldMappings] = None
+ remote_data: typing.Optional[typing.List[RemoteData]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/mailbox_field_mappings.py b/src/merge/resources/email/types/mailbox_field_mappings.py
new file mode 100644
index 00000000..7ecc9cf7
--- /dev/null
+++ b/src/merge/resources/email/types/mailbox_field_mappings.py
@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class MailboxFieldMappings(UncheckedBaseModel):
+ organization_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ linked_account_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/mailbox_type.py b/src/merge/resources/email/types/mailbox_type.py
new file mode 100644
index 00000000..c86dcf61
--- /dev/null
+++ b/src/merge/resources/email/types/mailbox_type.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .mailbox_type_enum import MailboxTypeEnum
+
+MailboxType = typing.Union[MailboxTypeEnum, str]
diff --git a/src/merge/resources/email/types/mailbox_type_enum.py b/src/merge/resources/email/types/mailbox_type_enum.py
new file mode 100644
index 00000000..80c1883a
--- /dev/null
+++ b/src/merge/resources/email/types/mailbox_type_enum.py
@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class MailboxTypeEnum(str, enum.Enum):
+ USER = "USER"
+ SHARED = "SHARED"
+
+ def visit(self, user: typing.Callable[[], T_Result], shared: typing.Callable[[], T_Result]) -> T_Result:
+ if self is MailboxTypeEnum.USER:
+ return user()
+ if self is MailboxTypeEnum.SHARED:
+ return shared()
diff --git a/src/merge/resources/email/types/message.py b/src/merge/resources/email/types/message.py
new file mode 100644
index 00000000..7797c47c
--- /dev/null
+++ b/src/merge/resources/email/types/message.py
@@ -0,0 +1,99 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .permission import Permission
+
+
+class Message(UncheckedBaseModel):
+ """
+ # The Message Object
+ ### Description
+ The `Message` object is used to represent an email message.
+ ### Usage Example
+ Fetch from the `GET /api/email/v1/messages` endpoint and view their messages.
+ """
+
+ id: typing.Optional[str] = None
+ remote_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The third-party API ID of the matching object.
+ """
+
+ created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was created by Merge.
+ """
+
+ modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was modified by Merge.
+ """
+
+ subject: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The subject of the message.
+ """
+
+ body_text: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The body text of the message.
+ """
+
+ message_url: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The 3rd party url of the message.
+ """
+
+ sent_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the message was sent.
+ """
+
+ received_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the message was received.
+ """
+
+ is_draft: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Whether the message is a draft.
+ """
+
+ from_address: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The sender of the message.
+ """
+
+ thread: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The thread that the message belongs to.
+ """
+
+ to: typing.Optional[typing.List[typing.Optional[str]]] = None
+ cc: typing.Optional[typing.List[typing.Optional[str]]] = None
+ bcc: typing.Optional[typing.List[typing.Optional[str]]] = None
+ mailboxes: typing.Optional[typing.List[typing.Optional[str]]] = None
+ permissions: typing.Optional[typing.List[Permission]] = None
+ folder: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The folder that the message belongs to.
+ """
+
+ remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/method_enum.py b/src/merge/resources/email/types/method_enum.py
new file mode 100644
index 00000000..73d2556f
--- /dev/null
+++ b/src/merge/resources/email/types/method_enum.py
@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class MethodEnum(str, enum.Enum):
+ GET = "GET"
+ OPTIONS = "OPTIONS"
+ HEAD = "HEAD"
+ POST = "POST"
+ PUT = "PUT"
+ PATCH = "PATCH"
+ DELETE = "DELETE"
+
+ def visit(
+ self,
+ get: typing.Callable[[], T_Result],
+ options: typing.Callable[[], T_Result],
+ head: typing.Callable[[], T_Result],
+ post: typing.Callable[[], T_Result],
+ put: typing.Callable[[], T_Result],
+ patch: typing.Callable[[], T_Result],
+ delete: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is MethodEnum.GET:
+ return get()
+ if self is MethodEnum.OPTIONS:
+ return options()
+ if self is MethodEnum.HEAD:
+ return head()
+ if self is MethodEnum.POST:
+ return post()
+ if self is MethodEnum.PUT:
+ return put()
+ if self is MethodEnum.PATCH:
+ return patch()
+ if self is MethodEnum.DELETE:
+ return delete()
diff --git a/src/merge/resources/email/types/model_operation.py b/src/merge/resources/email/types/model_operation.py
new file mode 100644
index 00000000..c367572d
--- /dev/null
+++ b/src/merge/resources/email/types/model_operation.py
@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class ModelOperation(UncheckedBaseModel):
+ """
+ # The ModelOperation Object
+ ### Description
+ The `ModelOperation` object is used to represent the operations that are currently supported for a given model.
+
+ ### Usage Example
+ View what operations are supported for the `Candidate` endpoint.
+ """
+
+ model_name: str
+ available_operations: typing.List[str]
+ required_post_parameters: typing.List[str]
+ supported_fields: typing.List[str]
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/model_permission_deserializer.py b/src/merge/resources/email/types/model_permission_deserializer.py
new file mode 100644
index 00000000..6381814c
--- /dev/null
+++ b/src/merge/resources/email/types/model_permission_deserializer.py
@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class ModelPermissionDeserializer(UncheckedBaseModel):
+ is_enabled: typing.Optional[bool] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/model_permission_deserializer_request.py b/src/merge/resources/email/types/model_permission_deserializer_request.py
new file mode 100644
index 00000000..cdc2ff4c
--- /dev/null
+++ b/src/merge/resources/email/types/model_permission_deserializer_request.py
@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class ModelPermissionDeserializerRequest(UncheckedBaseModel):
+ is_enabled: typing.Optional[bool] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/multipart_form_field_request.py b/src/merge/resources/email/types/multipart_form_field_request.py
new file mode 100644
index 00000000..cb0039e1
--- /dev/null
+++ b/src/merge/resources/email/types/multipart_form_field_request.py
@@ -0,0 +1,53 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .multipart_form_field_request_encoding import MultipartFormFieldRequestEncoding
+
+
+class MultipartFormFieldRequest(UncheckedBaseModel):
+ """
+ # The MultipartFormField Object
+ ### Description
+ The `MultipartFormField` object is used to represent fields in an HTTP request using `multipart/form-data`.
+
+ ### Usage Example
+ Create a `MultipartFormField` to define a multipart form entry.
+ """
+
+ name: str = pydantic.Field()
+ """
+ The name of the form field
+ """
+
+ data: str = pydantic.Field()
+ """
+ The data for the form field.
+ """
+
+ encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field(default=None)
+ """
+ The encoding of the value of `data`. Defaults to `RAW` if not defined.
+ """
+
+ file_name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The file name of the form field, if the field is for a file.
+ """
+
+ content_type: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The MIME type of the file, if the field is for a file.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/multipart_form_field_request_encoding.py b/src/merge/resources/email/types/multipart_form_field_request_encoding.py
new file mode 100644
index 00000000..c6513b6b
--- /dev/null
+++ b/src/merge/resources/email/types/multipart_form_field_request_encoding.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .encoding_enum import EncodingEnum
+
+MultipartFormFieldRequestEncoding = typing.Union[EncodingEnum, str]
diff --git a/src/merge/resources/email/types/paginated_account_details_and_actions_list.py b/src/merge/resources/email/types/paginated_account_details_and_actions_list.py
new file mode 100644
index 00000000..d2d16116
--- /dev/null
+++ b/src/merge/resources/email/types/paginated_account_details_and_actions_list.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .account_details_and_actions import AccountDetailsAndActions
+
+
+class PaginatedAccountDetailsAndActionsList(UncheckedBaseModel):
+ next: typing.Optional[str] = None
+ previous: typing.Optional[str] = None
+ results: typing.Optional[typing.List[AccountDetailsAndActions]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/paginated_audit_log_event_list.py b/src/merge/resources/email/types/paginated_audit_log_event_list.py
new file mode 100644
index 00000000..24139397
--- /dev/null
+++ b/src/merge/resources/email/types/paginated_audit_log_event_list.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .audit_log_event import AuditLogEvent
+
+
+class PaginatedAuditLogEventList(UncheckedBaseModel):
+ next: typing.Optional[str] = None
+ previous: typing.Optional[str] = None
+ results: typing.Optional[typing.List[AuditLogEvent]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/paginated_email_address_list.py b/src/merge/resources/email/types/paginated_email_address_list.py
new file mode 100644
index 00000000..cb95820d
--- /dev/null
+++ b/src/merge/resources/email/types/paginated_email_address_list.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .email_address import EmailAddress
+
+
+class PaginatedEmailAddressList(UncheckedBaseModel):
+ next: typing.Optional[str] = None
+ previous: typing.Optional[str] = None
+ results: typing.Optional[typing.List[EmailAddress]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/paginated_folder_list.py b/src/merge/resources/email/types/paginated_folder_list.py
new file mode 100644
index 00000000..643d17ed
--- /dev/null
+++ b/src/merge/resources/email/types/paginated_folder_list.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .folder import Folder
+
+
+class PaginatedFolderList(UncheckedBaseModel):
+ next: typing.Optional[str] = None
+ previous: typing.Optional[str] = None
+ results: typing.Optional[typing.List[Folder]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/paginated_group_list.py b/src/merge/resources/email/types/paginated_group_list.py
new file mode 100644
index 00000000..90702e1f
--- /dev/null
+++ b/src/merge/resources/email/types/paginated_group_list.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .group import Group
+
+
+class PaginatedGroupList(UncheckedBaseModel):
+ next: typing.Optional[str] = None
+ previous: typing.Optional[str] = None
+ results: typing.Optional[typing.List[Group]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/paginated_issue_list.py b/src/merge/resources/email/types/paginated_issue_list.py
new file mode 100644
index 00000000..686173e5
--- /dev/null
+++ b/src/merge/resources/email/types/paginated_issue_list.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .issue import Issue
+
+
+class PaginatedIssueList(UncheckedBaseModel):
+ next: typing.Optional[str] = None
+ previous: typing.Optional[str] = None
+ results: typing.Optional[typing.List[Issue]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/paginated_mailbox_list.py b/src/merge/resources/email/types/paginated_mailbox_list.py
new file mode 100644
index 00000000..391c9334
--- /dev/null
+++ b/src/merge/resources/email/types/paginated_mailbox_list.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .mailbox import Mailbox
+
+
+class PaginatedMailboxList(UncheckedBaseModel):
+ next: typing.Optional[str] = None
+ previous: typing.Optional[str] = None
+ results: typing.Optional[typing.List[Mailbox]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/paginated_message_list.py b/src/merge/resources/email/types/paginated_message_list.py
new file mode 100644
index 00000000..6e8a7aee
--- /dev/null
+++ b/src/merge/resources/email/types/paginated_message_list.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .message import Message
+
+
+class PaginatedMessageList(UncheckedBaseModel):
+ next: typing.Optional[str] = None
+ previous: typing.Optional[str] = None
+ results: typing.Optional[typing.List[Message]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/paginated_sync_status_list.py b/src/merge/resources/email/types/paginated_sync_status_list.py
new file mode 100644
index 00000000..cc4bd7a8
--- /dev/null
+++ b/src/merge/resources/email/types/paginated_sync_status_list.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .sync_status import SyncStatus
+
+
+class PaginatedSyncStatusList(UncheckedBaseModel):
+ next: typing.Optional[str] = None
+ previous: typing.Optional[str] = None
+ results: typing.Optional[typing.List[SyncStatus]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/paginated_user_list.py b/src/merge/resources/email/types/paginated_user_list.py
new file mode 100644
index 00000000..809b285c
--- /dev/null
+++ b/src/merge/resources/email/types/paginated_user_list.py
@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .user import User
+
+
+class PaginatedUserList(UncheckedBaseModel):
+ next: typing.Optional[str] = None
+ previous: typing.Optional[str] = None
+ results: typing.Optional[typing.List[User]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/permission.py b/src/merge/resources/email/types/permission.py
new file mode 100644
index 00000000..2e51a422
--- /dev/null
+++ b/src/merge/resources/email/types/permission.py
@@ -0,0 +1,67 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .actions_enum import ActionsEnum
+from .permission_effect import PermissionEffect
+from .permission_field_mappings import PermissionFieldMappings
+
+
+class Permission(UncheckedBaseModel):
+ """
+ # The EmailPermission Object
+ ### Description
+ The `EmailPermission` object is used to represent a permission on an email resource.
+ ### Usage Example
+ Fetch from the `GET /api/email/v1/email-permissions` endpoint and view their email permissions.
+ """
+
+ id: typing.Optional[str] = None
+ remote_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The third-party API ID of the matching object.
+ """
+
+ created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was created by Merge.
+ """
+
+ modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was modified by Merge.
+ """
+
+ effect: typing.Optional[PermissionEffect] = pydantic.Field(default=None)
+ """
+ The permission's effect.
+ """
+
+ actions: typing.Optional[typing.List[typing.Optional[ActionsEnum]]] = pydantic.Field(default=None)
+ """
+ The actions that this permission applies to.
+ """
+
+ applied_to_users: typing.Optional[typing.List[typing.Optional[str]]] = None
+ applied_to_groups: typing.Optional[typing.List[typing.Optional[str]]] = None
+ applied_to_folders: typing.Optional[typing.List[typing.Optional[str]]] = None
+ applied_to_mailboxes: typing.Optional[typing.List[typing.Optional[str]]] = None
+ remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+ """
+
+ field_mappings: typing.Optional[PermissionFieldMappings] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/permission_effect.py b/src/merge/resources/email/types/permission_effect.py
new file mode 100644
index 00000000..88d536ee
--- /dev/null
+++ b/src/merge/resources/email/types/permission_effect.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .effect_enum import EffectEnum
+
+PermissionEffect = typing.Union[EffectEnum, str]
diff --git a/src/merge/resources/email/types/permission_field_mappings.py b/src/merge/resources/email/types/permission_field_mappings.py
new file mode 100644
index 00000000..9c2804c2
--- /dev/null
+++ b/src/merge/resources/email/types/permission_field_mappings.py
@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class PermissionFieldMappings(UncheckedBaseModel):
+ organization_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ linked_account_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/regenerate_account_token.py b/src/merge/resources/email/types/regenerate_account_token.py
new file mode 100644
index 00000000..5c31cf57
--- /dev/null
+++ b/src/merge/resources/email/types/regenerate_account_token.py
@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class RegenerateAccountToken(UncheckedBaseModel):
+ """
+ # The RegenerateAccountToken Object
+ ### Description
+ The `RegenerateAccountToken` object is used to exchange an old account token for a new one.
+
+ ### Usage Example
+ Post to receive a new `RegenerateAccountToken`.
+ """
+
+ linked_account_id: str
+ account_token: str
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/remote_data.py b/src/merge/resources/email/types/remote_data.py
new file mode 100644
index 00000000..f34bec80
--- /dev/null
+++ b/src/merge/resources/email/types/remote_data.py
@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class RemoteData(UncheckedBaseModel):
+ """
+ # The RemoteData Object
+ ### Description
+ The `RemoteData` object is used to represent the full data pulled from the third-party API for an object.
+
+ ### Usage Example
+ TODO
+ """
+
+ path: str = pydantic.Field()
+ """
+ The third-party API path that is being called.
+ """
+
+ data: typing.Optional[typing.Optional[typing.Any]] = pydantic.Field(default=None)
+ """
+ The data returned from the third-party for this object in its original, unnormalized format.
+ """
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/remote_endpoint_info.py b/src/merge/resources/email/types/remote_endpoint_info.py
new file mode 100644
index 00000000..07ceff6a
--- /dev/null
+++ b/src/merge/resources/email/types/remote_endpoint_info.py
@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class RemoteEndpointInfo(UncheckedBaseModel):
+ method: str
+ url_path: str
+ field_traversal_path: typing.List[typing.Optional[typing.Any]]
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/remote_field_api.py b/src/merge/resources/email/types/remote_field_api.py
new file mode 100644
index 00000000..0756bfc3
--- /dev/null
+++ b/src/merge/resources/email/types/remote_field_api.py
@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .remote_endpoint_info import RemoteEndpointInfo
+from .remote_field_api_advanced_metadata import RemoteFieldApiAdvancedMetadata
+from .remote_field_api_coverage import RemoteFieldApiCoverage
+
+
+class RemoteFieldApi(UncheckedBaseModel):
+ schema_: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field(alias="schema")
+ remote_key_name: str
+ remote_endpoint_info: RemoteEndpointInfo
+ example_values: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None
+ advanced_metadata: typing.Optional[RemoteFieldApiAdvancedMetadata] = None
+ coverage: typing.Optional[RemoteFieldApiCoverage] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/remote_field_api_advanced_metadata.py b/src/merge/resources/email/types/remote_field_api_advanced_metadata.py
new file mode 100644
index 00000000..e93da936
--- /dev/null
+++ b/src/merge/resources/email/types/remote_field_api_advanced_metadata.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .advanced_metadata import AdvancedMetadata
+
+RemoteFieldApiAdvancedMetadata = typing.Union[AdvancedMetadata, str]
diff --git a/src/merge/resources/email/types/remote_field_api_coverage.py b/src/merge/resources/email/types/remote_field_api_coverage.py
new file mode 100644
index 00000000..adcd9be9
--- /dev/null
+++ b/src/merge/resources/email/types/remote_field_api_coverage.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RemoteFieldApiCoverage = typing.Union[int, float]
diff --git a/src/merge/resources/email/types/remote_field_api_response.py b/src/merge/resources/email/types/remote_field_api_response.py
new file mode 100644
index 00000000..523e5892
--- /dev/null
+++ b/src/merge/resources/email/types/remote_field_api_response.py
@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .remote_field_api import RemoteFieldApi
+
+
+class RemoteFieldApiResponse(UncheckedBaseModel):
+ user: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="User", default=None)
+ group: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Group", default=None)
+ mailbox: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Mailbox", default=None)
+ folder: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Folder", default=None)
+ email_address: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="EmailAddress", default=None)
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/remote_key.py b/src/merge/resources/email/types/remote_key.py
new file mode 100644
index 00000000..c2482040
--- /dev/null
+++ b/src/merge/resources/email/types/remote_key.py
@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class RemoteKey(UncheckedBaseModel):
+ """
+ # The RemoteKey Object
+ ### Description
+ The `RemoteKey` object is used to represent a request for a new remote key.
+
+ ### Usage Example
+ Post a `GenerateRemoteKey` to receive a new `RemoteKey`.
+ """
+
+ name: str
+ key: str
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/remote_response.py b/src/merge/resources/email/types/remote_response.py
new file mode 100644
index 00000000..db01131f
--- /dev/null
+++ b/src/merge/resources/email/types/remote_response.py
@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .remote_response_response_type import RemoteResponseResponseType
+
+
+class RemoteResponse(UncheckedBaseModel):
+ """
+ # The RemoteResponse Object
+ ### Description
+ The `RemoteResponse` object is used to represent information returned from a third-party endpoint.
+
+ ### Usage Example
+ View the `RemoteResponse` returned from your `DataPassthrough`.
+ """
+
+ method: str
+ path: str
+ status: int
+ response: typing.Optional[typing.Any] = None
+ response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ response_type: typing.Optional[RemoteResponseResponseType] = None
+ headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/remote_response_response_type.py b/src/merge/resources/email/types/remote_response_response_type.py
new file mode 100644
index 00000000..2556417a
--- /dev/null
+++ b/src/merge/resources/email/types/remote_response_response_type.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .response_type_enum import ResponseTypeEnum
+
+RemoteResponseResponseType = typing.Union[ResponseTypeEnum, str]
diff --git a/src/merge/resources/email/types/request_format_enum.py b/src/merge/resources/email/types/request_format_enum.py
new file mode 100644
index 00000000..70ecd9bb
--- /dev/null
+++ b/src/merge/resources/email/types/request_format_enum.py
@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class RequestFormatEnum(str, enum.Enum):
+ JSON = "JSON"
+ XML = "XML"
+ MULTIPART = "MULTIPART"
+
+ def visit(
+ self,
+ json: typing.Callable[[], T_Result],
+ xml: typing.Callable[[], T_Result],
+ multipart: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is RequestFormatEnum.JSON:
+ return json()
+ if self is RequestFormatEnum.XML:
+ return xml()
+ if self is RequestFormatEnum.MULTIPART:
+ return multipart()
diff --git a/src/merge/resources/email/types/response_type_enum.py b/src/merge/resources/email/types/response_type_enum.py
new file mode 100644
index 00000000..23b6bb5b
--- /dev/null
+++ b/src/merge/resources/email/types/response_type_enum.py
@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class ResponseTypeEnum(str, enum.Enum):
+ JSON = "JSON"
+ BASE_64_GZIP = "BASE64_GZIP"
+
+ def visit(self, json: typing.Callable[[], T_Result], base_64_gzip: typing.Callable[[], T_Result]) -> T_Result:
+ if self is ResponseTypeEnum.JSON:
+ return json()
+ if self is ResponseTypeEnum.BASE_64_GZIP:
+ return base_64_gzip()
diff --git a/src/merge/resources/email/types/role_enum.py b/src/merge/resources/email/types/role_enum.py
new file mode 100644
index 00000000..c97de31f
--- /dev/null
+++ b/src/merge/resources/email/types/role_enum.py
@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class RoleEnum(str, enum.Enum):
+ ADMIN = "ADMIN"
+ DEVELOPER = "DEVELOPER"
+ MEMBER = "MEMBER"
+ API = "API"
+ SYSTEM = "SYSTEM"
+ MERGE_TEAM = "MERGE_TEAM"
+ SUPPORT = "SUPPORT"
+
+ def visit(
+ self,
+ admin: typing.Callable[[], T_Result],
+ developer: typing.Callable[[], T_Result],
+ member: typing.Callable[[], T_Result],
+ api: typing.Callable[[], T_Result],
+ system: typing.Callable[[], T_Result],
+ merge_team: typing.Callable[[], T_Result],
+ support: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is RoleEnum.ADMIN:
+ return admin()
+ if self is RoleEnum.DEVELOPER:
+ return developer()
+ if self is RoleEnum.MEMBER:
+ return member()
+ if self is RoleEnum.API:
+ return api()
+ if self is RoleEnum.SYSTEM:
+ return system()
+ if self is RoleEnum.MERGE_TEAM:
+ return merge_team()
+ if self is RoleEnum.SUPPORT:
+ return support()
diff --git a/src/merge/resources/email/types/selective_sync_configurations_usage_enum.py b/src/merge/resources/email/types/selective_sync_configurations_usage_enum.py
new file mode 100644
index 00000000..7b486b59
--- /dev/null
+++ b/src/merge/resources/email/types/selective_sync_configurations_usage_enum.py
@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class SelectiveSyncConfigurationsUsageEnum(str, enum.Enum):
+ IN_NEXT_SYNC = "IN_NEXT_SYNC"
+ IN_LAST_SYNC = "IN_LAST_SYNC"
+
+ def visit(
+ self, in_next_sync: typing.Callable[[], T_Result], in_last_sync: typing.Callable[[], T_Result]
+ ) -> T_Result:
+ if self is SelectiveSyncConfigurationsUsageEnum.IN_NEXT_SYNC:
+ return in_next_sync()
+ if self is SelectiveSyncConfigurationsUsageEnum.IN_LAST_SYNC:
+ return in_last_sync()
diff --git a/src/merge/resources/email/types/status_fd_5_enum.py b/src/merge/resources/email/types/status_fd_5_enum.py
new file mode 100644
index 00000000..3bf97afd
--- /dev/null
+++ b/src/merge/resources/email/types/status_fd_5_enum.py
@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class StatusFd5Enum(str, enum.Enum):
+ SYNCING = "SYNCING"
+ DONE = "DONE"
+ FAILED = "FAILED"
+ DISABLED = "DISABLED"
+ PAUSED = "PAUSED"
+ PARTIALLY_SYNCED = "PARTIALLY_SYNCED"
+
+ def visit(
+ self,
+ syncing: typing.Callable[[], T_Result],
+ done: typing.Callable[[], T_Result],
+ failed: typing.Callable[[], T_Result],
+ disabled: typing.Callable[[], T_Result],
+ paused: typing.Callable[[], T_Result],
+ partially_synced: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is StatusFd5Enum.SYNCING:
+ return syncing()
+ if self is StatusFd5Enum.DONE:
+ return done()
+ if self is StatusFd5Enum.FAILED:
+ return failed()
+ if self is StatusFd5Enum.DISABLED:
+ return disabled()
+ if self is StatusFd5Enum.PAUSED:
+ return paused()
+ if self is StatusFd5Enum.PARTIALLY_SYNCED:
+ return partially_synced()
diff --git a/src/merge/resources/email/types/sync_status.py b/src/merge/resources/email/types/sync_status.py
new file mode 100644
index 00000000..e8564068
--- /dev/null
+++ b/src/merge/resources/email/types/sync_status.py
@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .selective_sync_configurations_usage_enum import SelectiveSyncConfigurationsUsageEnum
+from .sync_status_last_sync_result import SyncStatusLastSyncResult
+from .sync_status_status import SyncStatusStatus
+
+
+class SyncStatus(UncheckedBaseModel):
+ """
+ # The SyncStatus Object
+ ### Description
+ The `SyncStatus` object is used to represent the syncing state of an account
+
+ ### Usage Example
+ View the `SyncStatus` for an account to see how recently its models were synced.
+ """
+
+ model_name: str
+ model_id: str
+ last_sync_start: typing.Optional[dt.datetime] = None
+ next_sync_start: typing.Optional[dt.datetime] = None
+ last_sync_result: typing.Optional[SyncStatusLastSyncResult] = None
+ last_sync_finished: typing.Optional[dt.datetime] = None
+ status: SyncStatusStatus
+ is_initial_sync: bool
+ selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/sync_status_last_sync_result.py b/src/merge/resources/email/types/sync_status_last_sync_result.py
new file mode 100644
index 00000000..980e7d94
--- /dev/null
+++ b/src/merge/resources/email/types/sync_status_last_sync_result.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .last_sync_result_enum import LastSyncResultEnum
+
+SyncStatusLastSyncResult = typing.Union[LastSyncResultEnum, str]
diff --git a/src/merge/resources/email/types/sync_status_status.py b/src/merge/resources/email/types/sync_status_status.py
new file mode 100644
index 00000000..78e4cc47
--- /dev/null
+++ b/src/merge/resources/email/types/sync_status_status.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .status_fd_5_enum import StatusFd5Enum
+
+SyncStatusStatus = typing.Union[StatusFd5Enum, str]
diff --git a/src/merge/resources/email/types/user.py b/src/merge/resources/email/types/user.py
new file mode 100644
index 00000000..a6c96cab
--- /dev/null
+++ b/src/merge/resources/email/types/user.py
@@ -0,0 +1,82 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .remote_data import RemoteData
+from .user_field_mappings import UserFieldMappings
+from .user_type import UserType
+
+
+class User(UncheckedBaseModel):
+ """
+ # The User Object
+ ### Description
+ The `User` object is used to represent an email user.
+ ### Usage Example
+ Fetch from the `GET /api/email/v1/users` endpoint and view their users.
+ """
+
+ id: typing.Optional[str] = None
+ remote_id: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The third-party API ID of the matching object.
+ """
+
+ created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was created by Merge.
+ """
+
+ modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ The datetime that this object was modified by Merge.
+ """
+
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The user's name.
+ """
+
+ type: typing.Optional[UserType] = pydantic.Field(default=None)
+ """
+ The user's type.
+ """
+
+ type_native: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Remote field for type.
+ """
+
+ remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the third party's user was created.
+ """
+
+ remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+ """
+ When the third party's user was updated.
+ """
+
+ groups: typing.Optional[typing.List[typing.Optional[str]]] = None
+ mailboxes: typing.Optional[typing.List[typing.Optional[str]]] = None
+ email_addresses: typing.Optional[typing.List[typing.Optional[str]]] = None
+ remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None)
+ """
+ Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+ """
+
+ field_mappings: typing.Optional[UserFieldMappings] = None
+ remote_data: typing.Optional[typing.List[RemoteData]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/user_field_mappings.py b/src/merge/resources/email/types/user_field_mappings.py
new file mode 100644
index 00000000..374935d7
--- /dev/null
+++ b/src/merge/resources/email/types/user_field_mappings.py
@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class UserFieldMappings(UncheckedBaseModel):
+ organization_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+ linked_account_defined_targets: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/user_type.py b/src/merge/resources/email/types/user_type.py
new file mode 100644
index 00000000..b6efee8a
--- /dev/null
+++ b/src/merge/resources/email/types/user_type.py
@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .user_type_enum import UserTypeEnum
+
+UserType = typing.Union[UserTypeEnum, str]
diff --git a/src/merge/resources/email/types/user_type_enum.py b/src/merge/resources/email/types/user_type_enum.py
new file mode 100644
index 00000000..f95c76c1
--- /dev/null
+++ b/src/merge/resources/email/types/user_type_enum.py
@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class UserTypeEnum(str, enum.Enum):
+ INDIVIDUAL = "INDIVIDUAL"
+ SHARED = "SHARED"
+ EXTERNAL = "EXTERNAL"
+
+ def visit(
+ self,
+ individual: typing.Callable[[], T_Result],
+ shared: typing.Callable[[], T_Result],
+ external: typing.Callable[[], T_Result],
+ ) -> T_Result:
+ if self is UserTypeEnum.INDIVIDUAL:
+ return individual()
+ if self is UserTypeEnum.SHARED:
+ return shared()
+ if self is UserTypeEnum.EXTERNAL:
+ return external()
diff --git a/src/merge/resources/email/types/validation_problem_source.py b/src/merge/resources/email/types/validation_problem_source.py
new file mode 100644
index 00000000..fbebe626
--- /dev/null
+++ b/src/merge/resources/email/types/validation_problem_source.py
@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class ValidationProblemSource(UncheckedBaseModel):
+ pointer: str
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/warning_validation_problem.py b/src/merge/resources/email/types/warning_validation_problem.py
new file mode 100644
index 00000000..28a56c2c
--- /dev/null
+++ b/src/merge/resources/email/types/warning_validation_problem.py
@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .validation_problem_source import ValidationProblemSource
+
+
+class WarningValidationProblem(UncheckedBaseModel):
+ source: typing.Optional[ValidationProblemSource] = None
+ title: str
+ detail: str
+ problem_type: str
+ block_merge_link: typing.Optional[bool] = None
+ raw_error: typing.Optional[str] = None
+ error_code: typing.Optional[int] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow
diff --git a/src/merge/resources/email/types/webhook_receiver.py b/src/merge/resources/email/types/webhook_receiver.py
new file mode 100644
index 00000000..fb49c044
--- /dev/null
+++ b/src/merge/resources/email/types/webhook_receiver.py
@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class WebhookReceiver(UncheckedBaseModel):
+ event: str
+ is_active: bool
+ key: typing.Optional[str] = None
+
+ if IS_PYDANTIC_V2:
+ model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
+ else:
+
+ class Config:
+ frozen = True
+ smart_union = True
+ extra = pydantic.Extra.allow