diff --git a/pyproject.toml b/pyproject.toml index 9ec78da9..706cd8c0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "MergePythonClient" -version = "1.1.2" +version = "v1.1.3" description = "" readme = "README.md" authors = [] diff --git a/reference.md b/reference.md index 94f0cd36..5f3ebf44 100644 --- a/reference.md +++ b/reference.md @@ -1,6 +1,6 @@ # Reference -## Filestorage AccountDetails -
client.filestorage.account_details.retrieve() +## Ats AccountDetails +
client.ats.account_details.retrieve()
@@ -33,7 +33,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_details.retrieve() +client.ats.account_details.retrieve() ```
@@ -61,8 +61,8 @@ client.filestorage.account_details.retrieve()
-## Filestorage AccountToken -
client.filestorage.account_token.retrieve(...) +## Ats AccountToken +
client.ats.account_token.retrieve(...)
@@ -95,7 +95,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_token.retrieve( +client.ats.account_token.retrieve( public_token="public_token", ) @@ -133,8 +133,8 @@ client.filestorage.account_token.retrieve(
-## Filestorage AsyncPassthrough -
client.filestorage.async_passthrough.create(...) +## Ats Activities +
client.ats.activities.list(...)
@@ -146,7 +146,7 @@ client.filestorage.account_token.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a list of `Activity` objects.
@@ -162,18 +162,12 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) +client.ats.activities.list() ``` @@ -189,7 +183,7 @@ client.filestorage.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -197,70 +191,31 @@ client.filestorage.async_passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
- -
- - - - -
- -
client.filestorage.async_passthrough.retrieve(...) -
-
- -#### πŸ“ Description - -
-
-Retrieves data from earlier async-passthrough POST request -
-
+**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) - -``` -
-
+**expand:** `typing.Optional[typing.Literal["user"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### βš™οΈ Parameters - -
-
-
-**async_passthrough_receipt_id:** `str` +**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/).
@@ -268,69 +223,31 @@ client.filestorage.async_passthrough.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
- - -
-
-
-## Filestorage AuditTrail -
client.filestorage.audit_trail.list(...)
-#### πŸ“ Description - -
-
- -
-
- -Gets a list of audit trail events. -
-
+**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). +
-#### πŸ”Œ Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.audit_trail.list() - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +
-#### βš™οΈ Parameters - -
-
-
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -338,7 +255,7 @@ client.filestorage.audit_trail.list()
-**end_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred before this time +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -346,7 +263,7 @@ client.filestorage.audit_trail.list()
-**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`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_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`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**remote_fields:** `typing.Optional[ActivitiesListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins.
@@ -354,7 +271,7 @@ client.filestorage.audit_trail.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -362,7 +279,7 @@ client.filestorage.audit_trail.list()
-**start_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred after this time +**show_enum_origins:** `typing.Optional[ActivitiesListRequestShowEnumOrigins]` β€” 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)
@@ -370,7 +287,7 @@ client.filestorage.audit_trail.list()
-**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. +**user_id:** `typing.Optional[str]` β€” If provided, will only return activities done by this user.
@@ -390,8 +307,7 @@ client.filestorage.audit_trail.list()
-## Filestorage AvailableActions -
client.filestorage.available_actions.retrieve() +
client.ats.activities.create(...)
@@ -403,7 +319,7 @@ client.filestorage.audit_trail.list()
-Returns a list of models and actions available for an account. +Creates an `Activity` object with the given values.
@@ -419,12 +335,16 @@ Returns a list of models and actions available for an account. ```python from merge import Merge +from merge.resources.ats import ActivityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.available_actions.retrieve() +client.ats.activities.create( + model=ActivityRequest(), + remote_user_id="remote_user_id", +) ``` @@ -440,65 +360,35 @@ client.filestorage.available_actions.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**model:** `ActivityRequest`
- -
- - - -
- -## Filestorage Scopes -
client.filestorage.scopes.default_scopes_retrieve()
-#### πŸ“ Description - -
-
+**remote_user_id:** `str` + +
+
-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). -
-
+**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.scopes.default_scopes_retrieve() - -``` -
-
+**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +
-#### βš™οΈ Parameters - -
-
-
@@ -514,7 +404,7 @@ client.filestorage.scopes.default_scopes_retrieve()
-
client.filestorage.scopes.linked_account_scopes_retrieve() +
client.ats.activities.retrieve(...)
@@ -526,7 +416,7 @@ client.filestorage.scopes.default_scopes_retrieve()
-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). +Returns an `Activity` object with the given `id`.
@@ -547,7 +437,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.linked_account_scopes_retrieve() +client.ats.activities.retrieve( + id="id", +) ``` @@ -563,94 +455,39 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**id:** `str`
- -
- - - -
- -
client.filestorage.scopes.linked_account_scopes_create(...)
-#### πŸ“ Description - -
-
+**expand:** `typing.Optional[typing.Literal["user"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
-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) -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge -from merge.resources.filestorage import ( - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], -) - -``` -
-
+**remote_fields:** `typing.Optional[ActivitiesRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +
-#### βš™οΈ Parameters - -
-
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β€” The common models you want to update the scopes for +**show_enum_origins:** `typing.Optional[ActivitiesRetrieveRequestShowEnumOrigins]` β€” 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)
@@ -670,8 +507,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-## Filestorage DeleteAccount -
client.filestorage.delete_account.delete() +
client.ats.activities.meta_post_retrieve()
@@ -683,7 +519,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-Delete a linked account. +Returns metadata for `Activity` POSTs.
@@ -704,7 +540,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.delete_account.delete() +client.ats.activities.meta_post_retrieve() ``` @@ -732,8 +568,8 @@ client.filestorage.delete_account.delete()
-## Filestorage Drives -
client.filestorage.drives.list(...) +## Ats Applications +
client.ats.applications.list(...)
@@ -745,7 +581,7 @@ client.filestorage.delete_account.delete()
-Returns a list of `Drive` objects. +Returns a list of `Application` objects.
@@ -766,7 +602,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.list() +client.ats.applications.list() ``` @@ -782,6 +618,14 @@ client.filestorage.drives.list()
+**candidate_id:** `typing.Optional[str]` β€” If provided, will only return applications for this candidate. + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -798,6 +642,22 @@ client.filestorage.drives.list()
+**credited_to_id:** `typing.Optional[str]` β€” If provided, will only return applications credited to this user. + +
+
+ +
+
+ +**current_stage_id:** `typing.Optional[str]` β€” If provided, will only return applications at this interview stage. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -806,6 +666,14 @@ client.filestorage.drives.list()
+**expand:** `typing.Optional[ApplicationsListRequestExpand]` β€” 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/).
@@ -830,6 +698,14 @@ client.filestorage.drives.list()
+**job_id:** `typing.Optional[str]` β€” If provided, will only return applications for this job. + +
+
+ +
+
+ **modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -846,7 +722,7 @@ client.filestorage.drives.list()
-**name:** `typing.Optional[str]` β€” If provided, will only return drives with this name. This performs an exact match. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -854,7 +730,7 @@ client.filestorage.drives.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**reject_reason_id:** `typing.Optional[str]` β€” If provided, will only return applications with this reject reason.
@@ -870,6 +746,14 @@ client.filestorage.drives.list()
+**source:** `typing.Optional[str]` β€” If provided, will only return applications with this source. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -882,7 +766,7 @@ client.filestorage.drives.list()
-
client.filestorage.drives.retrieve(...) +
client.ats.applications.create(...)
@@ -894,7 +778,7 @@ client.filestorage.drives.list()
-Returns a `Drive` object with the given `id`. +Creates an `Application` object with the given values.
@@ -910,13 +794,15 @@ Returns a `Drive` object with the given `id`. ```python from merge import Merge +from merge.resources.ats import ApplicationRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.retrieve( - id="id", +client.ats.applications.create( + model=ApplicationRequest(), + remote_user_id="remote_user_id", ) ``` @@ -933,7 +819,7 @@ client.filestorage.drives.retrieve(
-**id:** `str` +**model:** `ApplicationRequest`
@@ -941,7 +827,23 @@ client.filestorage.drives.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_user_id:** `str` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -961,8 +863,7 @@ client.filestorage.drives.retrieve(
-## Filestorage FieldMapping -
client.filestorage.field_mapping.field_mappings_retrieve() +
client.ats.applications.retrieve(...)
@@ -974,7 +875,7 @@ client.filestorage.drives.retrieve(
-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/). +Returns an `Application` object with the given `id`.
@@ -995,7 +896,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_retrieve() +client.ats.applications.retrieve( + id="id", +) ``` @@ -1011,6 +914,30 @@ client.filestorage.field_mapping.field_mappings_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[ApplicationsRetrieveRequestExpand]` β€” 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. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -1023,7 +950,7 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-
client.filestorage.field_mapping.field_mappings_create(...) +
client.ats.applications.change_stage_create(...)
@@ -1035,7 +962,7 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-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. +Updates the `current_stage` field of an `Application` object
@@ -1056,13 +983,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", +client.ats.applications.change_stage_create( + id="id", ) ``` @@ -1079,15 +1001,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**target_field_name:** `str` β€” The name of the target field you want this remote field to map to. - -
-
- -
-
- -**target_field_description:** `str` β€” The description of the target field you want this remote field to map to. +**id:** `str`
@@ -1095,7 +1009,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**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. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -1103,7 +1017,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_method:** `str` β€” The method of the remote endpoint where the remote field is coming from. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -1111,7 +1025,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_url_path:** `str` β€” The path of the remote endpoint where the remote field is coming from. +**job_interview_stage:** `typing.Optional[str]` β€” The interview stage to move the application to.
@@ -1119,7 +1033,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**common_model_name:** `str` β€” The name of the Common Model that the remote field corresponds to in a given category. +**remote_user_id:** `typing.Optional[str]`
@@ -1139,7 +1053,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
client.filestorage.field_mapping.field_mappings_destroy(...) +
client.ats.applications.meta_post_retrieve(...)
@@ -1151,7 +1065,7 @@ client.filestorage.field_mapping.field_mappings_create(
-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. +Returns metadata for `Application` POSTs.
@@ -1172,9 +1086,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.ats.applications.meta_post_retrieve() ``` @@ -1190,7 +1102,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**application_remote_template_id:** `typing.Optional[str]` β€” The template ID associated with the nested application in the request.
@@ -1210,7 +1122,8 @@ client.filestorage.field_mapping.field_mappings_destroy(
-
client.filestorage.field_mapping.field_mappings_partial_update(...) +## Ats AsyncPassthrough +
client.ats.async_passthrough.create(...)
@@ -1222,7 +1135,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-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. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -1238,13 +1151,17 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r ```python from merge import Merge +from merge.resources.ats import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", +client.ats.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -1261,31 +1178,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` - -
-
- -
-
- -**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. +**request:** `DataPassthroughRequest`
@@ -1305,7 +1198,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
client.filestorage.field_mapping.remote_fields_retrieve(...) +
client.ats.async_passthrough.retrieve(...)
@@ -1317,7 +1210,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-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/). +Retrieves data from earlier async-passthrough POST request
@@ -1338,7 +1231,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.remote_fields_retrieve() +client.ats.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) ``` @@ -1354,15 +1249,7 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-**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. +**async_passthrough_receipt_id:** `str`
@@ -1382,7 +1269,8 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-
client.filestorage.field_mapping.target_fields_retrieve() +## Ats Attachments +
client.ats.attachments.list(...)
@@ -1394,7 +1282,7 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-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/). +Returns a list of `Attachment` objects.
@@ -1415,7 +1303,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.target_fields_retrieve() +client.ats.attachments.list() ``` @@ -1431,64 +1319,10 @@ client.filestorage.field_mapping.target_fields_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**candidate_id:** `typing.Optional[str]` β€” If provided, will only return attachments for this candidate.
- -
- - - - -
- -## Filestorage Files -
client.filestorage.files.list(...) -
-
- -#### πŸ“ Description - -
-
- -
-
- -Returns a list of `File` objects. -
-
-
-
- -#### πŸ”Œ Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.files.list() - -``` -
-
-
-
- -#### βš™οΈ Parameters - -
-
@@ -1517,23 +1351,7 @@ client.filestorage.files.list()
-**drive_id:** `typing.Optional[str]` β€” Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive. - -
-
- -
-
- -**expand:** `typing.Optional[FilesListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**folder_id:** `typing.Optional[str]` β€” Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory. +**expand:** `typing.Optional[typing.Literal["candidate"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -1565,7 +1383,7 @@ client.filestorage.files.list()
-**mime_type:** `typing.Optional[str]` β€” If provided, will only return files with these mime_types. Multiple values can be separated by commas. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -1573,7 +1391,7 @@ client.filestorage.files.list()
-**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.
@@ -1581,7 +1399,7 @@ client.filestorage.files.list()
-**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.
@@ -1589,7 +1407,7 @@ client.filestorage.files.list()
-**name:** `typing.Optional[str]` β€” If provided, will only return files with this name. This performs an exact match. +**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` β€” Deprecated. Use show_enum_origins.
@@ -1597,7 +1415,7 @@ client.filestorage.files.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -1605,7 +1423,7 @@ client.filestorage.files.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**show_enum_origins:** `typing.Optional[typing.Literal["attachment_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)
@@ -1625,7 +1443,7 @@ client.filestorage.files.list()
-
client.filestorage.files.create(...) +
client.ats.attachments.create(...)
@@ -1637,7 +1455,7 @@ client.filestorage.files.list()
-Creates a `File` object with the given values. +Creates an `Attachment` object with the given values.
@@ -1653,14 +1471,15 @@ Creates a `File` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FileRequest +from merge.resources.ats import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.create( - model=FileRequest(), +client.ats.attachments.create( + model=AttachmentRequest(), + remote_user_id="remote_user_id", ) ``` @@ -1677,7 +1496,15 @@ client.filestorage.files.create(
-**model:** `FileRequest` +**model:** `AttachmentRequest` + +
+
+ +
+
+ +**remote_user_id:** `str`
@@ -1713,7 +1540,7 @@ client.filestorage.files.create(
-
client.filestorage.files.retrieve(...) +
client.ats.attachments.retrieve(...)
@@ -1725,7 +1552,7 @@ client.filestorage.files.create(
-Returns a `File` object with the given `id`. +Returns an `Attachment` object with the given `id`.
@@ -1746,7 +1573,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.retrieve( +client.ats.attachments.retrieve( id="id", ) @@ -1772,7 +1599,7 @@ client.filestorage.files.retrieve(
-**expand:** `typing.Optional[FilesRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["candidate"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -1788,6 +1615,22 @@ client.filestorage.files.retrieve(
+**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` β€” Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["attachment_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.
@@ -1800,7 +1643,7 @@ client.filestorage.files.retrieve(
-
client.filestorage.files.download_retrieve(...) +
client.ats.attachments.meta_post_retrieve()
@@ -1812,7 +1655,7 @@ client.filestorage.files.retrieve(
-Returns the `File` content with the given `id` as a stream of bytes. +Returns metadata for `Attachment` POSTs.
@@ -1833,10 +1676,69 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_retrieve( - id="string", - mime_type="string", +client.ats.attachments.meta_post_retrieve() + +``` + +
+ + + +#### βš™οΈ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Ats AuditTrail +
client.ats.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.ats.audit_trail.list() ```
@@ -1852,7 +1754,7 @@ client.filestorage.files.download_retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -1860,7 +1762,39 @@ client.filestorage.files.download_retrieve(
-**mime_type:** `typing.Optional[str]` β€” If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article. +**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`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_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`, `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. + +
+
+ +
+
+ +**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.
@@ -1880,7 +1814,8 @@ client.filestorage.files.download_retrieve(
-
client.filestorage.files.meta_post_retrieve() +## Ats AvailableActions +
client.ats.available_actions.retrieve()
@@ -1892,7 +1827,7 @@ client.filestorage.files.download_retrieve(
-Returns metadata for `FileStorageFile` POSTs. +Returns a list of models and actions available for an account.
@@ -1913,7 +1848,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.meta_post_retrieve() +client.ats.available_actions.retrieve() ``` @@ -1941,8 +1876,8 @@ client.filestorage.files.meta_post_retrieve()
-## Filestorage Folders -
client.filestorage.folders.list(...) +## Ats Candidates +
client.ats.candidates.list(...)
@@ -1954,7 +1889,7 @@ client.filestorage.files.meta_post_retrieve()
-Returns a list of `Folder` objects. +Returns a list of `Candidate` objects.
@@ -1975,7 +1910,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.list() +client.ats.candidates.list() ``` @@ -2015,7 +1950,7 @@ client.filestorage.folders.list()
-**drive_id:** `typing.Optional[str]` β€” If provided, will only return folders in this drive. +**email_addresses:** `typing.Optional[str]` β€” If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas.
@@ -2023,7 +1958,15 @@ client.filestorage.folders.list()
-**expand:** `typing.Optional[FoldersListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[CandidatesListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**first_name:** `typing.Optional[str]` β€” If provided, will only return candidates with this first name.
@@ -2055,7 +1998,7 @@ client.filestorage.folders.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**last_name:** `typing.Optional[str]` β€” If provided, will only return candidates with this last name.
@@ -2063,7 +2006,7 @@ client.filestorage.folders.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -2071,7 +2014,7 @@ client.filestorage.folders.list()
-**name:** `typing.Optional[str]` β€” If provided, will only return folders with this name. This performs an exact match. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -2087,7 +2030,7 @@ client.filestorage.folders.list()
-**parent_folder_id:** `typing.Optional[str]` β€” If provided, will only return folders in this parent folder. If null, will return folders in root directory. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -2095,7 +2038,7 @@ client.filestorage.folders.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**tags:** `typing.Optional[str]` β€” If provided, will only return candidates with these tags; multiple tags can be separated by commas.
@@ -2115,7 +2058,7 @@ client.filestorage.folders.list()
-
client.filestorage.folders.create(...) +
client.ats.candidates.create(...)
@@ -2127,7 +2070,7 @@ client.filestorage.folders.list()
-Creates a `Folder` object with the given values. +Creates a `Candidate` object with the given values.
@@ -2143,14 +2086,15 @@ Creates a `Folder` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FolderRequest +from merge.resources.ats import CandidateRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.create( - model=FolderRequest(), +client.ats.candidates.create( + model=CandidateRequest(), + remote_user_id="remote_user_id", ) ``` @@ -2167,7 +2111,15 @@ client.filestorage.folders.create(
-**model:** `FolderRequest` +**model:** `CandidateRequest` + +
+
+ +
+
+ +**remote_user_id:** `str`
@@ -2203,7 +2155,7 @@ client.filestorage.folders.create(
-
client.filestorage.folders.retrieve(...) +
client.ats.candidates.retrieve(...)
@@ -2215,7 +2167,7 @@ client.filestorage.folders.create(
-Returns a `Folder` object with the given `id`. +Returns a `Candidate` object with the given `id`.
@@ -2236,7 +2188,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.retrieve( +client.ats.candidates.retrieve( id="id", ) @@ -2262,7 +2214,7 @@ client.filestorage.folders.retrieve(
-**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[CandidatesRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -2290,7 +2242,7 @@ client.filestorage.folders.retrieve(
-
client.filestorage.folders.meta_post_retrieve() +
client.ats.candidates.partial_update(...)
@@ -2302,7 +2254,7 @@ client.filestorage.folders.retrieve(
-Returns metadata for `FileStorageFolder` POSTs. +Updates a `Candidate` object with the given `id`.
@@ -2318,12 +2270,17 @@ Returns metadata for `FileStorageFolder` POSTs. ```python from merge import Merge +from merge.resources.ats import PatchedCandidateRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.meta_post_retrieve() +client.ats.candidates.partial_update( + id="id", + model=PatchedCandidateRequest(), + remote_user_id="remote_user_id", +) ``` @@ -2339,71 +2296,39 @@ client.filestorage.folders.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**id:** `str`
- -
- - - -
- -## Filestorage GenerateKey -
client.filestorage.generate_key.create(...)
-#### πŸ“ Description - -
-
+**model:** `PatchedCandidateRequest` + +
+
-Create a remote key. -
-
+**remote_user_id:** `str` +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +
-#### βš™οΈ Parameters - -
-
-
-**name:** `str` β€” The name of the remote key +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -2423,8 +2348,7 @@ client.filestorage.generate_key.create(
-## Filestorage Groups -
client.filestorage.groups.list(...) +
client.ats.candidates.ignore_create(...)
@@ -2436,7 +2360,7 @@ client.filestorage.generate_key.create(
-Returns a list of `Group` objects. +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
@@ -2452,12 +2376,16 @@ Returns a list of `Group` objects. ```python from merge import Merge +from merge.resources.ats import ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.list() +client.ats.candidates.ignore_create( + model_id="model_id", + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +) ``` @@ -2473,63 +2401,7 @@ client.filestorage.groups.list()
-**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. - -
-
- -
-
- -**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. +**model_id:** `str`
@@ -2537,7 +2409,7 @@ client.filestorage.groups.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**reason:** `ReasonEnum`
@@ -2545,7 +2417,7 @@ client.filestorage.groups.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**message:** `typing.Optional[str]`
@@ -2565,7 +2437,7 @@ client.filestorage.groups.list()
-
client.filestorage.groups.retrieve(...) +
client.ats.candidates.meta_patch_retrieve(...)
@@ -2577,7 +2449,7 @@ client.filestorage.groups.list()
-Returns a `Group` object with the given `id`. +Returns metadata for `Candidate` PATCHs.
@@ -2598,7 +2470,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.retrieve( +client.ats.candidates.meta_patch_retrieve( id="id", ) @@ -2624,14 +2496,6 @@ client.filestorage.groups.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -2644,8 +2508,7 @@ client.filestorage.groups.retrieve(
-## Filestorage Issues -
client.filestorage.issues.list(...) +
client.ats.candidates.meta_post_retrieve()
@@ -2657,7 +2520,7 @@ client.filestorage.groups.retrieve(
-Gets all issues for Organization. +Returns metadata for `Candidate` POSTs.
@@ -2678,7 +2541,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.list() +client.ats.candidates.meta_post_retrieve() ``` @@ -2694,116 +2557,217 @@ client.filestorage.issues.list()
-**account_token:** `typing.Optional[str]` +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. -
+
+## Ats Scopes +
client.ats.scopes.default_scopes_retrieve()
-**end_date:** `typing.Optional[str]` β€” If included, will only include issues whose most recent action occurred before this time - -
-
+#### πŸ“ Description
-**end_user_organization_name:** `typing.Optional[str]` - +
+
+ +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 +
-**first_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was after this datetime. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.scopes.default_scopes_retrieve() + +```
+
+
+ +#### βš™οΈ Parameters
-**first_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was before this datetime. +
+
+ +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+
+
-
-
-**include_muted:** `typing.Optional[str]` β€” If true, will include muted issues -
+
+
client.ats.scopes.linked_account_scopes_retrieve()
-**integration_name:** `typing.Optional[str]` - -
-
+#### πŸ“ Description
-**last_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was after this datetime. - +
+
+ +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
-**last_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was before this datetime. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.scopes.linked_account_scopes_retrieve() + +``` +
+
+#### βš™οΈ Parameters +
-**linked_account_id:** `typing.Optional[str]` β€” If provided, will only include issues pertaining to the linked account passed in. +
+
+ +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+
+
+ + + + +
+ +
client.ats.scopes.linked_account_scopes_create(...) +
+
+ +#### πŸ“ Description
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - +
+
+ +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 +
-**start_date:** `typing.Optional[str]` β€” If included, will only include issues whose most recent action occurred after this time - +
+
+ +```python +from merge import Merge +from merge.resources.ats import ( + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], +) + +```
+
+
+ +#### βš™οΈ Parameters
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') +
+
-- `ONGOING` - ONGOING -- `RESOLVED` - RESOLVED +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β€” The common models you want to update the scopes for
@@ -2823,7 +2787,8 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.filestorage.issues.retrieve(...) +## Ats DeleteAccount +
client.ats.delete_account.delete()
@@ -2835,7 +2800,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Delete a linked account.
@@ -2856,9 +2821,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.retrieve( - id="id", -) +client.ats.delete_account.delete() ``` @@ -2874,14 +2837,6 @@ client.filestorage.issues.retrieve(
-**id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -2894,8 +2849,8 @@ client.filestorage.issues.retrieve(
-## Filestorage LinkToken -
client.filestorage.link_token.create(...) +## Ats Departments +
client.ats.departments.list(...)
@@ -2907,7 +2862,7 @@ client.filestorage.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Returns a list of `Department` objects.
@@ -2923,18 +2878,12 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.filestorage import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.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], -) +client.ats.departments.list() ``` @@ -2950,7 +2899,7 @@ client.filestorage.link_token.create(
-**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. +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -2958,7 +2907,7 @@ client.filestorage.link_token.create(
-**end_user_organization_name:** `str` β€” Your end user's organization. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -2966,7 +2915,7 @@ client.filestorage.link_token.create(
-**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. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -2974,7 +2923,7 @@ client.filestorage.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` β€” The integration categories to show in Merge Link. +**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/).
@@ -2982,7 +2931,7 @@ client.filestorage.link_token.create(
-**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/. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -2990,7 +2939,7 @@ client.filestorage.link_token.create(
-**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. +**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).
@@ -2998,7 +2947,7 @@ client.filestorage.link_token.create(
-**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. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -3006,7 +2955,7 @@ client.filestorage.link_token.create(
-**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. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -3014,7 +2963,7 @@ client.filestorage.link_token.create(
-**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. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -3022,14 +2971,7 @@ client.filestorage.link_token.create(
-**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. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -3037,12 +2979,70 @@ client.filestorage.link_token.create(
-**language:** `typing.Optional[LanguageEnum]` +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. + +
+
+ +
-The following subset of IETF language tags can be used to configure localization. -* `en` - en -* `de` - de + + +
+ +
client.ats.departments.retrieve(...) +
+
+ +#### πŸ“ Description + +
+
+ +
+
+ +Returns a `Department` object with the given `id`. +
+
+
+
+ +#### πŸ”Œ Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.departments.retrieve( + id="id", +) + +``` +
+
+
+
+ +#### βš™οΈ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -3050,7 +3050,7 @@ The following subset of IETF language tags can be used to configure localization
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β€” A JSON object containing integration-specific configuration options. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -3070,8 +3070,8 @@ The following subset of IETF language tags can be used to configure localization
-## Filestorage LinkedAccounts -
client.filestorage.linked_accounts.list(...) +## Ats Eeocs +
client.ats.eeocs.list(...)
@@ -3083,7 +3083,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a list of `EEOC` objects.
@@ -3104,7 +3104,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.linked_accounts.list() +client.ats.eeocs.list() ``` @@ -3120,17 +3120,15 @@ client.filestorage.linked_accounts.list()
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` +**candidate_id:** `typing.Optional[str]` β€” If provided, will only return EEOC info for this candidate. + +
+
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` +
+
-- `hris` - hris -- `ats` - ats -- `accounting` - accounting -- `ticketing` - ticketing -- `crm` - crm -- `mktg` - mktg -- `filestorage` - filestorage +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -3138,7 +3136,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -3146,7 +3144,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_email_address:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given email address. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -3154,7 +3152,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_organization_name:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given organization name. +**expand:** `typing.Optional[typing.Literal["candidate"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -3162,7 +3160,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_id:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given origin ID. +**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/).
@@ -3170,7 +3168,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_ids:** `typing.Optional[str]` β€” Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -3178,7 +3176,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**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).
@@ -3186,7 +3184,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**ids:** `typing.Optional[str]` β€” Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -3194,7 +3192,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**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. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -3202,7 +3200,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given integration name. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -3210,7 +3208,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**is_test_account:** `typing.Optional[str]` β€” If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**remote_fields:** `typing.Optional[EeocsListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins.
@@ -3218,7 +3216,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -3226,7 +3224,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` β€” Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**show_enum_origins:** `typing.Optional[EeocsListRequestShowEnumOrigins]` β€” 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)
@@ -3246,8 +3244,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Filestorage Passthrough -
client.filestorage.passthrough.create(...) +
client.ats.eeocs.retrieve(...)
@@ -3259,7 +3256,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +Returns an `EEOC` object with the given `id`.
@@ -3275,17 +3272,13 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.ats.eeocs.retrieve( + id="id", ) ``` @@ -3302,7 +3295,39 @@ client.filestorage.passthrough.create(
-**request:** `DataPassthroughRequest` +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["candidate"]]` β€” 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. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[EeocsRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[EeocsRetrieveRequestShowEnumOrigins]` β€” 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)
@@ -3322,8 +3347,8 @@ client.filestorage.passthrough.create(
-## Filestorage RegenerateKey -
client.filestorage.regenerate_key.create(...) +## Ats FieldMapping +
client.ats.field_mapping.field_mappings_retrieve()
@@ -3335,7 +3360,7 @@ client.filestorage.passthrough.create(
-Exchange remote keys. +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/).
@@ -3356,9 +3381,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.regenerate_key.create( - name="Remote Deployment Key 1", -) +client.ats.field_mapping.field_mappings_retrieve() ``` @@ -3374,14 +3397,6 @@ client.filestorage.regenerate_key.create(
-**name:** `str` β€” The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -3394,8 +3409,7 @@ client.filestorage.regenerate_key.create(
-## Filestorage SyncStatus -
client.filestorage.sync_status.list(...) +
client.ats.field_mapping.field_mappings_create(...)
@@ -3407,7 +3421,7 @@ client.filestorage.regenerate_key.create(
-Get syncing status. Possible values: `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). +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.
@@ -3428,7 +3442,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.sync_status.list() +client.ats.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) ``` @@ -3444,7 +3465,7 @@ client.filestorage.sync_status.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**target_field_name:** `str` β€” The name of the target field you want this remote field to map to.
@@ -3452,7 +3473,39 @@ client.filestorage.sync_status.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**target_field_description:** `str` β€” The description of the target field you want this remote field to map to. + +
+
+ +
+
+ +**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.
@@ -3472,8 +3525,7 @@ client.filestorage.sync_status.list()
-## Filestorage ForceResync -
client.filestorage.force_resync.sync_status_resync_create() +
client.ats.field_mapping.field_mappings_destroy(...)
@@ -3485,7 +3537,7 @@ client.filestorage.sync_status.list()
-Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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. +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.
@@ -3506,7 +3558,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.force_resync.sync_status_resync_create() +client.ats.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -3522,6 +3576,14 @@ client.filestorage.force_resync.sync_status_resync_create()
+**field_mapping_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -3534,8 +3596,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-## Filestorage Users -
client.filestorage.users.list(...) +
client.ats.field_mapping.field_mappings_partial_update(...)
@@ -3547,7 +3608,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-Returns a list of `User` objects. +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.
@@ -3568,7 +3629,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.list() +client.ats.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) ``` @@ -3584,7 +3647,7 @@ client.filestorage.users.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**field_mapping_id:** `str`
@@ -3592,7 +3655,7 @@ client.filestorage.users.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**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.
@@ -3600,7 +3663,7 @@ client.filestorage.users.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**remote_method:** `typing.Optional[str]` β€” The method of the remote endpoint where the remote field is coming from.
@@ -3608,63 +3671,7 @@ client.filestorage.users.list()
-**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). - -
-
- -
-
- -**is_me:** `typing.Optional[str]` β€” If provided, will only return the user object for requestor. - -
-
- -
-
- -**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. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**remote_url_path:** `typing.Optional[str]` β€” The path of the remote endpoint where the remote field is coming from.
@@ -3684,7 +3691,7 @@ client.filestorage.users.list()
-
client.filestorage.users.retrieve(...) +
client.ats.field_mapping.remote_fields_retrieve(...)
@@ -3696,7 +3703,7 @@ client.filestorage.users.list()
-Returns a `User` object with the given `id`. +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/).
@@ -3717,9 +3724,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.retrieve( - id="id", -) +client.ats.field_mapping.remote_fields_retrieve() ``` @@ -3735,7 +3740,7 @@ client.filestorage.users.retrieve(
-**id:** `str` +**common_models:** `typing.Optional[str]` β€” A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -3743,7 +3748,7 @@ client.filestorage.users.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these 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.
@@ -3763,8 +3768,7 @@ client.filestorage.users.retrieve(
-## Filestorage WebhookReceivers -
client.filestorage.webhook_receivers.list() +
client.ats.field_mapping.target_fields_retrieve()
@@ -3776,7 +3780,7 @@ client.filestorage.users.retrieve(
-Returns a list of `WebhookReceiver` objects. +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/).
@@ -3797,7 +3801,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.webhook_receivers.list() +client.ats.field_mapping.target_fields_retrieve() ``` @@ -3825,7 +3829,8 @@ client.filestorage.webhook_receivers.list()
-
client.filestorage.webhook_receivers.create(...) +## Ats GenerateKey +
client.ats.generate_key.create(...)
@@ -3837,7 +3842,7 @@ client.filestorage.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Create a remote key.
@@ -3858,9 +3863,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.webhook_receivers.create( - event="event", - is_active=True, +client.ats.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -3877,23 +3881,7 @@ client.filestorage.webhook_receivers.create(
-**event:** `str` - -
-
- -
-
- -**is_active:** `bool` - -
-
- -
-
- -**key:** `typing.Optional[str]` +**name:** `str` β€” The name of the remote key
@@ -3913,8 +3901,8 @@ client.filestorage.webhook_receivers.create(
-## Ats AccountDetails -
client.ats.account_details.retrieve() +## Ats Interviews +
client.ats.interviews.list(...)
@@ -3926,7 +3914,7 @@ client.filestorage.webhook_receivers.create(
-Get details for a linked account. +Returns a list of `ScheduledInterview` objects.
@@ -3947,7 +3935,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.account_details.retrieve() +client.ats.interviews.list() ``` @@ -3963,71 +3951,15 @@ client.ats.account_details.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**application_id:** `typing.Optional[str]` β€” If provided, will only return interviews for this application.
- -
- - - - -
- -## Ats AccountToken -
client.ats.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.ats.account_token.retrieve( - public_token="public_token", -) - -``` -
-
-
-
- -#### βš™οΈ Parameters - -
-
-**public_token:** `str` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -4035,69 +3967,15 @@ client.ats.account_token.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
-
-
- - -
-
-
- -## Ats Activities -
client.ats.activities.list(...) -
-
- -#### πŸ“ Description - -
-
- -
-
- -Returns a list of `Activity` objects. -
-
-
-
- -#### πŸ”Œ Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.activities.list() - -``` -
-
-
-
- -#### βš™οΈ Parameters
-
-
- -**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -4105,7 +3983,7 @@ client.ats.activities.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[InterviewsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -4113,7 +3991,7 @@ client.ats.activities.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**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/).
@@ -4121,7 +3999,7 @@ client.ats.activities.list()
-**expand:** `typing.Optional[typing.Literal["user"]]` β€” 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.
@@ -4129,7 +4007,7 @@ client.ats.activities.list()
-**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_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).
@@ -4137,7 +4015,7 @@ client.ats.activities.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**job_id:** `typing.Optional[str]` β€” If provided, wll only return interviews organized for this job.
@@ -4145,7 +4023,7 @@ client.ats.activities.list()
-**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). +**job_interview_stage_id:** `typing.Optional[str]` β€” If provided, will only return interviews at this stage.
@@ -4169,7 +4047,7 @@ client.ats.activities.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**organizer_id:** `typing.Optional[str]` β€” If provided, will only return interviews organized by this user.
@@ -4177,7 +4055,7 @@ client.ats.activities.list()
-**remote_fields:** `typing.Optional[ActivitiesListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -4185,7 +4063,7 @@ client.ats.activities.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins.
@@ -4193,7 +4071,7 @@ client.ats.activities.list()
-**show_enum_origins:** `typing.Optional[ActivitiesListRequestShowEnumOrigins]` β€” 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) +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -4201,7 +4079,7 @@ client.ats.activities.list()
-**user_id:** `typing.Optional[str]` β€” If provided, will only return activities done by this user. +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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)
@@ -4221,7 +4099,7 @@ client.ats.activities.list()
-
client.ats.activities.create(...) +
client.ats.interviews.create(...)
@@ -4233,7 +4111,7 @@ client.ats.activities.list()
-Creates an `Activity` object with the given values. +Creates a `ScheduledInterview` object with the given values.
@@ -4249,14 +4127,14 @@ Creates an `Activity` object with the given values. ```python from merge import Merge -from merge.resources.ats import ActivityRequest +from merge.resources.ats import ScheduledInterviewRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.create( - model=ActivityRequest(), +client.ats.interviews.create( + model=ScheduledInterviewRequest(), remote_user_id="remote_user_id", ) @@ -4274,7 +4152,7 @@ client.ats.activities.create(
-**model:** `ActivityRequest` +**model:** `ScheduledInterviewRequest`
@@ -4318,7 +4196,7 @@ client.ats.activities.create(
-
client.ats.activities.retrieve(...) +
client.ats.interviews.retrieve(...)
@@ -4330,7 +4208,7 @@ client.ats.activities.create(
-Returns an `Activity` object with the given `id`. +Returns a `ScheduledInterview` object with the given `id`.
@@ -4351,7 +4229,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.retrieve( +client.ats.interviews.retrieve( id="id", ) @@ -4377,7 +4255,7 @@ client.ats.activities.retrieve(
-**expand:** `typing.Optional[typing.Literal["user"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[InterviewsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -4393,7 +4271,7 @@ client.ats.activities.retrieve(
-**remote_fields:** `typing.Optional[ActivitiesRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins.
@@ -4401,7 +4279,7 @@ client.ats.activities.retrieve(
-**show_enum_origins:** `typing.Optional[ActivitiesRetrieveRequestShowEnumOrigins]` β€” 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) +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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)
@@ -4421,7 +4299,7 @@ client.ats.activities.retrieve(
-
client.ats.activities.meta_post_retrieve() +
client.ats.interviews.meta_post_retrieve()
@@ -4433,7 +4311,7 @@ client.ats.activities.retrieve(
-Returns metadata for `Activity` POSTs. +Returns metadata for `ScheduledInterview` POSTs.
@@ -4454,7 +4332,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.activities.meta_post_retrieve() +client.ats.interviews.meta_post_retrieve() ``` @@ -4482,8 +4360,8 @@ client.ats.activities.meta_post_retrieve()
-## Ats Applications -
client.ats.applications.list(...) +## Ats Issues +
client.ats.issues.list(...)
@@ -4495,7 +4373,7 @@ client.ats.activities.meta_post_retrieve()
-Returns a list of `Application` objects. +Gets all issues for Organization.
@@ -4516,7 +4394,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.list() +client.ats.issues.list() ``` @@ -4532,23 +4410,7 @@ client.ats.applications.list()
-**candidate_id:** `typing.Optional[str]` β€” If provided, will only return applications for this candidate. - -
-
- -
-
- -**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. +**account_token:** `typing.Optional[str]`
@@ -4556,7 +4418,7 @@ client.ats.applications.list()
-**credited_to_id:** `typing.Optional[str]` β€” If provided, will only return applications credited to this user. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -4564,7 +4426,7 @@ client.ats.applications.list()
-**current_stage_id:** `typing.Optional[str]` β€” If provided, will only return applications at this interview stage. +**end_date:** `typing.Optional[str]` β€” If included, will only include issues whose most recent action occurred before this time
@@ -4572,7 +4434,7 @@ client.ats.applications.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**end_user_organization_name:** `typing.Optional[str]`
@@ -4580,7 +4442,7 @@ client.ats.applications.list()
-**expand:** `typing.Optional[ApplicationsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**first_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was after this datetime.
@@ -4588,7 +4450,7 @@ client.ats.applications.list()
-**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/). +**first_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was before this datetime.
@@ -4596,7 +4458,7 @@ client.ats.applications.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**include_muted:** `typing.Optional[str]` β€” If true, will include muted issues
@@ -4604,7 +4466,7 @@ client.ats.applications.list()
-**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). +**integration_name:** `typing.Optional[str]`
@@ -4612,7 +4474,7 @@ client.ats.applications.list()
-**job_id:** `typing.Optional[str]` β€” If provided, will only return applications for this job. +**last_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was after this datetime.
@@ -4620,7 +4482,7 @@ client.ats.applications.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**last_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was before this datetime.
@@ -4628,7 +4490,7 @@ client.ats.applications.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**linked_account_id:** `typing.Optional[str]` β€” If provided, will only include issues pertaining to the linked account passed in.
@@ -4644,7 +4506,7 @@ client.ats.applications.list()
-**reject_reason_id:** `typing.Optional[str]` β€” If provided, will only return applications with this reject reason. +**start_date:** `typing.Optional[str]` β€” If included, will only include issues whose most recent action occurred after this time
@@ -4652,15 +4514,12 @@ client.ats.applications.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
+**status:** `typing.Optional[IssuesListRequestStatus]` -
-
+Status of the issue. Options: ('ONGOING', 'RESOLVED') -**source:** `typing.Optional[str]` β€” If provided, will only return applications with this source. +- `ONGOING` - ONGOING +- `RESOLVED` - RESOLVED
@@ -4680,7 +4539,7 @@ client.ats.applications.list()
-
client.ats.applications.create(...) +
client.ats.issues.retrieve(...)
@@ -4692,7 +4551,7 @@ client.ats.applications.list()
-Creates an `Application` object with the given values. +Get a specific issue.
@@ -4708,15 +4567,13 @@ Creates an `Application` object with the given values. ```python from merge import Merge -from merge.resources.ats import ApplicationRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.create( - model=ApplicationRequest(), - remote_user_id="remote_user_id", +client.ats.issues.retrieve( + id="id", ) ``` @@ -4733,31 +4590,7 @@ client.ats.applications.create(
-**model:** `ApplicationRequest` - -
-
- -
-
- -**remote_user_id:** `str` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**id:** `str`
@@ -4777,7 +4610,8 @@ client.ats.applications.create(
-
client.ats.applications.retrieve(...) +## Ats JobInterviewStages +
client.ats.job_interview_stages.list(...)
@@ -4789,7 +4623,7 @@ client.ats.applications.create(
-Returns an `Application` object with the given `id`. +Returns a list of `JobInterviewStage` objects.
@@ -4810,9 +4644,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.retrieve( - id="id", -) +client.ats.job_interview_stages.list() ``` @@ -4828,7 +4660,7 @@ client.ats.applications.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -4836,7 +4668,7 @@ client.ats.applications.retrieve(
-**expand:** `typing.Optional[ApplicationsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -4844,7 +4676,7 @@ client.ats.applications.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -4852,70 +4684,39 @@ client.ats.applications.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**expand:** `typing.Optional[typing.Literal["job"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
- -
- - - - -
-
client.ats.applications.change_stage_create(...)
-#### πŸ“ Description - -
-
+**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/). + +
+
-Updates the `current_stage` field of an `Application` object -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.applications.change_stage_create( - id="id", -) - -``` -
-
+**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). +
-#### βš™οΈ Parameters - -
-
-
-**id:** `str` +**job_id:** `typing.Optional[str]` β€” If provided, will only return interview stages for this job.
@@ -4923,7 +4724,7 @@ client.ats.applications.change_stage_create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -4931,7 +4732,7 @@ client.ats.applications.change_stage_create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -4939,7 +4740,7 @@ client.ats.applications.change_stage_create(
-**job_interview_stage:** `typing.Optional[str]` β€” The interview stage to move the application to. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -4947,7 +4748,7 @@ client.ats.applications.change_stage_create(
-**remote_user_id:** `typing.Optional[str]` +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -4967,7 +4768,7 @@ client.ats.applications.change_stage_create(
-
client.ats.applications.meta_post_retrieve(...) +
client.ats.job_interview_stages.retrieve(...)
@@ -4979,7 +4780,7 @@ client.ats.applications.change_stage_create(
-Returns metadata for `Application` POSTs. +Returns a `JobInterviewStage` object with the given `id`.
@@ -5000,7 +4801,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.applications.meta_post_retrieve() +client.ats.job_interview_stages.retrieve( + id="id", +) ``` @@ -5016,7 +4819,7 @@ client.ats.applications.meta_post_retrieve()
-**application_remote_template_id:** `typing.Optional[str]` β€” The template ID associated with the nested application in the request. +**id:** `str`
@@ -5024,75 +4827,15 @@ client.ats.applications.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**expand:** `typing.Optional[typing.Literal["job"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
- -
- - - -
- -## Ats AsyncPassthrough -
client.ats.async_passthrough.create(...)
-#### πŸ“ Description - -
-
- -
-
- -Asynchronously pull data from an endpoint not currently supported by Merge. -
-
-
-
- -#### πŸ”Œ Usage - -
-
- -
-
- -```python -from merge import Merge -from merge.resources.ats import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
-
-
- -#### βš™οΈ Parameters - -
-
- -
-
- -**request:** `DataPassthroughRequest` +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -5112,7 +4855,8 @@ client.ats.async_passthrough.create(
-
client.ats.async_passthrough.retrieve(...) +## Ats JobPostings +
client.ats.job_postings.list(...)
@@ -5124,7 +4868,7 @@ client.ats.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Returns a list of `JobPosting` objects.
@@ -5145,79 +4889,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.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. - -
-
-
-
- - - - -
- -## Ats Attachments -
client.ats.attachments.list(...) -
-
- -#### πŸ“ Description - -
-
- -
-
- -Returns a list of `Attachment` objects. -
-
-
-
- -#### πŸ”Œ Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.attachments.list() +client.ats.job_postings.list() ```
@@ -5233,14 +4905,6 @@ client.ats.attachments.list()
-**candidate_id:** `typing.Optional[str]` β€” If provided, will only return attachments for this candidate. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -5265,7 +4929,7 @@ client.ats.attachments.list()
-**expand:** `typing.Optional[typing.Literal["candidate"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["job"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5321,7 +4985,7 @@ client.ats.attachments.list()
-**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` β€” Deprecated. Use show_enum_origins. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -5329,15 +4993,15 @@ client.ats.attachments.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
+**status:** `typing.Optional[JobPostingsListRequestStatus]` -
-
+If provided, will only return Job Postings with this status. Options: ('PUBLISHED', 'CLOSED', 'DRAFT', 'INTERNAL', 'PENDING') -**show_enum_origins:** `typing.Optional[typing.Literal["attachment_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) +- `PUBLISHED` - PUBLISHED +- `CLOSED` - CLOSED +- `DRAFT` - DRAFT +- `INTERNAL` - INTERNAL +- `PENDING` - PENDING
@@ -5357,7 +5021,7 @@ client.ats.attachments.list()
-
client.ats.attachments.create(...) +
client.ats.job_postings.retrieve(...)
@@ -5369,7 +5033,7 @@ client.ats.attachments.list()
-Creates an `Attachment` object with the given values. +Returns a `JobPosting` object with the given `id`.
@@ -5385,15 +5049,13 @@ Creates an `Attachment` object with the given values. ```python from merge import Merge -from merge.resources.ats import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.attachments.create( - model=AttachmentRequest(), - remote_user_id="remote_user_id", +client.ats.job_postings.retrieve( + id="id", ) ``` @@ -5410,15 +5072,7 @@ client.ats.attachments.create(
-**model:** `AttachmentRequest` - -
-
- -
-
- -**remote_user_id:** `str` +**id:** `str`
@@ -5426,7 +5080,7 @@ client.ats.attachments.create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**expand:** `typing.Optional[typing.Literal["job"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5434,7 +5088,7 @@ client.ats.attachments.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -5454,7 +5108,8 @@ client.ats.attachments.create(
-
client.ats.attachments.retrieve(...) +## Ats Jobs +
client.ats.jobs.list(...)
@@ -5466,7 +5121,7 @@ client.ats.attachments.create(
-Returns an `Attachment` object with the given `id`. +Returns a list of `Job` objects.
@@ -5487,9 +5142,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.attachments.retrieve( - id="id", -) +client.ats.jobs.list() ``` @@ -5505,7 +5158,7 @@ client.ats.attachments.retrieve(
-**id:** `str` +**code:** `typing.Optional[str]` β€” If provided, will only return jobs with this code.
@@ -5513,7 +5166,7 @@ client.ats.attachments.retrieve(
-**expand:** `typing.Optional[typing.Literal["candidate"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -5521,7 +5174,7 @@ client.ats.attachments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -5529,7 +5182,7 @@ client.ats.attachments.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` β€” Deprecated. Use show_enum_origins. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -5537,7 +5190,7 @@ client.ats.attachments.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["attachment_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) +**expand:** `typing.Optional[JobsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5545,64 +5198,99 @@ client.ats.attachments.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-
client.ats.attachments.meta_post_retrieve()
-#### πŸ“ Description +**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. + +
+
+
-Returns metadata for `Attachment` POSTs. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**offices:** `typing.Optional[str]` β€” If provided, will only return jobs for this office; multiple offices can be separated by commas. +
-#### πŸ”Œ Usage -
+**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
+
-```python -from merge import Merge +**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.attachments.meta_post_retrieve() +
+
-``` +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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) +
-#### βš™οΈ Parameters -
+**status:** `typing.Optional[JobsListRequestStatus]` + +If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING') + +- `OPEN` - OPEN +- `CLOSED` - CLOSED +- `DRAFT` - DRAFT +- `ARCHIVED` - ARCHIVED +- `PENDING` - PENDING + +
+
+
@@ -5618,8 +5306,7 @@ client.ats.attachments.meta_post_retrieve()
-## Ats AuditTrail -
client.ats.audit_trail.list(...) +
client.ats.jobs.retrieve(...)
@@ -5631,7 +5318,7 @@ client.ats.attachments.meta_post_retrieve()
-Gets a list of audit trail events. +Returns a `Job` object with the given `id`.
@@ -5652,7 +5339,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.audit_trail.list() +client.ats.jobs.retrieve( + id="id", +) ``` @@ -5668,15 +5357,7 @@ client.ats.audit_trail.list()
-**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 +**id:** `str`
@@ -5684,7 +5365,7 @@ client.ats.audit_trail.list()
-**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`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_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`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**expand:** `typing.Optional[JobsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5692,7 +5373,7 @@ client.ats.audit_trail.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -5700,7 +5381,7 @@ client.ats.audit_trail.list()
-**start_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred after this time +**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins.
@@ -5708,7 +5389,7 @@ client.ats.audit_trail.list()
-**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. +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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)
@@ -5728,8 +5409,7 @@ client.ats.audit_trail.list()
-## Ats AvailableActions -
client.ats.available_actions.retrieve() +
client.ats.jobs.screening_questions_list(...)
@@ -5741,7 +5421,7 @@ client.ats.audit_trail.list()
-Returns a list of models and actions available for an account. +Returns a list of `ScreeningQuestion` objects.
@@ -5762,7 +5442,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.available_actions.retrieve() +client.ats.jobs.screening_questions_list( + job_id="job_id", +) ``` @@ -5778,6 +5460,62 @@ client.ats.available_actions.retrieve()
+**job_id:** `str` + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[JobsScreeningQuestionsListRequestExpand]` β€” 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). + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -5790,8 +5528,8 @@ client.ats.available_actions.retrieve()
-## Ats Candidates -
client.ats.candidates.list(...) +## Ats LinkToken +
client.ats.link_token.create(...)
@@ -5803,7 +5541,7 @@ client.ats.available_actions.retrieve()
-Returns a list of `Candidate` objects. +Creates a link token to be used when linking a new end user.
@@ -5819,12 +5557,18 @@ Returns a list of `Candidate` objects. ```python from merge import Merge +from merge.resources.ats import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.list() +client.ats.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], +) ``` @@ -5840,23 +5584,7 @@ client.ats.candidates.list()
-**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. +**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.
@@ -5864,7 +5592,7 @@ client.ats.candidates.list()
-**email_addresses:** `typing.Optional[str]` β€” If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas. +**end_user_organization_name:** `str` β€” Your end user's organization.
@@ -5872,7 +5600,7 @@ client.ats.candidates.list()
-**expand:** `typing.Optional[CandidatesListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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.
@@ -5880,7 +5608,7 @@ client.ats.candidates.list()
-**first_name:** `typing.Optional[str]` β€” If provided, will only return candidates with this first name. +**categories:** `typing.Sequence[CategoriesEnum]` β€” The integration categories to show in Merge Link.
@@ -5888,7 +5616,7 @@ client.ats.candidates.list()
-**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/). +**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/.
@@ -5896,7 +5624,7 @@ client.ats.candidates.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -5904,7 +5632,7 @@ client.ats.candidates.list()
-**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). +**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.
@@ -5912,7 +5640,7 @@ client.ats.candidates.list()
-**last_name:** `typing.Optional[str]` β€” If provided, will only return candidates with this last name. +**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.
@@ -5920,7 +5648,7 @@ client.ats.candidates.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**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.
@@ -5928,7 +5656,14 @@ client.ats.candidates.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**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.
@@ -5936,15 +5671,12 @@ client.ats.candidates.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - -
-
+**language:** `typing.Optional[LanguageEnum]` -
-
+The following subset of IETF language tags can be used to configure localization. -**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +* `en` - en +* `de` - de
@@ -5952,7 +5684,7 @@ client.ats.candidates.list()
-**tags:** `typing.Optional[str]` β€” If provided, will only return candidates with these tags; multiple tags can be separated by commas. +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β€” A JSON object containing integration-specific configuration options.
@@ -5972,7 +5704,8 @@ client.ats.candidates.list()
-
client.ats.candidates.create(...) +## Ats LinkedAccounts +
client.ats.linked_accounts.list(...)
@@ -5984,7 +5717,7 @@ client.ats.candidates.list()
-Creates a `Candidate` object with the given values. +List linked accounts for your organization.
@@ -6000,16 +5733,12 @@ Creates a `Candidate` object with the given values. ```python from merge import Merge -from merge.resources.ats import CandidateRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.create( - model=CandidateRequest(), - remote_user_id="remote_user_id", -) +client.ats.linked_accounts.list() ``` @@ -6025,7 +5754,17 @@ client.ats.candidates.create(
-**model:** `CandidateRequest` +**category:** `typing.Optional[LinkedAccountsListRequestCategory]` + +Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` + +- `hris` - hris +- `ats` - ats +- `accounting` - accounting +- `ticketing` - ticketing +- `crm` - crm +- `mktg` - mktg +- `filestorage` - filestorage
@@ -6033,7 +5772,7 @@ client.ats.candidates.create(
-**remote_user_id:** `str` +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -6041,7 +5780,7 @@ client.ats.candidates.create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**end_user_email_address:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given email address.
@@ -6049,7 +5788,7 @@ client.ats.candidates.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**end_user_organization_name:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given organization name.
@@ -6057,70 +5796,55 @@ client.ats.candidates.create(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-
client.ats.candidates.retrieve(...)
-#### πŸ“ Description - -
-
+**id:** `typing.Optional[str]` + +
+
-Returns a `Candidate` object with the given `id`. -
-
+**ids:** `typing.Optional[str]` β€” Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.candidates.retrieve( - id="id", -) - -``` -
-
+**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. +
-#### βš™οΈ Parameters -
+**integration_name:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given integration name. + +
+
+
-**id:** `str` +**is_test_account:** `typing.Optional[str]` β€” If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -6128,7 +5852,7 @@ client.ats.candidates.retrieve(
-**expand:** `typing.Optional[CandidatesRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -6136,7 +5860,7 @@ client.ats.candidates.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**status:** `typing.Optional[str]` β€” Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -6156,7 +5880,8 @@ client.ats.candidates.retrieve(
-
client.ats.candidates.partial_update(...) +## Ats Offers +
client.ats.offers.list(...)
@@ -6168,7 +5893,7 @@ client.ats.candidates.retrieve(
-Updates a `Candidate` object with the given `id`. +Returns a list of `Offer` objects.
@@ -6184,17 +5909,12 @@ Updates a `Candidate` object with the given `id`. ```python from merge import Merge -from merge.resources.ats import PatchedCandidateRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.partial_update( - id="id", - model=PatchedCandidateRequest(), - remote_user_id="remote_user_id", -) +client.ats.offers.list() ``` @@ -6210,7 +5930,7 @@ client.ats.candidates.partial_update(
-**id:** `str` +**application_id:** `typing.Optional[str]` β€” If provided, will only return offers for this application.
@@ -6218,7 +5938,7 @@ client.ats.candidates.partial_update(
-**model:** `PatchedCandidateRequest` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -6226,7 +5946,7 @@ client.ats.candidates.partial_update(
-**remote_user_id:** `str` +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -6234,7 +5954,7 @@ client.ats.candidates.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**creator_id:** `typing.Optional[str]` β€” If provided, will only return offers created by this user.
@@ -6242,7 +5962,7 @@ client.ats.candidates.partial_update(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -6250,72 +5970,63 @@ client.ats.candidates.partial_update(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**expand:** `typing.Optional[OffersListRequestExpand]` β€” 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/). +
-
-
client.ats.candidates.ignore_create(...)
-#### πŸ“ Description - -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. -
-
+**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). +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge -from merge.resources.ats import ReasonEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.candidates.ignore_create( - model_id="model_id", - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, -) - -``` +**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. +
-#### βš™οΈ Parameters -
+**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
+
-**model_id:** `str` +**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins.
@@ -6323,7 +6034,7 @@ client.ats.candidates.ignore_create(
-**reason:** `ReasonEnum` +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -6331,7 +6042,7 @@ client.ats.candidates.ignore_create(
-**message:** `typing.Optional[str]` +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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)
@@ -6351,7 +6062,7 @@ client.ats.candidates.ignore_create(
-
client.ats.candidates.meta_patch_retrieve(...) +
client.ats.offers.retrieve(...)
@@ -6363,7 +6074,7 @@ client.ats.candidates.ignore_create(
-Returns metadata for `Candidate` PATCHs. +Returns an `Offer` object with the given `id`.
@@ -6384,7 +6095,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.meta_patch_retrieve( +client.ats.offers.retrieve( id="id", ) @@ -6410,6 +6121,38 @@ client.ats.candidates.meta_patch_retrieve(
+**expand:** `typing.Optional[OffersRetrieveRequestExpand]` β€” 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. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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.
@@ -6422,7 +6165,8 @@ client.ats.candidates.meta_patch_retrieve(
-
client.ats.candidates.meta_post_retrieve() +## Ats Offices +
client.ats.offices.list(...)
@@ -6434,7 +6178,7 @@ client.ats.candidates.meta_patch_retrieve(
-Returns metadata for `Candidate` POSTs. +Returns a list of `Office` objects.
@@ -6455,7 +6199,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.candidates.meta_post_retrieve() +client.ats.offices.list() ``` @@ -6471,65 +6215,83 @@ client.ats.candidates.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-## Ats Scopes -
client.ats.scopes.default_scopes_retrieve()
-#### πŸ“ Description +**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+**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/). + +
+
+
-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). -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + -#### πŸ”Œ Usage -
+**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). + +
+
+
-```python -from merge import Merge +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.scopes.default_scopes_retrieve() +
+
-``` +**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. +
-#### βš™οΈ Parameters -
+**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. + +
+
+
@@ -6545,7 +6307,7 @@ client.ats.scopes.default_scopes_retrieve()
-
client.ats.scopes.linked_account_scopes_retrieve() +
client.ats.offices.retrieve(...)
@@ -6557,7 +6319,7 @@ client.ats.scopes.default_scopes_retrieve()
-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). +Returns an `Office` object with the given `id`.
@@ -6578,7 +6340,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scopes.linked_account_scopes_retrieve() +client.ats.offices.retrieve( + id="id", +) ``` @@ -6594,6 +6358,22 @@ client.ats.scopes.linked_account_scopes_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -6606,7 +6386,8 @@ client.ats.scopes.linked_account_scopes_retrieve()
-
client.ats.scopes.linked_account_scopes_create(...) +## Ats Passthrough +
client.ats.passthrough.create(...)
@@ -6618,7 +6399,7 @@ client.ats.scopes.linked_account_scopes_retrieve()
-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) +Pull data from an endpoint not currently supported by Merge.
@@ -6634,37 +6415,17 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.ats import ( - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) +from merge.resources.ats import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +client.ats.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -6681,7 +6442,7 @@ client.ats.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β€” The common models you want to update the scopes for +**request:** `DataPassthroughRequest`
@@ -6701,8 +6462,8 @@ client.ats.scopes.linked_account_scopes_create(
-## Ats DeleteAccount -
client.ats.delete_account.delete() +## Ats RegenerateKey +
client.ats.regenerate_key.create(...)
@@ -6714,7 +6475,7 @@ client.ats.scopes.linked_account_scopes_create(
-Delete a linked account. +Exchange remote keys.
@@ -6735,7 +6496,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.delete_account.delete() +client.ats.regenerate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -6751,6 +6514,14 @@ client.ats.delete_account.delete()
+**name:** `str` β€” The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -6763,8 +6534,8 @@ client.ats.delete_account.delete()
-## Ats Departments -
client.ats.departments.list(...) +## Ats RejectReasons +
client.ats.reject_reasons.list(...)
@@ -6776,7 +6547,7 @@ client.ats.delete_account.delete()
-Returns a list of `Department` objects. +Returns a list of `RejectReason` objects.
@@ -6797,7 +6568,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.departments.list() +client.ats.reject_reasons.list() ``` @@ -6905,7 +6676,7 @@ client.ats.departments.list()
-
client.ats.departments.retrieve(...) +
client.ats.reject_reasons.retrieve(...)
@@ -6917,7 +6688,7 @@ client.ats.departments.list()
-Returns a `Department` object with the given `id`. +Returns a `RejectReason` object with the given `id`.
@@ -6938,7 +6709,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.departments.retrieve( +client.ats.reject_reasons.retrieve( id="id", ) @@ -6984,8 +6755,8 @@ client.ats.departments.retrieve(
-## Ats Eeocs -
client.ats.eeocs.list(...) +## Ats Scorecards +
client.ats.scorecards.list(...)
@@ -6997,7 +6768,7 @@ client.ats.departments.retrieve(
-Returns a list of `EEOC` objects. +Returns a list of `Scorecard` objects.
@@ -7018,7 +6789,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.eeocs.list() +client.ats.scorecards.list() ``` @@ -7034,7 +6805,7 @@ client.ats.eeocs.list()
-**candidate_id:** `typing.Optional[str]` β€” If provided, will only return EEOC info for this candidate. +**application_id:** `typing.Optional[str]` β€” If provided, will only return scorecards for this application.
@@ -7066,7 +6837,7 @@ client.ats.eeocs.list()
-**expand:** `typing.Optional[typing.Literal["candidate"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[ScorecardsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -7098,6 +6869,22 @@ client.ats.eeocs.list()
+**interview_id:** `typing.Optional[str]` β€” If provided, will only return scorecards for this interview. + +
+
+ +
+
+ +**interviewer_id:** `typing.Optional[str]` β€” If provided, will only return scorecards for this interviewer. + +
+
+ +
+
+ **modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -7122,7 +6909,7 @@ client.ats.eeocs.list()
-**remote_fields:** `typing.Optional[EeocsListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` β€” Deprecated. Use show_enum_origins.
@@ -7138,7 +6925,7 @@ client.ats.eeocs.list()
-**show_enum_origins:** `typing.Optional[EeocsListRequestShowEnumOrigins]` β€” 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) +**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` β€” 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)
@@ -7158,7 +6945,7 @@ client.ats.eeocs.list()
-
client.ats.eeocs.retrieve(...) +
client.ats.scorecards.retrieve(...)
@@ -7170,7 +6957,7 @@ client.ats.eeocs.list()
-Returns an `EEOC` object with the given `id`. +Returns a `Scorecard` object with the given `id`.
@@ -7191,7 +6978,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.eeocs.retrieve( +client.ats.scorecards.retrieve( id="id", ) @@ -7217,7 +7004,7 @@ client.ats.eeocs.retrieve(
-**expand:** `typing.Optional[typing.Literal["candidate"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[ScorecardsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -7233,7 +7020,7 @@ client.ats.eeocs.retrieve(
-**remote_fields:** `typing.Optional[EeocsRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` β€” Deprecated. Use show_enum_origins.
@@ -7241,7 +7028,7 @@ client.ats.eeocs.retrieve(
-**show_enum_origins:** `typing.Optional[EeocsRetrieveRequestShowEnumOrigins]` β€” 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) +**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` β€” 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)
@@ -7261,8 +7048,8 @@ client.ats.eeocs.retrieve(
-## Ats FieldMapping -
client.ats.field_mapping.field_mappings_retrieve() +## Ats SyncStatus +
client.ats.sync_status.list(...)
@@ -7274,7 +7061,7 @@ client.ats.eeocs.retrieve(
-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/). +Get syncing status. Possible values: `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).
@@ -7295,7 +7082,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.field_mappings_retrieve() +client.ats.sync_status.list() ``` @@ -7311,6 +7098,22 @@ client.ats.field_mapping.field_mappings_retrieve()
+**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -7323,7 +7126,8 @@ client.ats.field_mapping.field_mappings_retrieve()
-
client.ats.field_mapping.field_mappings_create(...) +## Ats ForceResync +
client.ats.force_resync.sync_status_resync_create()
@@ -7335,7 +7139,7 @@ client.ats.field_mapping.field_mappings_retrieve()
-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. +Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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.
@@ -7356,14 +7160,69 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", +client.ats.force_resync.sync_status_resync_create() + +``` + +
+ + + +#### βš™οΈ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Ats Tags +
client.ats.tags.list(...) +
+
+ +#### πŸ“ Description + +
+
+ +
+
+ +Returns a list of `Tag` objects. +
+
+
+
+ +#### πŸ”Œ Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", ) +client.ats.tags.list() ```
@@ -7379,7 +7238,7 @@ client.ats.field_mapping.field_mappings_create(
-**target_field_name:** `str` β€” The name of the target field you want this remote field to map to. +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -7387,7 +7246,7 @@ client.ats.field_mapping.field_mappings_create(
-**target_field_description:** `str` β€” The description of the target field you want this remote field to map to. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -7395,7 +7254,7 @@ client.ats.field_mapping.field_mappings_create(
-**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. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -7403,7 +7262,7 @@ client.ats.field_mapping.field_mappings_create(
-**remote_method:** `str` β€” The method of the remote endpoint where the remote field is coming from. +**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/).
@@ -7411,7 +7270,7 @@ client.ats.field_mapping.field_mappings_create(
-**remote_url_path:** `str` β€” The path of the remote endpoint where the remote field is coming from. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -7419,7 +7278,39 @@ client.ats.field_mapping.field_mappings_create(
-**common_model_name:** `str` β€” The name of the Common Model that the remote field corresponds to in a given category. +**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. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -7439,7 +7330,8 @@ client.ats.field_mapping.field_mappings_create(
-
client.ats.field_mapping.field_mappings_destroy(...) +## Ats Users +
client.ats.users.list(...)
@@ -7451,7 +7343,7 @@ client.ats.field_mapping.field_mappings_create(
-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. +Returns a list of `RemoteUser` objects.
@@ -7472,9 +7364,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.ats.users.list() ``` @@ -7490,7 +7380,7 @@ client.ats.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -7498,70 +7388,71 @@ client.ats.field_mapping.field_mappings_destroy(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +
-
-
client.ats.field_mapping.field_mappings_partial_update(...)
-#### πŸ“ Description +**email:** `typing.Optional[str]` β€” If provided, will only return remote users with the given email address + +
+
+**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/). + +
+
+
-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. -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + -#### πŸ”Œ Usage -
+**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). + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. + -#### βš™οΈ Parameters -
+**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-**field_mapping_id:** `str` +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -7569,7 +7460,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-**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_fields:** `typing.Optional[typing.Literal["access_role"]]` β€” Deprecated. Use show_enum_origins.
@@ -7577,7 +7468,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` β€” The method of the remote endpoint where the remote field is coming from. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -7585,7 +7476,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` β€” The path of the remote endpoint where the remote field is coming from. +**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` β€” 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)
@@ -7605,7 +7496,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-
client.ats.field_mapping.remote_fields_retrieve(...) +
client.ats.users.retrieve(...)
@@ -7617,7 +7508,7 @@ client.ats.field_mapping.field_mappings_partial_update(
-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/). +Returns a `RemoteUser` object with the given `id`.
@@ -7638,7 +7529,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.remote_fields_retrieve() +client.ats.users.retrieve( + id="id", +) ``` @@ -7654,7 +7547,7 @@ client.ats.field_mapping.remote_fields_retrieve()
-**common_models:** `typing.Optional[str]` β€” A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**id:** `str`
@@ -7662,7 +7555,23 @@ client.ats.field_mapping.remote_fields_retrieve()
-**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. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` β€” Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` β€” 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)
@@ -7682,7 +7591,8 @@ client.ats.field_mapping.remote_fields_retrieve()
-
client.ats.field_mapping.target_fields_retrieve() +## Ats WebhookReceivers +
client.ats.webhook_receivers.list()
@@ -7694,7 +7604,7 @@ client.ats.field_mapping.remote_fields_retrieve()
-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/). +Returns a list of `WebhookReceiver` objects.
@@ -7715,7 +7625,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.field_mapping.target_fields_retrieve() +client.ats.webhook_receivers.list() ``` @@ -7743,8 +7653,7 @@ client.ats.field_mapping.target_fields_retrieve()
-## Ats GenerateKey -
client.ats.generate_key.create(...) +
client.ats.webhook_receivers.create(...)
@@ -7756,7 +7665,7 @@ client.ats.field_mapping.target_fields_retrieve()
-Create a remote key. +Creates a `WebhookReceiver` object with the given values.
@@ -7777,8 +7686,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.generate_key.create( - name="Remote Deployment Key 1", +client.ats.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -7795,7 +7705,23 @@ client.ats.generate_key.create(
-**name:** `str` β€” The name of the remote key +**event:** `str` + +
+
+ +
+
+ +**is_active:** `bool` + +
+
+ +
+
+ +**key:** `typing.Optional[str]`
@@ -7815,8 +7741,8 @@ client.ats.generate_key.create(
-## Ats Interviews -
client.ats.interviews.list(...) +## Crm AccountDetails +
client.crm.account_details.retrieve()
@@ -7828,7 +7754,7 @@ client.ats.generate_key.create(
-Returns a list of `ScheduledInterview` objects. +Get details for a linked account.
@@ -7849,7 +7775,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.list() +client.crm.account_details.retrieve() ``` @@ -7865,135 +7791,71 @@ client.ats.interviews.list()
-**application_id:** `typing.Optional[str]` β€” If provided, will only return interviews for this application. - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. -
-
-
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. -
+
+## Crm AccountToken +
client.crm.account_token.retrieve(...)
-**expand:** `typing.Optional[InterviewsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
+#### πŸ“ Description
-**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. - +Returns the account token for the end user with the provided public token.
- -
-
- -**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). -
-
-
- -**job_id:** `typing.Optional[str]` β€” If provided, wll only return interviews organized for this job. - -
-
+#### πŸ”Œ Usage
-**job_interview_stage_id:** `typing.Optional[str]` β€” If provided, will only return interviews at this stage. - -
-
-
-**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. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.account_token.retrieve( + public_token="public_token", +) -**organizer_id:** `typing.Optional[str]` β€” If provided, will only return interviews organized by this user. - +```
- -
-
- -**page_size:** `typing.Optional[int]` β€” Number of results to return per page. -
-
-
- -**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. - -
-
+#### βš™οΈ Parameters
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
-
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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) +**public_token:** `str`
@@ -8013,7 +7875,8 @@ client.ats.interviews.list()
-
client.ats.interviews.create(...) +## Crm Accounts +
client.crm.accounts.list(...)
@@ -8025,7 +7888,7 @@ client.ats.interviews.list()
-Creates a `ScheduledInterview` object with the given values. +Returns a list of `Account` objects.
@@ -8041,16 +7904,12 @@ Creates a `ScheduledInterview` object with the given values. ```python from merge import Merge -from merge.resources.ats import ScheduledInterviewRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.create( - model=ScheduledInterviewRequest(), - remote_user_id="remote_user_id", -) +client.crm.accounts.list() ``` @@ -8066,7 +7925,7 @@ client.ats.interviews.create(
-**model:** `ScheduledInterviewRequest` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -8074,7 +7933,7 @@ client.ats.interviews.create(
-**remote_user_id:** `str` +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -8082,7 +7941,7 @@ client.ats.interviews.create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -8090,7 +7949,7 @@ client.ats.interviews.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**expand:** `typing.Optional[typing.Literal["owner"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -8098,70 +7957,47 @@ client.ats.interviews.create(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-
client.ats.interviews.retrieve(...)
-#### πŸ“ Description - -
-
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
-Returns a `ScheduledInterview` object with the given `id`. -
-
+**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). +
-#### πŸ”Œ Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.interviews.retrieve( - id="id", -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +
-#### βš™οΈ Parameters -
-
-
- -**id:** `str` +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -8169,7 +8005,7 @@ client.ats.interviews.retrieve(
-**expand:** `typing.Optional[InterviewsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**name:** `typing.Optional[str]` β€” If provided, will only return accounts with this name.
@@ -8177,7 +8013,7 @@ client.ats.interviews.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**owner_id:** `typing.Optional[str]` β€” If provided, will only return accounts with this owner.
@@ -8185,7 +8021,7 @@ client.ats.interviews.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -8193,7 +8029,7 @@ client.ats.interviews.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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) +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -8213,7 +8049,7 @@ client.ats.interviews.retrieve(
-
client.ats.interviews.meta_post_retrieve() +
client.crm.accounts.create(...)
@@ -8225,7 +8061,7 @@ client.ats.interviews.retrieve(
-Returns metadata for `ScheduledInterview` POSTs. +Creates an `Account` object with the given values.
@@ -8241,12 +8077,15 @@ Returns metadata for `ScheduledInterview` POSTs. ```python from merge import Merge +from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.interviews.meta_post_retrieve() +client.crm.accounts.create( + model=AccountRequest(), +) ``` @@ -8262,6 +8101,30 @@ client.ats.interviews.meta_post_retrieve()
+**model:** `AccountRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -8274,8 +8137,7 @@ client.ats.interviews.meta_post_retrieve()
-## Ats Issues -
client.ats.issues.list(...) +
client.crm.accounts.retrieve(...)
@@ -8287,7 +8149,7 @@ client.ats.interviews.meta_post_retrieve()
-Gets all issues for Organization. +Returns an `Account` object with the given `id`.
@@ -8308,7 +8170,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.issues.list() +client.crm.accounts.retrieve( + id="id", +) ``` @@ -8324,7 +8188,7 @@ client.ats.issues.list()
-**account_token:** `typing.Optional[str]` +**id:** `str`
@@ -8332,7 +8196,7 @@ client.ats.issues.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**expand:** `typing.Optional[typing.Literal["owner"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -8340,7 +8204,7 @@ client.ats.issues.list()
-**end_date:** `typing.Optional[str]` β€” If included, will only include issues whose most recent action occurred before this time +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -8348,7 +8212,7 @@ client.ats.issues.list()
-**end_user_organization_name:** `typing.Optional[str]` +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -8356,55 +8220,72 @@ client.ats.issues.list()
-**first_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was after this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was before this datetime. -
+
+
client.crm.accounts.partial_update(...)
-**include_muted:** `typing.Optional[str]` β€” If true, will include muted issues - -
-
+#### πŸ“ Description
-**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. - +Updates an `Account` object with the given `id`. +
+
+#### πŸ”Œ Usage +
-**last_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was before this datetime. - +
+
+ +```python +from merge import Merge +from merge.resources.crm import PatchedAccountRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.accounts.partial_update( + id="id", + model=PatchedAccountRequest(), +) + +``` +
+
+#### βš™οΈ Parameters +
-**linked_account_id:** `typing.Optional[str]` β€” If provided, will only include issues pertaining to the linked account passed in. +
+
+ +**id:** `str`
@@ -8412,7 +8293,7 @@ client.ats.issues.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**model:** `PatchedAccountRequest`
@@ -8420,7 +8301,7 @@ client.ats.issues.list()
-**start_date:** `typing.Optional[str]` β€” If included, will only include issues whose most recent action occurred after this time +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -8428,12 +8309,7 @@ client.ats.issues.list()
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -- `ONGOING` - ONGOING -- `RESOLVED` - RESOLVED +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -8453,7 +8329,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.ats.issues.retrieve(...) +
client.crm.accounts.meta_patch_retrieve(...)
@@ -8465,7 +8341,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns metadata for `CRMAccount` PATCHs.
@@ -8486,7 +8362,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.issues.retrieve( +client.crm.accounts.meta_patch_retrieve( id="id", ) @@ -8524,8 +8400,7 @@ client.ats.issues.retrieve(
-## Ats JobInterviewStages -
client.ats.job_interview_stages.list(...) +
client.crm.accounts.meta_post_retrieve()
@@ -8537,7 +8412,7 @@ client.ats.issues.retrieve(
-Returns a list of `JobInterviewStage` objects. +Returns metadata for `CRMAccount` POSTs.
@@ -8558,7 +8433,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_interview_stages.list() +client.crm.accounts.meta_post_retrieve() ``` @@ -8574,47 +8449,68 @@ client.ats.job_interview_stages.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. -
+
+
client.crm.accounts.remote_field_classes_list(...)
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. - -
-
+#### πŸ“ Description
-**expand:** `typing.Optional[typing.Literal["job"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +
+
+ +Returns a list of `RemoteFieldClass` objects.
+
+
+ +#### πŸ”Œ Usage
-**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/). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.accounts.remote_field_classes_list() + +``` +
+
+#### βš™οΈ Parameters +
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +
+
+ +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -8622,7 +8518,7 @@ client.ats.job_interview_stages.list()
-**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). +**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/).
@@ -8630,7 +8526,7 @@ client.ats.job_interview_stages.list()
-**job_id:** `typing.Optional[str]` β€” If provided, will only return interview stages for this job. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -8638,7 +8534,7 @@ client.ats.job_interview_stages.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -8646,7 +8542,7 @@ client.ats.job_interview_stages.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**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).
@@ -8654,7 +8550,7 @@ client.ats.job_interview_stages.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value
@@ -8662,7 +8558,7 @@ client.ats.job_interview_stages.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -8682,7 +8578,8 @@ client.ats.job_interview_stages.list()
-
client.ats.job_interview_stages.retrieve(...) +## Crm AsyncPassthrough +
client.crm.async_passthrough.create(...)
@@ -8694,7 +8591,7 @@ client.ats.job_interview_stages.list()
-Returns a `JobInterviewStage` object with the given `id`. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -8710,13 +8607,17 @@ Returns a `JobInterviewStage` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_interview_stages.retrieve( - id="id", +client.crm.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -8733,23 +8634,7 @@ client.ats.job_interview_stages.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["job"]]` β€” 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. +**request:** `DataPassthroughRequest`
@@ -8769,8 +8654,7 @@ client.ats.job_interview_stages.retrieve(
-## Ats JobPostings -
client.ats.job_postings.list(...) +
client.crm.async_passthrough.retrieve(...)
@@ -8782,7 +8666,7 @@ client.ats.job_interview_stages.retrieve(
-Returns a list of `JobPosting` objects. +Retrieves data from earlier async-passthrough POST request
@@ -8803,7 +8687,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_postings.list() +client.crm.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) ``` @@ -8819,7 +8705,7 @@ client.ats.job_postings.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**async_passthrough_receipt_id:** `str`
@@ -8827,47 +8713,69 @@ client.ats.job_postings.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. -
+
+## Crm AuditTrail +
client.crm.audit_trail.list(...)
-**expand:** `typing.Optional[typing.Literal["job"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
+#### πŸ“ Description
-**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/). - +
+
+ +Gets a list of audit trail events. +
+
+#### πŸ”Œ Usage +
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.audit_trail.list() + +``` +
+
+#### βš™οΈ Parameters +
-**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). +
+
+ +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -8875,7 +8783,7 @@ client.ats.job_postings.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**end_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred before this time
@@ -8883,7 +8791,7 @@ client.ats.job_postings.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**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`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_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`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -8899,7 +8807,7 @@ client.ats.job_postings.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**start_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred after this time
@@ -8907,15 +8815,7 @@ client.ats.job_postings.list()
-**status:** `typing.Optional[JobPostingsListRequestStatus]` - -If provided, will only return Job Postings with this status. Options: ('PUBLISHED', 'CLOSED', 'DRAFT', 'INTERNAL', 'PENDING') - -- `PUBLISHED` - PUBLISHED -- `CLOSED` - CLOSED -- `DRAFT` - DRAFT -- `INTERNAL` - INTERNAL -- `PENDING` - PENDING +**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.
@@ -8935,7 +8835,8 @@ If provided, will only return Job Postings with this status. Options: ('PUBLISHE
-
client.ats.job_postings.retrieve(...) +## Crm AvailableActions +
client.crm.available_actions.retrieve()
@@ -8947,7 +8848,7 @@ If provided, will only return Job Postings with this status. Options: ('PUBLISHE
-Returns a `JobPosting` object with the given `id`. +Returns a list of models and actions available for an account.
@@ -8968,9 +8869,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.job_postings.retrieve( - id="id", -) +client.crm.available_actions.retrieve() ``` @@ -8986,30 +8885,6 @@ client.ats.job_postings.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["job"]]` β€” 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. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -9022,8 +8897,8 @@ client.ats.job_postings.retrieve(
-## Ats Jobs -
client.ats.jobs.list(...) +## Crm Contacts +
client.crm.contacts.list(...)
@@ -9035,7 +8910,7 @@ client.ats.job_postings.retrieve(
-Returns a list of `Job` objects. +Returns a list of `Contact` objects.
@@ -9056,7 +8931,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.jobs.list() +client.crm.contacts.list() ``` @@ -9072,7 +8947,7 @@ client.ats.jobs.list()
-**code:** `typing.Optional[str]` β€” If provided, will only return jobs with this code. +**account_id:** `typing.Optional[str]` β€” If provided, will only return contacts with this account.
@@ -9104,7 +8979,15 @@ client.ats.jobs.list()
-**expand:** `typing.Optional[JobsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**email_addresses:** `typing.Optional[str]` β€” If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. + +
+
+ +
+
+ +**expand:** `typing.Optional[ContactsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -9128,6 +9011,14 @@ client.ats.jobs.list()
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **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).
@@ -9152,7 +9043,7 @@ client.ats.jobs.list()
-**offices:** `typing.Optional[str]` β€” If provided, will only return jobs for this office; multiple offices can be separated by commas. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -9160,7 +9051,7 @@ client.ats.jobs.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**phone_numbers:** `typing.Optional[str]` β€” If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -9168,7 +9059,7 @@ client.ats.jobs.list()
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -9176,15 +9067,71 @@ client.ats.jobs.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
+ + + +
+
+ +
client.crm.contacts.create(...) +
+
+ +#### πŸ“ Description
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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) +
+
+ +Creates a `Contact` object with the given values. +
+
+
+
+ +#### πŸ”Œ Usage + +
+
+ +
+
+ +```python +from merge import Merge +from merge.resources.crm import ContactRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.contacts.create( + model=ContactRequest(), +) + +``` +
+
+
+
+ +#### βš™οΈ Parameters + +
+
+ +
+
+ +**model:** `ContactRequest`
@@ -9192,15 +9139,15 @@ client.ats.jobs.list()
-**status:** `typing.Optional[JobsListRequestStatus]` +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. + +
+
-If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING') +
+
-- `OPEN` - OPEN -- `CLOSED` - CLOSED -- `DRAFT` - DRAFT -- `ARCHIVED` - ARCHIVED -- `PENDING` - PENDING +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -9220,7 +9167,7 @@ If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED',
-
client.ats.jobs.retrieve(...) +
client.crm.contacts.retrieve(...)
@@ -9232,7 +9179,7 @@ If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED',
-Returns a `Job` object with the given `id`. +Returns a `Contact` object with the given `id`.
@@ -9253,7 +9200,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.jobs.retrieve( +client.crm.contacts.retrieve( id="id", ) @@ -9279,7 +9226,7 @@ client.ats.jobs.retrieve(
-**expand:** `typing.Optional[JobsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -9295,15 +9242,7 @@ client.ats.jobs.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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) +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -9323,7 +9262,7 @@ client.ats.jobs.retrieve(
-
client.ats.jobs.screening_questions_list(...) +
client.crm.contacts.partial_update(...)
@@ -9335,7 +9274,7 @@ client.ats.jobs.retrieve(
-Returns a list of `ScreeningQuestion` objects. +Updates a `Contact` object with the given `id`.
@@ -9351,13 +9290,15 @@ Returns a list of `ScreeningQuestion` objects. ```python from merge import Merge +from merge.resources.crm import PatchedContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.jobs.screening_questions_list( - job_id="job_id", +client.crm.contacts.partial_update( + id="id", + model=PatchedContactRequest(), ) ``` @@ -9374,31 +9315,7 @@ client.ats.jobs.screening_questions_list(
-**job_id:** `str` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` β€” The pagination cursor value. - -
-
- -
-
- -**expand:** `typing.Optional[JobsScreeningQuestionsListRequestExpand]` β€” 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/). +**id:** `str`
@@ -9406,7 +9323,7 @@ client.ats.jobs.screening_questions_list(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**model:** `PatchedContactRequest`
@@ -9414,7 +9331,7 @@ client.ats.jobs.screening_questions_list(
-**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). +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -9422,7 +9339,7 @@ client.ats.jobs.screening_questions_list(
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -9442,8 +9359,7 @@ client.ats.jobs.screening_questions_list(
-## Ats LinkToken -
client.ats.link_token.create(...) +
client.crm.contacts.ignore_create(...)
@@ -9455,7 +9371,7 @@ client.ats.jobs.screening_questions_list(
-Creates a link token to be used when linking a new end user. +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
@@ -9471,17 +9387,17 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.ats import CategoriesEnum +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.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], +client.crm.contacts.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), ) ``` @@ -9498,7 +9414,7 @@ client.ats.link_token.create(
-**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. +**model_id:** `str`
@@ -9506,7 +9422,7 @@ client.ats.link_token.create(
-**end_user_organization_name:** `str` β€” Your end user's organization. +**request:** `IgnoreCommonModelRequest`
@@ -9514,91 +9430,70 @@ client.ats.link_token.create(
-**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. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**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/. -
+
+
client.crm.contacts.meta_patch_retrieve(...)
-**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. - -
-
+#### πŸ“ Description
-**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. - +Returns metadata for `CRMContact` PATCHs.
- -
-
- -**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. -
+#### πŸ”Œ Usage +
-**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[LanguageEnum]` +```python +from merge import Merge -The following subset of IETF language tags can be used to configure localization. +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.contacts.meta_patch_retrieve( + id="id", +) -* `en` - en -* `de` - de - +``` +
+
+#### βš™οΈ Parameters +
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β€” A JSON object containing integration-specific configuration options. +
+
+ +**id:** `str`
@@ -9618,8 +9513,7 @@ The following subset of IETF language tags can be used to configure localization
-## Ats LinkedAccounts -
client.ats.linked_accounts.list(...) +
client.crm.contacts.meta_post_retrieve()
@@ -9631,7 +9525,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns metadata for `CRMContact` POSTs.
@@ -9652,7 +9546,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.linked_accounts.list() +client.crm.contacts.meta_post_retrieve() ``` @@ -9668,65 +9562,68 @@ client.ats.linked_accounts.list()
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` - -Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` - -- `hris` - hris -- `ats` - ats -- `accounting` - accounting -- `ticketing` - ticketing -- `crm` - crm -- `mktg` - mktg -- `filestorage` - filestorage +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. -
+
+
client.crm.contacts.remote_field_classes_list(...)
-**end_user_email_address:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given email address. - -
-
+#### πŸ“ Description
-**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. - +Returns a list of `RemoteFieldClass` objects. +
+
+#### πŸ”Œ Usage +
-**end_user_origin_ids:** `typing.Optional[str]` β€” Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.contacts.remote_field_classes_list() + +```
+
+
+ +#### βš™οΈ Parameters
-**id:** `typing.Optional[str]` +
+
+ +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -9734,7 +9631,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**ids:** `typing.Optional[str]` β€” Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**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/).
@@ -9742,7 +9639,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**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. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -9750,7 +9647,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given integration name. +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -9758,7 +9655,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**is_test_account:** `typing.Optional[str]` β€” If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**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).
@@ -9766,7 +9663,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value
@@ -9774,7 +9671,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` β€” Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -9794,8 +9691,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Ats Offers -
client.ats.offers.list(...) +## Crm CustomObjectClasses +
client.crm.custom_object_classes.list(...)
@@ -9807,7 +9704,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Offer` objects. +Returns a list of `CustomObjectClass` objects.
@@ -9828,7 +9725,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offers.list() +client.crm.custom_object_classes.list() ``` @@ -9844,14 +9741,6 @@ client.ats.offers.list()
-**application_id:** `typing.Optional[str]` β€” If provided, will only return offers for this application. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -9868,14 +9757,6 @@ client.ats.offers.list()
-**creator_id:** `typing.Optional[str]` β€” If provided, will only return offers created by this user. - -
-
- -
-
- **cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -9884,7 +9765,7 @@ client.ats.offers.list()
-**expand:** `typing.Optional[OffersListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["fields"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -9940,14 +9821,6 @@ client.ats.offers.list()
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -9956,14 +9829,6 @@ client.ats.offers.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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.
@@ -9976,7 +9841,7 @@ client.ats.offers.list()
-
client.ats.offers.retrieve(...) +
client.crm.custom_object_classes.retrieve(...)
@@ -9988,7 +9853,7 @@ client.ats.offers.list()
-Returns an `Offer` object with the given `id`. +Returns a `CustomObjectClass` object with the given `id`.
@@ -10009,7 +9874,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offers.retrieve( +client.crm.custom_object_classes.retrieve( id="id", ) @@ -10035,7 +9900,7 @@ client.ats.offers.retrieve(
-**expand:** `typing.Optional[OffersRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["fields"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10051,22 +9916,6 @@ client.ats.offers.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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.
@@ -10079,8 +9928,8 @@ client.ats.offers.retrieve(
-## Ats Offices -
client.ats.offices.list(...) +## Crm AssociationTypes +
client.crm.association_types.custom_object_classes_association_types_list(...)
@@ -10092,7 +9941,7 @@ client.ats.offers.retrieve(
-Returns a list of `Office` objects. +Returns a list of `AssociationType` objects.
@@ -10113,7 +9962,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offices.list() +client.crm.association_types.custom_object_classes_association_types_list( + custom_object_class_id="custom_object_class_id", +) ``` @@ -10129,6 +9980,14 @@ client.ats.offices.list()
+**custom_object_class_id:** `str` + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -10153,6 +10012,14 @@ client.ats.offices.list()
+**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` β€” 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/).
@@ -10221,7 +10088,7 @@ client.ats.offices.list()
-
client.ats.offices.retrieve(...) +
client.crm.association_types.custom_object_classes_association_types_create(...)
@@ -10233,7 +10100,7 @@ client.ats.offices.list()
-Returns an `Office` object with the given `id`. +Creates an `AssociationType` object with the given values.
@@ -10249,13 +10116,31 @@ Returns an `Office` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import ( + AssociationTypeRequestRequest, + ObjectClassDescriptionRequest, + OriginTypeEnum, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.offices.retrieve( - id="id", +client.crm.association_types.custom_object_classes_association_types_create( + custom_object_class_id="custom_object_class_id", + model=AssociationTypeRequestRequest( + source_object_class=ObjectClassDescriptionRequest( + id="id", + origin_type=OriginTypeEnum.CUSTOM_OBJECT, + ), + target_object_classes=[ + ObjectClassDescriptionRequest( + id="id", + origin_type=OriginTypeEnum.CUSTOM_OBJECT, + ) + ], + remote_key_name="remote_key_name", + ), ) ``` @@ -10272,7 +10157,7 @@ client.ats.offices.retrieve(
-**id:** `str` +**custom_object_class_id:** `str`
@@ -10280,7 +10165,23 @@ client.ats.offices.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**model:** `AssociationTypeRequestRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -10300,8 +10201,7 @@ client.ats.offices.retrieve(
-## Ats Passthrough -
client.ats.passthrough.create(...) +
client.crm.association_types.custom_object_classes_association_types_retrieve(...)
@@ -10313,7 +10213,7 @@ client.ats.offices.retrieve(
-Pull data from an endpoint not currently supported by Merge. +Returns an `AssociationType` object with the given `id`.
@@ -10329,17 +10229,14 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.ats import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.crm.association_types.custom_object_classes_association_types_retrieve( + custom_object_class_id="custom_object_class_id", + id="id", ) ``` @@ -10356,7 +10253,31 @@ client.ats.passthrough.create(
-**request:** `DataPassthroughRequest` +**custom_object_class_id:** `str` + +
+
+ +
+
+ +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` β€” 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.
@@ -10376,8 +10297,7 @@ client.ats.passthrough.create(
-## Ats RegenerateKey -
client.ats.regenerate_key.create(...) +
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
@@ -10389,7 +10309,7 @@ client.ats.passthrough.create(
-Exchange remote keys. +Returns metadata for `CRMAssociationType` POSTs.
@@ -10410,8 +10330,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.regenerate_key.create( - name="Remote Deployment Key 1", +client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", ) ``` @@ -10428,7 +10348,7 @@ client.ats.regenerate_key.create(
-**name:** `str` β€” The name of the remote key +**custom_object_class_id:** `str`
@@ -10448,8 +10368,8 @@ client.ats.regenerate_key.create(
-## Ats RejectReasons -
client.ats.reject_reasons.list(...) +## Crm CustomObjects +
client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
@@ -10461,7 +10381,7 @@ client.ats.regenerate_key.create(
-Returns a list of `RejectReason` objects. +Returns a list of `CustomObject` objects.
@@ -10482,7 +10402,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.reject_reasons.list() +client.crm.custom_objects.custom_object_classes_custom_objects_list( + custom_object_class_id="custom_object_class_id", +) ``` @@ -10498,6 +10420,14 @@ client.ats.reject_reasons.list()
+**custom_object_class_id:** `str` + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -10538,6 +10468,14 @@ client.ats.reject_reasons.list()
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **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).
@@ -10590,7 +10528,7 @@ client.ats.reject_reasons.list()
-
client.ats.reject_reasons.retrieve(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
@@ -10602,7 +10540,7 @@ client.ats.reject_reasons.list()
-Returns a `RejectReason` object with the given `id`. +Creates a `CustomObject` object with the given values.
@@ -10618,12 +10556,112 @@ Returns a `RejectReason` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import CustomObjectRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.reject_reasons.retrieve( +client.crm.custom_objects.custom_object_classes_custom_objects_create( + custom_object_class_id="custom_object_class_id", + model=CustomObjectRequest( + fields={"test_field": "hello"}, + ), +) + +``` + +
+ + + +#### βš™οΈ Parameters + +
+
+ +
+
+ +**custom_object_class_id:** `str` + +
+
+ +
+
+ +**model:** `CustomObjectRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. + +
+
+
+
+ + + + +
+ +
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...) +
+
+ +#### πŸ“ Description + +
+
+ +
+
+ +Returns a `CustomObject` object with the given `id`. +
+
+
+
+ +#### πŸ”Œ Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( + custom_object_class_id="custom_object_class_id", id="id", ) @@ -10641,6 +10679,14 @@ client.ats.reject_reasons.retrieve(
+**custom_object_class_id:** `str` + +
+
+ +
+
+ **id:** `str`
@@ -10657,6 +10703,14 @@ client.ats.reject_reasons.retrieve(
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -10669,8 +10723,7 @@ client.ats.reject_reasons.retrieve(
-## Ats Scorecards -
client.ats.scorecards.list(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
@@ -10682,7 +10735,7 @@ client.ats.reject_reasons.retrieve(
-Returns a list of `Scorecard` objects. +Returns metadata for `CRMCustomObject` POSTs.
@@ -10703,7 +10756,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scorecards.list() +client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", +) ``` @@ -10719,7 +10774,7 @@ client.ats.scorecards.list()
-**application_id:** `typing.Optional[str]` β€” If provided, will only return scorecards for this application. +**custom_object_class_id:** `str`
@@ -10727,31 +10782,68 @@ client.ats.scorecards.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
+ + + +
+ +
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. - +#### πŸ“ Description + +
+
+ +
+
+ +Returns a list of `RemoteFieldClass` objects. +
+
+#### πŸ”Œ Usage +
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() + +``` +
+
+#### βš™οΈ Parameters +
-**expand:** `typing.Optional[ScorecardsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
+
+ +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -10775,6 +10867,14 @@ client.ats.scorecards.list()
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **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).
@@ -10783,7 +10883,7 @@ client.ats.scorecards.list()
-**interview_id:** `typing.Optional[str]` β€” If provided, will only return scorecards for this interview. +**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value
@@ -10791,7 +10891,7 @@ client.ats.scorecards.list()
-**interviewer_id:** `typing.Optional[str]` β€” If provided, will only return scorecards for this interviewer. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -10799,15 +10899,72 @@ client.ats.scorecards.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +
+
+
+
+ + +
+
+
+ +## Crm Associations +
client.crm.associations.custom_object_classes_custom_objects_associations_list(...) +
+
+ +#### πŸ“ Description + +
+
+ +
+
+ +Returns a list of `Association` objects. +
+
+#### πŸ”Œ Usage +
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.associations.custom_object_classes_custom_objects_associations_list( + custom_object_class_id="custom_object_class_id", + object_id="object_id", +) + +``` +
+
+
+
+ +#### βš™οΈ Parameters + +
+
+ +
+
+ +**custom_object_class_id:** `str`
@@ -10815,7 +10972,7 @@ client.ats.scorecards.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**object_id:** `str`
@@ -10823,7 +10980,7 @@ client.ats.scorecards.list()
-**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` β€” Deprecated. Use show_enum_origins. +**association_type_id:** `typing.Optional[str]` β€” If provided, will only return opportunities with this association_type.
@@ -10831,7 +10988,7 @@ client.ats.scorecards.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -10839,7 +10996,79 @@ client.ats.scorecards.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` β€” 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) +**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.Literal["association_type"]]` β€” 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. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -10859,7 +11088,7 @@ client.ats.scorecards.list()
-
client.ats.scorecards.retrieve(...) +
client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
@@ -10871,7 +11100,7 @@ client.ats.scorecards.list()
-Returns a `Scorecard` object with the given `id`. +Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -10892,8 +11121,12 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.scorecards.retrieve( - id="id", +client.crm.associations.custom_object_classes_custom_objects_associations_update( + association_type_id="association_type_id", + source_class_id="source_class_id", + source_object_id="source_object_id", + target_class_id="target_class_id", + target_object_id="target_object_id", ) ``` @@ -10910,7 +11143,7 @@ client.ats.scorecards.retrieve(
-**id:** `str` +**association_type_id:** `str`
@@ -10918,7 +11151,7 @@ client.ats.scorecards.retrieve(
-**expand:** `typing.Optional[ScorecardsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**source_class_id:** `str`
@@ -10926,7 +11159,7 @@ client.ats.scorecards.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**source_object_id:** `str`
@@ -10934,7 +11167,7 @@ client.ats.scorecards.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` β€” Deprecated. Use show_enum_origins. +**target_class_id:** `str`
@@ -10942,7 +11175,23 @@ client.ats.scorecards.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` β€” 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) +**target_object_id:** `str` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -10962,8 +11211,8 @@ client.ats.scorecards.retrieve(
-## Ats SyncStatus -
client.ats.sync_status.list(...) +## Crm Scopes +
client.crm.scopes.default_scopes_retrieve()
@@ -10975,7 +11224,7 @@ client.ats.scorecards.retrieve(
-Get syncing status. Possible values: `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). +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).
@@ -10996,7 +11245,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.sync_status.list() +client.crm.scopes.default_scopes_retrieve() ``` @@ -11012,22 +11261,6 @@ client.ats.sync_status.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -11040,8 +11273,7 @@ client.ats.sync_status.list()
-## Ats ForceResync -
client.ats.force_resync.sync_status_resync_create() +
client.crm.scopes.linked_account_scopes_retrieve()
@@ -11053,7 +11285,7 @@ client.ats.sync_status.list()
-Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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. +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).
@@ -11074,7 +11306,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.force_resync.sync_status_resync_create() +client.crm.scopes.linked_account_scopes_retrieve() ``` @@ -11102,8 +11334,7 @@ client.ats.force_resync.sync_status_resync_create()
-## Ats Tags -
client.ats.tags.list(...) +
client.crm.scopes.linked_account_scopes_create(...)
@@ -11115,7 +11346,7 @@ client.ats.force_resync.sync_status_resync_create()
-Returns a list of `Tag` objects. +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)
@@ -11131,12 +11362,38 @@ Returns a list of `Tag` objects. ```python from merge import Merge +from merge.resources.crm import ( + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.tags.list() +client.crm.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], +) ``` @@ -11152,7 +11409,7 @@ client.ats.tags.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β€” The common models you want to update the scopes for
@@ -11160,75 +11417,65 @@ client.ats.tags.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` β€” The pagination cursor value. -
-
-
-**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/). -
+
+## Crm DeleteAccount +
client.crm.delete_account.delete()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### πŸ“ Description
-**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. - +Delete a linked account. +
+
+#### πŸ”Œ Usage +
-**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. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.delete_account.delete() + +``` +
+
+#### βš™οΈ Parameters +
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
-
@@ -11244,8 +11491,8 @@ client.ats.tags.list()
-## Ats Users -
client.ats.users.list(...) +## Crm EngagementTypes +
client.crm.engagement_types.list(...)
@@ -11257,7 +11504,7 @@ client.ats.tags.list()
-Returns a list of `RemoteUser` objects. +Returns a list of `EngagementType` objects.
@@ -11278,7 +11525,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.users.list() +client.crm.engagement_types.list() ``` @@ -11318,7 +11565,7 @@ client.ats.users.list()
-**email:** `typing.Optional[str]` β€” If provided, will only return remote users with the given email address +**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/).
@@ -11326,7 +11573,7 @@ client.ats.users.list()
-**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.
@@ -11334,7 +11581,7 @@ client.ats.users.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -11374,14 +11621,6 @@ client.ats.users.list()
-**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` β€” Deprecated. Use show_enum_origins. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -11390,14 +11629,6 @@ client.ats.users.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` β€” 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.
@@ -11410,7 +11641,7 @@ client.ats.users.list()
-
client.ats.users.retrieve(...) +
client.crm.engagement_types.retrieve(...)
@@ -11422,7 +11653,7 @@ client.ats.users.list()
-Returns a `RemoteUser` object with the given `id`. +Returns an `EngagementType` object with the given `id`.
@@ -11443,7 +11674,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.users.retrieve( +client.crm.engagement_types.retrieve( id="id", ) @@ -11477,15 +11708,7 @@ client.ats.users.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` β€” Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` β€” 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) +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -11505,8 +11728,7 @@ client.ats.users.retrieve(
-## Ats WebhookReceivers -
client.ats.webhook_receivers.list() +
client.crm.engagement_types.remote_field_classes_list(...)
@@ -11518,7 +11740,7 @@ client.ats.users.retrieve(
-Returns a list of `WebhookReceiver` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -11539,7 +11761,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ats.webhook_receivers.list() +client.crm.engagement_types.remote_field_classes_list() ``` @@ -11555,71 +11777,39 @@ client.ats.webhook_receivers.list()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
- -
- - - - -
-
client.ats.webhook_receivers.create(...)
-#### πŸ“ Description - -
-
+**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/). + +
+
-Creates a `WebhookReceiver` object with the given values. -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.webhook_receivers.create( - event="event", - is_active=True, -) - -``` -
-
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### βš™οΈ Parameters -
-
-
- -**event:** `str` +**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).
@@ -11627,7 +11817,7 @@ client.ats.webhook_receivers.create(
-**is_active:** `bool` +**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value
@@ -11635,7 +11825,7 @@ client.ats.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -11655,8 +11845,8 @@ client.ats.webhook_receivers.create(
-## Crm AccountDetails -
client.crm.account_details.retrieve() +## Crm Engagements +
client.crm.engagements.list(...)
@@ -11668,7 +11858,7 @@ client.ats.webhook_receivers.create(
-Get details for a linked account. +Returns a list of `Engagement` objects.
@@ -11689,7 +11879,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_details.retrieve() +client.crm.engagements.list() ``` @@ -11705,71 +11895,31 @@ client.crm.account_details.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
- -
- - - - -
- -## Crm AccountToken -
client.crm.account_token.retrieve(...) -
-
- -#### πŸ“ Description
-
-
- -Returns the account token for the end user with the provided public token. -
-
+**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.account_token.retrieve( - public_token="public_token", -) - -``` -
-
+**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +
-#### βš™οΈ Parameters - -
-
-
-**public_token:** `str` +**expand:** `typing.Optional[EngagementsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -11777,69 +11927,39 @@ client.crm.account_token.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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/).
-
-
- -
-
-
- -## Crm Accounts -
client.crm.accounts.list(...)
-#### πŸ“ Description - -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Returns a list of `Account` objects. -
-
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.accounts.list() - -``` -
-
+**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). +
-#### βš™οΈ Parameters -
-
-
- -**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -11847,7 +11967,7 @@ client.crm.accounts.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -11855,7 +11975,7 @@ client.crm.accounts.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -11863,7 +11983,7 @@ client.crm.accounts.list()
-**expand:** `typing.Optional[typing.Literal["owner"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -11871,7 +11991,7 @@ client.crm.accounts.list()
-**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/). +**started_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return engagements started after this datetime.
@@ -11879,7 +11999,7 @@ client.crm.accounts.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**started_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return engagements started before this datetime.
@@ -11887,47 +12007,71 @@ client.crm.accounts.list()
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+
+
-
-
-**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). -
+
+
client.crm.engagements.create(...)
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. - -
-
+#### πŸ“ Description
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. - +
+
+ +Creates an `Engagement` object with the given values. +
+
+#### πŸ”Œ Usage +
-**name:** `typing.Optional[str]` β€” If provided, will only return accounts with this name. - +
+
+ +```python +from merge import Merge +from merge.resources.crm import EngagementRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.engagements.create( + model=EngagementRequest(), +) + +``` +
+
+#### βš™οΈ Parameters +
-**owner_id:** `typing.Optional[str]` β€” If provided, will only return accounts with this owner. +
+
+ +**model:** `EngagementRequest`
@@ -11935,7 +12079,7 @@ client.crm.accounts.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -11943,7 +12087,7 @@ client.crm.accounts.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -11963,7 +12107,7 @@ client.crm.accounts.list()
-
client.crm.accounts.create(...) +
client.crm.engagements.retrieve(...)
@@ -11975,7 +12119,7 @@ client.crm.accounts.list()
-Creates an `Account` object with the given values. +Returns an `Engagement` object with the given `id`.
@@ -11991,14 +12135,13 @@ Creates an `Account` object with the given values. ```python from merge import Merge -from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.create( - model=AccountRequest(), +client.crm.engagements.retrieve( + id="id", ) ``` @@ -12015,7 +12158,7 @@ client.crm.accounts.create(
-**model:** `AccountRequest` +**id:** `str`
@@ -12023,7 +12166,7 @@ client.crm.accounts.create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -12031,7 +12174,15 @@ client.crm.accounts.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -12051,7 +12202,7 @@ client.crm.accounts.create(
-
client.crm.accounts.retrieve(...) +
client.crm.engagements.partial_update(...)
@@ -12063,7 +12214,7 @@ client.crm.accounts.create(
-Returns an `Account` object with the given `id`. +Updates an `Engagement` object with the given `id`.
@@ -12079,13 +12230,15 @@ Returns an `Account` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import PatchedEngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.retrieve( +client.crm.engagements.partial_update( id="id", + model=PatchedEngagementRequest(), ) ``` @@ -12110,7 +12263,7 @@ client.crm.accounts.retrieve(
-**expand:** `typing.Optional[typing.Literal["owner"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**model:** `PatchedEngagementRequest`
@@ -12118,7 +12271,7 @@ client.crm.accounts.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -12126,7 +12279,7 @@ client.crm.accounts.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -12146,7 +12299,7 @@ client.crm.accounts.retrieve(
-
client.crm.accounts.partial_update(...) +
client.crm.engagements.meta_patch_retrieve(...)
@@ -12158,7 +12311,7 @@ client.crm.accounts.retrieve(
-Updates an `Account` object with the given `id`. +Returns metadata for `Engagement` PATCHs.
@@ -12174,15 +12327,13 @@ Updates an `Account` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedAccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.partial_update( +client.crm.engagements.meta_patch_retrieve( id="id", - model=PatchedAccountRequest(), ) ``` @@ -12207,27 +12358,64 @@ client.crm.accounts.partial_update(
-**model:** `PatchedAccountRequest` +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
+ + + + +
+
client.crm.engagements.meta_post_retrieve()
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. - +#### πŸ“ Description + +
+
+ +
+
+ +Returns metadata for `Engagement` POSTs.
+
+
+ +#### πŸ”Œ Usage
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.engagements.meta_post_retrieve() + +``` +
+
+#### βš™οΈ Parameters + +
+
+
@@ -12243,7 +12431,7 @@ client.crm.accounts.partial_update(
-
client.crm.accounts.meta_patch_retrieve(...) +
client.crm.engagements.remote_field_classes_list(...)
@@ -12255,7 +12443,7 @@ client.crm.accounts.partial_update(
-Returns metadata for `CRMAccount` PATCHs. +Returns a list of `RemoteFieldClass` objects.
@@ -12276,9 +12464,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_patch_retrieve( - id="id", -) +client.crm.engagements.remote_field_classes_list() ``` @@ -12294,7 +12480,55 @@ client.crm.accounts.meta_patch_retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+ +
+
+ +**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_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ +**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). + +
+
+ +
+
+ +**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -12314,7 +12548,8 @@ client.crm.accounts.meta_patch_retrieve(
-
client.crm.accounts.meta_post_retrieve() +## Crm FieldMapping +
client.crm.field_mapping.field_mappings_retrieve()
@@ -12326,7 +12561,7 @@ client.crm.accounts.meta_patch_retrieve(
-Returns metadata for `CRMAccount` POSTs. +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/).
@@ -12347,7 +12582,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_post_retrieve() +client.crm.field_mapping.field_mappings_retrieve() ``` @@ -12375,7 +12610,7 @@ client.crm.accounts.meta_post_retrieve()
-
client.crm.accounts.remote_field_classes_list(...) +
client.crm.field_mapping.field_mappings_create(...)
@@ -12387,7 +12622,7 @@ client.crm.accounts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +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.
@@ -12408,7 +12643,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.remote_field_classes_list() +client.crm.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) ``` @@ -12424,15 +12666,7 @@ client.crm.accounts.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. - -
-
- -
-
- -**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/). +**target_field_name:** `str` β€” The name of the target field you want this remote field to map to.
@@ -12440,7 +12674,7 @@ client.crm.accounts.remote_field_classes_list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**target_field_description:** `str` β€” The description of the target field you want this remote field to map to.
@@ -12448,7 +12682,7 @@ client.crm.accounts.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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.
@@ -12456,7 +12690,7 @@ client.crm.accounts.remote_field_classes_list()
-**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_method:** `str` β€” The method of the remote endpoint where the remote field is coming from.
@@ -12464,7 +12698,7 @@ client.crm.accounts.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value +**remote_url_path:** `str` β€” The path of the remote endpoint where the remote field is coming from.
@@ -12472,7 +12706,7 @@ client.crm.accounts.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**common_model_name:** `str` β€” The name of the Common Model that the remote field corresponds to in a given category.
@@ -12492,8 +12726,7 @@ client.crm.accounts.remote_field_classes_list()
-## Crm AsyncPassthrough -
client.crm.async_passthrough.create(...) +
client.crm.field_mapping.field_mappings_destroy(...)
@@ -12505,7 +12738,7 @@ client.crm.accounts.remote_field_classes_list()
-Asynchronously pull data from an endpoint not currently supported by Merge. +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.
@@ -12521,17 +12754,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.crm.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -12548,7 +12777,7 @@ client.crm.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**field_mapping_id:** `str`
@@ -12568,7 +12797,7 @@ client.crm.async_passthrough.create(
-
client.crm.async_passthrough.retrieve(...) +
client.crm.field_mapping.field_mappings_partial_update(...)
@@ -12580,7 +12809,7 @@ client.crm.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +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.
@@ -12601,8 +12830,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", +client.crm.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -12619,7 +12848,31 @@ client.crm.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` +**field_mapping_id:** `str` + +
+
+ +
+
+ +**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.
@@ -12639,8 +12892,7 @@ client.crm.async_passthrough.retrieve(
-## Crm AuditTrail -
client.crm.audit_trail.list(...) +
client.crm.field_mapping.remote_fields_retrieve(...)
@@ -12652,7 +12904,7 @@ client.crm.async_passthrough.retrieve(
-Gets a list of audit trail events. +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/).
@@ -12673,7 +12925,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.audit_trail.list() +client.crm.field_mapping.remote_fields_retrieve() ``` @@ -12689,7 +12941,7 @@ client.crm.audit_trail.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**common_models:** `typing.Optional[str]` β€” A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -12697,7 +12949,7 @@ client.crm.audit_trail.list()
-**end_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred before this time +**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.
@@ -12705,35 +12957,64 @@ client.crm.audit_trail.list()
-**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`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_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`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. -
+
+
client.crm.field_mapping.target_fields_retrieve()
-**start_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred after this time - +#### πŸ“ 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
-**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. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.field_mapping.target_fields_retrieve() + +``` +
+
+#### βš™οΈ Parameters + +
+
+
@@ -12749,8 +13030,8 @@ client.crm.audit_trail.list()
-## Crm AvailableActions -
client.crm.available_actions.retrieve() +## Crm GenerateKey +
client.crm.generate_key.create(...)
@@ -12762,7 +13043,7 @@ client.crm.audit_trail.list()
-Returns a list of models and actions available for an account. +Create a remote key.
@@ -12783,7 +13064,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.available_actions.retrieve() +client.crm.generate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -12799,6 +13082,14 @@ client.crm.available_actions.retrieve()
+**name:** `str` β€” The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -12811,8 +13102,8 @@ client.crm.available_actions.retrieve()
-## Crm Contacts -
client.crm.contacts.list(...) +## Crm Issues +
client.crm.issues.list(...)
@@ -12824,7 +13115,7 @@ client.crm.available_actions.retrieve()
-Returns a list of `Contact` objects. +Gets all issues for Organization.
@@ -12845,7 +13136,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.list() +client.crm.issues.list() ``` @@ -12861,7 +13152,7 @@ client.crm.contacts.list()
-**account_id:** `typing.Optional[str]` β€” If provided, will only return contacts with this account. +**account_token:** `typing.Optional[str]`
@@ -12869,7 +13160,7 @@ client.crm.contacts.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -12877,7 +13168,7 @@ client.crm.contacts.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**end_date:** `typing.Optional[str]` β€” If included, will only include issues whose most recent action occurred before this time
@@ -12885,7 +13176,7 @@ client.crm.contacts.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**end_user_organization_name:** `typing.Optional[str]`
@@ -12893,7 +13184,7 @@ client.crm.contacts.list()
-**email_addresses:** `typing.Optional[str]` β€” If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. +**first_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was after this datetime.
@@ -12901,7 +13192,7 @@ client.crm.contacts.list()
-**expand:** `typing.Optional[ContactsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**first_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was before this datetime.
@@ -12909,7 +13200,7 @@ client.crm.contacts.list()
-**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_muted:** `typing.Optional[str]` β€” If true, will include muted issues
@@ -12917,7 +13208,7 @@ client.crm.contacts.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**integration_name:** `typing.Optional[str]`
@@ -12925,7 +13216,7 @@ client.crm.contacts.list()
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**last_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was after this datetime.
@@ -12933,7 +13224,7 @@ client.crm.contacts.list()
-**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). +**last_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was before this datetime.
@@ -12941,7 +13232,7 @@ client.crm.contacts.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**linked_account_id:** `typing.Optional[str]` β€” If provided, will only include issues pertaining to the linked account passed in.
@@ -12949,7 +13240,7 @@ client.crm.contacts.list()
-**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.
@@ -12957,7 +13248,7 @@ client.crm.contacts.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**start_date:** `typing.Optional[str]` β€” If included, will only include issues whose most recent action occurred after this time
@@ -12965,15 +13256,12 @@ client.crm.contacts.list()
-**phone_numbers:** `typing.Optional[str]` β€” If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. - -
-
+**status:** `typing.Optional[IssuesListRequestStatus]` -
-
+Status of the issue. Options: ('ONGOING', 'RESOLVED') -**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +- `ONGOING` - ONGOING +- `RESOLVED` - RESOLVED
@@ -12993,7 +13281,7 @@ client.crm.contacts.list()
-
client.crm.contacts.create(...) +
client.crm.issues.retrieve(...)
@@ -13005,7 +13293,7 @@ client.crm.contacts.list()
-Creates a `Contact` object with the given values. +Get a specific issue.
@@ -13021,14 +13309,13 @@ Creates a `Contact` object with the given values. ```python from merge import Merge -from merge.resources.crm import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.create( - model=ContactRequest(), +client.crm.issues.retrieve( + id="id", ) ``` @@ -13045,23 +13332,7 @@ client.crm.contacts.create(
-**model:** `ContactRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**id:** `str`
@@ -13081,7 +13352,8 @@ client.crm.contacts.create(
-
client.crm.contacts.retrieve(...) +## Crm Leads +
client.crm.leads.list(...)
@@ -13093,7 +13365,7 @@ client.crm.contacts.create(
-Returns a `Contact` object with the given `id`. +Returns a list of `Lead` objects.
@@ -13114,9 +13386,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.retrieve( - id="id", -) +client.crm.leads.list() ``` @@ -13132,7 +13402,7 @@ client.crm.contacts.retrieve(
-**id:** `str` +**converted_account_id:** `typing.Optional[str]` β€” If provided, will only return leads with this account.
@@ -13140,7 +13410,55 @@ client.crm.contacts.retrieve(
-**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**converted_contact_id:** `typing.Optional[str]` β€” If provided, will only return leads with this contact. + +
+
+ +
+
+ +**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_addresses:** `typing.Optional[str]` β€” If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. + +
+
+ +
+
+ +**expand:** `typing.Optional[LeadsListRequestExpand]` β€” 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/).
@@ -13164,6 +13482,62 @@ client.crm.contacts.retrieve(
+**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. + +
+
+ +
+
+ +**owner_id:** `typing.Optional[str]` β€” If provided, will only return leads with this owner. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
+ +
+
+ +**phone_numbers:** `typing.Optional[str]` β€” If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -13176,7 +13550,7 @@ client.crm.contacts.retrieve(
-
client.crm.contacts.partial_update(...) +
client.crm.leads.create(...)
@@ -13188,7 +13562,7 @@ client.crm.contacts.retrieve(
-Updates a `Contact` object with the given `id`. +Creates a `Lead` object with the given values.
@@ -13204,15 +13578,14 @@ Updates a `Contact` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedContactRequest +from merge.resources.crm import LeadRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.partial_update( - id="id", - model=PatchedContactRequest(), +client.crm.leads.create( + model=LeadRequest(), ) ``` @@ -13229,15 +13602,7 @@ client.crm.contacts.partial_update(
-**id:** `str` - -
-
- -
-
- -**model:** `PatchedContactRequest` +**model:** `LeadRequest`
@@ -13273,7 +13638,7 @@ client.crm.contacts.partial_update(
-
client.crm.contacts.ignore_create(...) +
client.crm.leads.retrieve(...)
@@ -13285,7 +13650,7 @@ client.crm.contacts.partial_update(
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +Returns a `Lead` object with the given `id`.
@@ -13301,17 +13666,13 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.ignore_create( - model_id="model_id", - request=IgnoreCommonModelRequest( - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, - ), +client.crm.leads.retrieve( + id="id", ) ``` @@ -13328,7 +13689,7 @@ client.crm.contacts.ignore_create(
-**model_id:** `str` +**id:** `str`
@@ -13336,7 +13697,23 @@ client.crm.contacts.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` β€” 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_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -13356,7 +13733,7 @@ client.crm.contacts.ignore_create(
-
client.crm.contacts.meta_patch_retrieve(...) +
client.crm.leads.meta_post_retrieve()
@@ -13368,7 +13745,7 @@ client.crm.contacts.ignore_create(
-Returns metadata for `CRMContact` PATCHs. +Returns metadata for `Lead` POSTs.
@@ -13389,78 +13766,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_patch_retrieve( - id="id", -) - -``` - -
- - - -#### βš™οΈ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. - -
-
-
-
- - - - -
- -
client.crm.contacts.meta_post_retrieve() -
-
- -#### πŸ“ Description - -
-
- -
-
- -Returns metadata for `CRMContact` POSTs. -
-
-
-
- -#### πŸ”Œ Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.contacts.meta_post_retrieve() +client.crm.leads.meta_post_retrieve() ```
@@ -13488,7 +13794,7 @@ client.crm.contacts.meta_post_retrieve()
-
client.crm.contacts.remote_field_classes_list(...) +
client.crm.leads.remote_field_classes_list(...)
@@ -13521,7 +13827,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.remote_field_classes_list() +client.crm.leads.remote_field_classes_list() ```
@@ -13605,8 +13911,8 @@ client.crm.contacts.remote_field_classes_list()
-## Crm CustomObjectClasses -
client.crm.custom_object_classes.list(...) +## Crm LinkToken +
client.crm.link_token.create(...)
@@ -13618,7 +13924,7 @@ client.crm.contacts.remote_field_classes_list()
-Returns a list of `CustomObjectClass` objects. +Creates a link token to be used when linking a new end user.
@@ -13634,12 +13940,18 @@ Returns a list of `CustomObjectClass` objects. ```python from merge import Merge +from merge.resources.crm import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.list() +client.crm.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], +) ``` @@ -13655,7 +13967,7 @@ client.crm.custom_object_classes.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**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.
@@ -13663,7 +13975,7 @@ client.crm.custom_object_classes.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**end_user_organization_name:** `str` β€” Your end user's organization.
@@ -13671,7 +13983,7 @@ client.crm.custom_object_classes.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**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.
@@ -13679,7 +13991,7 @@ client.crm.custom_object_classes.list()
-**expand:** `typing.Optional[typing.Literal["fields"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**categories:** `typing.Sequence[CategoriesEnum]` β€” The integration categories to show in Merge Link.
@@ -13687,7 +13999,7 @@ client.crm.custom_object_classes.list()
-**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/). +**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/.
@@ -13695,7 +14007,7 @@ client.crm.custom_object_classes.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -13703,7 +14015,7 @@ client.crm.custom_object_classes.list()
-**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). +**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.
@@ -13711,7 +14023,7 @@ client.crm.custom_object_classes.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**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.
@@ -13719,7 +14031,7 @@ client.crm.custom_object_classes.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**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.
@@ -13727,7 +14039,14 @@ client.crm.custom_object_classes.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**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.
@@ -13735,7 +14054,20 @@ client.crm.custom_object_classes.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**language:** `typing.Optional[LanguageEnum]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de + +
+
+ +
+
+ +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β€” A JSON object containing integration-specific configuration options.
@@ -13755,7 +14087,8 @@ client.crm.custom_object_classes.list()
-
client.crm.custom_object_classes.retrieve(...) +## Crm LinkedAccounts +
client.crm.linked_accounts.list(...)
@@ -13767,7 +14100,7 @@ client.crm.custom_object_classes.list()
-Returns a `CustomObjectClass` object with the given `id`. +List linked accounts for your organization.
@@ -13788,9 +14121,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.retrieve( - id="id", -) +client.crm.linked_accounts.list() ``` @@ -13806,7 +14137,17 @@ client.crm.custom_object_classes.retrieve(
-**id:** `str` +**category:** `typing.Optional[LinkedAccountsListRequestCategory]` + +Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` + +- `hris` - hris +- `ats` - ats +- `accounting` - accounting +- `ticketing` - ticketing +- `crm` - crm +- `mktg` - mktg +- `filestorage` - filestorage
@@ -13814,7 +14155,7 @@ client.crm.custom_object_classes.retrieve(
-**expand:** `typing.Optional[typing.Literal["fields"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -13822,7 +14163,87 @@ client.crm.custom_object_classes.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**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. + +
+
+ +
+
+ +**status:** `typing.Optional[str]` β€” Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -13842,8 +14263,8 @@ client.crm.custom_object_classes.retrieve(
-## Crm AssociationTypes -
client.crm.association_types.custom_object_classes_association_types_list(...) +## Crm Notes +
client.crm.notes.list(...)
@@ -13855,7 +14276,7 @@ client.crm.custom_object_classes.retrieve(
-Returns a list of `AssociationType` objects. +Returns a list of `Note` objects.
@@ -13876,9 +14297,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_list( - custom_object_class_id="custom_object_class_id", -) +client.crm.notes.list() ``` @@ -13894,7 +14313,15 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**custom_object_class_id:** `str` +**account_id:** `typing.Optional[str]` β€” If provided, will only return notes with this account. + +
+
+ +
+
+ +**contact_id:** `typing.Optional[str]` β€” If provided, will only return notes with this contact.
@@ -13926,7 +14353,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[NotesListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13950,6 +14377,14 @@ client.crm.association_types.custom_object_classes_association_types_list(
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **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).
@@ -13974,6 +14409,22 @@ client.crm.association_types.custom_object_classes_association_types_list(
+**opportunity_id:** `typing.Optional[str]` β€” If provided, will only return notes with this opportunity. + +
+
+ +
+
+ +**owner_id:** `typing.Optional[str]` β€” If provided, will only return notes with this owner. + +
+
+ +
+
+ **page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -14002,7 +14453,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
client.crm.association_types.custom_object_classes_association_types_create(...) +
client.crm.notes.create(...)
@@ -14014,7 +14465,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-Creates an `AssociationType` object with the given values. +Creates a `Note` object with the given values.
@@ -14030,31 +14481,14 @@ Creates an `AssociationType` object with the given values. ```python from merge import Merge -from merge.resources.crm import ( - AssociationTypeRequestRequest, - ObjectClassDescriptionRequest, - OriginTypeEnum, -) +from merge.resources.crm import NoteRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_create( - custom_object_class_id="custom_object_class_id", - model=AssociationTypeRequestRequest( - source_object_class=ObjectClassDescriptionRequest( - id="id", - origin_type=OriginTypeEnum.CUSTOM_OBJECT, - ), - target_object_classes=[ - ObjectClassDescriptionRequest( - id="id", - origin_type=OriginTypeEnum.CUSTOM_OBJECT, - ) - ], - remote_key_name="remote_key_name", - ), +client.crm.notes.create( + model=NoteRequest(), ) ``` @@ -14071,15 +14505,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**model:** `AssociationTypeRequestRequest` +**model:** `NoteRequest`
@@ -14115,7 +14541,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
client.crm.association_types.custom_object_classes_association_types_retrieve(...) +
client.crm.notes.retrieve(...)
@@ -14127,7 +14553,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-Returns an `AssociationType` object with the given `id`. +Returns a `Note` object with the given `id`.
@@ -14148,8 +14574,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_retrieve( - custom_object_class_id="custom_object_class_id", +client.crm.notes.retrieve( id="id", ) @@ -14167,7 +14592,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**custom_object_class_id:** `str` +**id:** `str`
@@ -14175,7 +14600,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**id:** `str` +**expand:** `typing.Optional[NotesRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14183,7 +14608,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` β€” 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.
@@ -14191,7 +14616,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -14211,7 +14636,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...) +
client.crm.notes.meta_post_retrieve()
@@ -14223,7 +14648,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-Returns metadata for `CRMAssociationType` POSTs. +Returns metadata for `Note` POSTs.
@@ -14244,9 +14669,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( - custom_object_class_id="custom_object_class_id", -) +client.crm.notes.meta_post_retrieve() ``` @@ -14262,14 +14685,6 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-**custom_object_class_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -14282,8 +14697,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-## Crm CustomObjects -
client.crm.custom_objects.custom_object_classes_custom_objects_list(...) +
client.crm.notes.remote_field_classes_list(...)
@@ -14295,7 +14709,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-Returns a list of `CustomObject` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -14316,9 +14730,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_list( - custom_object_class_id="custom_object_class_id", -) +client.crm.notes.remote_field_classes_list() ``` @@ -14334,30 +14746,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**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.
@@ -14398,15 +14786,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**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. +**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value
@@ -14422,14 +14802,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -14442,7 +14814,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
client.crm.custom_objects.custom_object_classes_custom_objects_create(...) +## Crm Opportunities +
client.crm.opportunities.list(...)
@@ -14454,7 +14827,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-Creates a `CustomObject` object with the given values. +Returns a list of `Opportunity` objects.
@@ -14470,18 +14843,12 @@ Creates a `CustomObject` object with the given values. ```python from merge import Merge -from merge.resources.crm import CustomObjectRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_create( - custom_object_class_id="custom_object_class_id", - model=CustomObjectRequest( - fields={"test_field": "hello"}, - ), -) +client.crm.opportunities.list() ``` @@ -14497,7 +14864,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**custom_object_class_id:** `str` +**account_id:** `typing.Optional[str]` β€” If provided, will only return opportunities with this account.
@@ -14505,7 +14872,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**model:** `CustomObjectRequest` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -14513,7 +14880,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -14521,7 +14888,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -14529,71 +14896,95 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**expand:** `typing.Optional[OpportunitiesListRequestExpand]` β€” 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/). +
-
-
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
-#### πŸ“ Description +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+
-Returns a `CustomObject` object with the given `id`. +**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. +
-#### πŸ”Œ Usage -
+**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-```python -from merge import Merge +**owner_id:** `typing.Optional[str]` β€” If provided, will only return opportunities with this owner. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( - custom_object_class_id="custom_object_class_id", - id="id", -) +
+
-``` +**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +
+ +
+
+ +**remote_created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return opportunities created in the third party platform after this datetime. +
-#### βš™οΈ Parameters -
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. + +
+
+
-**custom_object_class_id:** `str` +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -14601,7 +14992,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**id:** `str` +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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)
@@ -14609,7 +15000,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**stage_id:** `typing.Optional[str]` β€” If provided, will only return opportunities with this stage.
@@ -14617,7 +15008,13 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**status:** `typing.Optional[OpportunitiesListRequestStatus]` + +If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') + +- `OPEN` - OPEN +- `WON` - WON +- `LOST` - LOST
@@ -14637,7 +15034,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...) +
client.crm.opportunities.create(...)
@@ -14649,7 +15046,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-Returns metadata for `CRMCustomObject` POSTs. +Creates an `Opportunity` object with the given values.
@@ -14665,13 +15062,14 @@ Returns metadata for `CRMCustomObject` POSTs. ```python from merge import Merge +from merge.resources.crm import OpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve( - custom_object_class_id="custom_object_class_id", +client.crm.opportunities.create( + model=OpportunityRequest(), ) ``` @@ -14688,7 +15086,23 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-**custom_object_class_id:** `str` +**model:** `OpportunityRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -14708,7 +15122,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...) +
client.crm.opportunities.retrieve(...)
@@ -14720,7 +15134,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-Returns a list of `RemoteFieldClass` objects. +Returns an `Opportunity` object with the given `id`.
@@ -14741,7 +15155,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() +client.crm.opportunities.retrieve( + id="id", +) ``` @@ -14757,7 +15173,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**id:** `str`
@@ -14765,7 +15181,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**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/). +**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14789,15 +15205,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**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). - -
-
- -
-
- -**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value +**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins.
@@ -14805,7 +15213,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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)
@@ -14825,8 +15233,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-## Crm Associations -
client.crm.associations.custom_object_classes_custom_objects_associations_list(...) +
client.crm.opportunities.partial_update(...)
@@ -14838,7 +15245,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-Returns a list of `Association` objects. +Updates an `Opportunity` object with the given `id`.
@@ -14854,14 +15261,15 @@ Returns a list of `Association` objects. ```python from merge import Merge +from merge.resources.crm import PatchedOpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.associations.custom_object_classes_custom_objects_associations_list( - custom_object_class_id="custom_object_class_id", - object_id="object_id", +client.crm.opportunities.partial_update( + id="id", + model=PatchedOpportunityRequest(), ) ``` @@ -14878,7 +15286,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**custom_object_class_id:** `str` +**id:** `str`
@@ -14886,7 +15294,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**object_id:** `str` +**model:** `PatchedOpportunityRequest`
@@ -14894,7 +15302,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**association_type_id:** `typing.Optional[str]` β€” If provided, will only return opportunities with this association_type. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -14902,7 +15310,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -14910,79 +15318,70 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` β€” The pagination cursor value. -
-
-
-**expand:** `typing.Optional[typing.Literal["association_type"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.crm.opportunities.meta_patch_retrieve(...)
-**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/). - -
-
+#### πŸ“ Description
-**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). - +Returns metadata for `Opportunity` PATCHs.
+ + + +#### πŸ”Œ Usage
-**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. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.opportunities.meta_patch_retrieve( + id="id", +) + +``` +
+
+#### βš™οΈ Parameters +
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - -
-
-
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**id:** `str`
@@ -15002,7 +15401,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
client.crm.associations.custom_object_classes_custom_objects_associations_update(...) +
client.crm.opportunities.meta_post_retrieve()
@@ -15014,7 +15413,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`. +Returns metadata for `Opportunity` POSTs.
@@ -15035,13 +15434,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.associations.custom_object_classes_custom_objects_associations_update( - association_type_id="association_type_id", - source_class_id="source_class_id", - source_object_id="source_object_id", - target_class_id="target_class_id", - target_object_id="target_object_id", -) +client.crm.opportunities.meta_post_retrieve() ``` @@ -15057,62 +15450,6 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**association_type_id:** `str` - -
-
- -
-
- -**source_class_id:** `str` - -
-
- -
-
- -**source_object_id:** `str` - -
-
- -
-
- -**target_class_id:** `str` - -
-
- -
-
- -**target_object_id:** `str` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -15125,8 +15462,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-## Crm Scopes -
client.crm.scopes.default_scopes_retrieve() +
client.crm.opportunities.remote_field_classes_list(...)
@@ -15138,7 +15474,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-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). +Returns a list of `RemoteFieldClass` objects.
@@ -15159,7 +15495,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.default_scopes_retrieve() +client.crm.opportunities.remote_field_classes_list() ``` @@ -15175,64 +15511,59 @@ client.crm.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
- -
+
+
+**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/). +
-
-
client.crm.scopes.linked_account_scopes_retrieve()
-#### πŸ“ Description - -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-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). -
-
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### πŸ”Œ Usage -
+**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). + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.scopes.linked_account_scopes_retrieve() - -``` -
-
+**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value + -#### βš™οΈ Parameters -
+**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
+
@@ -15248,7 +15579,8 @@ client.crm.scopes.linked_account_scopes_retrieve()
-
client.crm.scopes.linked_account_scopes_create(...) +## Crm Passthrough +
client.crm.passthrough.create(...)
@@ -15260,7 +15592,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-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) +Pull data from an endpoint not currently supported by Merge.
@@ -15276,37 +15608,17 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.crm import ( - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) +from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +client.crm.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -15323,7 +15635,7 @@ client.crm.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β€” The common models you want to update the scopes for +**request:** `DataPassthroughRequest`
@@ -15343,8 +15655,8 @@ client.crm.scopes.linked_account_scopes_create(
-## Crm DeleteAccount -
client.crm.delete_account.delete() +## Crm RegenerateKey +
client.crm.regenerate_key.create(...)
@@ -15356,7 +15668,7 @@ client.crm.scopes.linked_account_scopes_create(
-Delete a linked account. +Exchange remote keys.
@@ -15377,7 +15689,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.delete_account.delete() +client.crm.regenerate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -15393,6 +15707,14 @@ client.crm.delete_account.delete()
+**name:** `str` β€” The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -15405,8 +15727,8 @@ client.crm.delete_account.delete()
-## Crm EngagementTypes -
client.crm.engagement_types.list(...) +## Crm Stages +
client.crm.stages.list(...)
@@ -15418,7 +15740,7 @@ client.crm.delete_account.delete()
-Returns a list of `EngagementType` objects. +Returns a list of `Stage` objects.
@@ -15439,7 +15761,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.list() +client.crm.stages.list() ``` @@ -15555,7 +15877,7 @@ client.crm.engagement_types.list()
-
client.crm.engagement_types.retrieve(...) +
client.crm.stages.retrieve(...)
@@ -15567,7 +15889,7 @@ client.crm.engagement_types.list()
-Returns an `EngagementType` object with the given `id`. +Returns a `Stage` object with the given `id`.
@@ -15588,7 +15910,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.retrieve( +client.crm.stages.retrieve( id="id", ) @@ -15642,7 +15964,7 @@ client.crm.engagement_types.retrieve(
-
client.crm.engagement_types.remote_field_classes_list(...) +
client.crm.stages.remote_field_classes_list(...)
@@ -15675,7 +15997,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.remote_field_classes_list() +client.crm.stages.remote_field_classes_list() ```
@@ -15759,8 +16081,8 @@ client.crm.engagement_types.remote_field_classes_list()
-## Crm Engagements -
client.crm.engagements.list(...) +## Crm SyncStatus +
client.crm.sync_status.list(...)
@@ -15772,7 +16094,7 @@ client.crm.engagement_types.remote_field_classes_list()
-Returns a list of `Engagement` objects. +Get syncing status. Possible values: `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).
@@ -15793,7 +16115,147 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.list() +client.crm.sync_status.list() + +``` + +
+ + + +#### βš™οΈ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Crm ForceResync +
client.crm.force_resync.sync_status_resync_create() +
+
+ +#### πŸ“ Description + +
+
+ +
+
+ +Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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. +
+
+
+
+ +#### πŸ”Œ Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.force_resync.sync_status_resync_create() + +``` +
+
+
+
+ +#### βš™οΈ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Crm Tasks +
client.crm.tasks.list(...) +
+
+ +#### πŸ“ Description + +
+
+ +
+
+ +Returns a list of `Task` objects. +
+
+
+
+ +#### πŸ”Œ Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.tasks.list() ```
@@ -15833,7 +16295,7 @@ client.crm.engagements.list()
-**expand:** `typing.Optional[EngagementsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[TasksListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15905,15 +16367,87 @@ client.crm.engagements.list()
-**started_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return engagements started after this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+
+
+ +
+
+
+ +
client.crm.tasks.create(...)
-**started_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return engagements started before this datetime. +#### πŸ“ Description + +
+
+ +
+
+ +Creates a `Task` object with the given values. +
+
+
+
+ +#### πŸ”Œ Usage + +
+
+ +
+
+ +```python +from merge import Merge +from merge.resources.crm import TaskRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.tasks.create( + model=TaskRequest(), +) + +``` +
+
+
+
+ +#### βš™οΈ Parameters + +
+
+ +
+
+ +**model:** `TaskRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -15933,7 +16467,7 @@ client.crm.engagements.list()
-
client.crm.engagements.create(...) +
client.crm.tasks.retrieve(...)
@@ -15945,7 +16479,7 @@ client.crm.engagements.list()
-Creates an `Engagement` object with the given values. +Returns a `Task` object with the given `id`.
@@ -15961,14 +16495,13 @@ Creates an `Engagement` object with the given values. ```python from merge import Merge -from merge.resources.crm import EngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.create( - model=EngagementRequest(), +client.crm.tasks.retrieve( + id="id", ) ``` @@ -15985,7 +16518,7 @@ client.crm.engagements.create(
-**model:** `EngagementRequest` +**id:** `str`
@@ -15993,7 +16526,7 @@ client.crm.engagements.create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**expand:** `typing.Optional[TasksRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -16001,7 +16534,15 @@ client.crm.engagements.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -16021,7 +16562,7 @@ client.crm.engagements.create(
-
client.crm.engagements.retrieve(...) +
client.crm.tasks.partial_update(...)
@@ -16033,7 +16574,7 @@ client.crm.engagements.create(
-Returns an `Engagement` object with the given `id`. +Updates a `Task` object with the given `id`.
@@ -16049,13 +16590,15 @@ Returns an `Engagement` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import PatchedTaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.retrieve( +client.crm.tasks.partial_update( id="id", + model=PatchedTaskRequest(), ) ``` @@ -16080,7 +16623,7 @@ client.crm.engagements.retrieve(
-**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**model:** `PatchedTaskRequest`
@@ -16088,7 +16631,7 @@ client.crm.engagements.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -16096,7 +16639,7 @@ client.crm.engagements.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -16116,7 +16659,7 @@ client.crm.engagements.retrieve(
-
client.crm.engagements.partial_update(...) +
client.crm.tasks.meta_patch_retrieve(...)
@@ -16128,7 +16671,7 @@ client.crm.engagements.retrieve(
-Updates an `Engagement` object with the given `id`. +Returns metadata for `Task` PATCHs.
@@ -16144,15 +16687,13 @@ Updates an `Engagement` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedEngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.partial_update( +client.crm.tasks.meta_patch_retrieve( id="id", - model=PatchedEngagementRequest(), ) ``` @@ -16177,30 +16718,6 @@ client.crm.engagements.partial_update(
-**model:** `PatchedEngagementRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -16213,78 +16730,7 @@ client.crm.engagements.partial_update(
-
client.crm.engagements.meta_patch_retrieve(...) -
-
- -#### πŸ“ Description - -
-
- -
-
- -Returns metadata for `Engagement` PATCHs. -
-
-
-
- -#### πŸ”Œ Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.engagements.meta_patch_retrieve( - id="id", -) - -``` -
-
-
-
- -#### βš™οΈ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.crm.engagements.meta_post_retrieve() +
client.crm.tasks.meta_post_retrieve()
@@ -16296,7 +16742,7 @@ client.crm.engagements.meta_patch_retrieve(
-Returns metadata for `Engagement` POSTs. +Returns metadata for `Task` POSTs.
@@ -16317,7 +16763,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.meta_post_retrieve() +client.crm.tasks.meta_post_retrieve() ``` @@ -16345,7 +16791,7 @@ client.crm.engagements.meta_post_retrieve()
-
client.crm.engagements.remote_field_classes_list(...) +
client.crm.tasks.remote_field_classes_list(...)
@@ -16378,7 +16824,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.remote_field_classes_list() +client.crm.tasks.remote_field_classes_list() ```
@@ -16462,8 +16908,8 @@ client.crm.engagements.remote_field_classes_list()
-## Crm FieldMapping -
client.crm.field_mapping.field_mappings_retrieve() +## Crm Users +
client.crm.users.list(...)
@@ -16475,7 +16921,7 @@ client.crm.engagements.remote_field_classes_list()
-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/). +Returns a list of `User` objects.
@@ -16496,7 +16942,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_retrieve() +client.crm.users.list() ``` @@ -16512,75 +16958,47 @@ client.crm.field_mapping.field_mappings_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-
client.crm.field_mapping.field_mappings_create(...)
-#### πŸ“ Description - -
-
+**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
-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. -
-
+**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/). +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", -) - -``` -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### βš™οΈ Parameters -
-
-
- -**target_field_name:** `str` β€” The name of the target field you want this remote field to map to. +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -16588,7 +17006,7 @@ client.crm.field_mapping.field_mappings_create(
-**target_field_description:** `str` β€” The description of the target field you want this remote field to map to. +**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).
@@ -16596,7 +17014,7 @@ client.crm.field_mapping.field_mappings_create(
-**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. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -16604,7 +17022,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_method:** `str` β€” The method of the remote endpoint where the remote field is coming from. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -16612,7 +17030,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_url_path:** `str` β€” The path of the remote endpoint where the remote field is coming from. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -16620,7 +17038,7 @@ client.crm.field_mapping.field_mappings_create(
-**common_model_name:** `str` β€” The name of the Common Model that the remote field corresponds to in a given category. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -16640,7 +17058,7 @@ client.crm.field_mapping.field_mappings_create(
-
client.crm.field_mapping.field_mappings_destroy(...) +
client.crm.users.retrieve(...)
@@ -16652,7 +17070,7 @@ client.crm.field_mapping.field_mappings_create(
-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. +Returns a `User` object with the given `id`.
@@ -16673,8 +17091,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", +client.crm.users.retrieve( + id="id", ) ``` @@ -16691,7 +17109,23 @@ client.crm.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -16711,7 +17145,7 @@ client.crm.field_mapping.field_mappings_destroy(
-
client.crm.field_mapping.field_mappings_partial_update(...) +
client.crm.users.ignore_create(...)
@@ -16723,7 +17157,7 @@ client.crm.field_mapping.field_mappings_destroy(
-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. +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
@@ -16739,13 +17173,17 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r ```python from merge import Merge +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", +client.crm.users.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), ) ``` @@ -16762,23 +17200,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` - -
-
- -
-
- -**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. +**model_id:** `str`
@@ -16786,7 +17208,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` β€” The path of the remote endpoint where the remote field is coming from. +**request:** `IgnoreCommonModelRequest`
@@ -16806,7 +17228,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-
client.crm.field_mapping.remote_fields_retrieve(...) +
client.crm.users.remote_field_classes_list(...)
@@ -16818,7 +17240,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-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/). +Returns a list of `RemoteFieldClass` objects.
@@ -16839,7 +17261,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.remote_fields_retrieve() +client.crm.users.remote_field_classes_list() ``` @@ -16855,7 +17277,7 @@ client.crm.field_mapping.remote_fields_retrieve()
-**common_models:** `typing.Optional[str]` β€” A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -16863,7 +17285,47 @@ client.crm.field_mapping.remote_fields_retrieve()
-**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. +**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_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ +**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). + +
+
+ +
+
+ +**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -16883,7 +17345,8 @@ client.crm.field_mapping.remote_fields_retrieve()
-
client.crm.field_mapping.target_fields_retrieve() +## Crm WebhookReceivers +
client.crm.webhook_receivers.list()
@@ -16895,7 +17358,7 @@ client.crm.field_mapping.remote_fields_retrieve()
-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/). +Returns a list of `WebhookReceiver` objects.
@@ -16916,7 +17379,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.target_fields_retrieve() +client.crm.webhook_receivers.list() ``` @@ -16944,8 +17407,7 @@ client.crm.field_mapping.target_fields_retrieve()
-## Crm GenerateKey -
client.crm.generate_key.create(...) +
client.crm.webhook_receivers.create(...)
@@ -16957,7 +17419,7 @@ client.crm.field_mapping.target_fields_retrieve()
-Create a remote key. +Creates a `WebhookReceiver` object with the given values.
@@ -16978,8 +17440,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.generate_key.create( - name="Remote Deployment Key 1", +client.crm.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -16996,7 +17459,23 @@ client.crm.generate_key.create(
-**name:** `str` β€” The name of the remote key +**event:** `str` + +
+
+ +
+
+ +**is_active:** `bool` + +
+
+ +
+
+ +**key:** `typing.Optional[str]`
@@ -17016,8 +17495,8 @@ client.crm.generate_key.create(
-## Crm Issues -
client.crm.issues.list(...) +## Filestorage AccountDetails +
client.filestorage.account_details.retrieve()
@@ -17029,7 +17508,7 @@ client.crm.generate_key.create(
-Gets all issues for Organization. +Get details for a linked account.
@@ -17050,7 +17529,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.list() +client.filestorage.account_details.retrieve() ``` @@ -17066,116 +17545,71 @@ client.crm.issues.list()
-**account_token:** `typing.Optional[str]` +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**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 -
+
+## Filestorage AccountToken +
client.filestorage.account_token.retrieve(...)
-**end_user_organization_name:** `typing.Optional[str]` - -
-
+#### πŸ“ Description
-**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. - +Returns the account token for the end user with the provided public token.
- -
-
- -**include_muted:** `typing.Optional[str]` β€” If true, will include muted issues -
-
-
- -**integration_name:** `typing.Optional[str]` - -
-
+#### πŸ”Œ Usage
-**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. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.account_token.retrieve( + public_token="public_token", +) -**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. -
+#### βš™οΈ Parameters +
-**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. Options: ('ONGOING', 'RESOLVED') - -- `ONGOING` - ONGOING -- `RESOLVED` - RESOLVED +**public_token:** `str`
@@ -17195,7 +17629,8 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.crm.issues.retrieve(...) +## Filestorage AsyncPassthrough +
client.filestorage.async_passthrough.create(...)
@@ -17207,7 +17642,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -17223,13 +17658,17 @@ Get a specific issue. ```python from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.retrieve( - id="id", +client.filestorage.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -17246,7 +17685,7 @@ client.crm.issues.retrieve(
-**id:** `str` +**request:** `DataPassthroughRequest`
@@ -17266,8 +17705,7 @@ client.crm.issues.retrieve(
-## Crm Leads -
client.crm.leads.list(...) +
client.filestorage.async_passthrough.retrieve(...)
@@ -17279,7 +17717,7 @@ client.crm.issues.retrieve(
-Returns a list of `Lead` objects. +Retrieves data from earlier async-passthrough POST request
@@ -17300,7 +17738,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.list() +client.filestorage.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) ``` @@ -17316,7 +17756,7 @@ client.crm.leads.list()
-**converted_account_id:** `typing.Optional[str]` β€” If provided, will only return leads with this account. +**async_passthrough_receipt_id:** `str`
@@ -17324,87 +17764,69 @@ client.crm.leads.list()
-**converted_contact_id:** `typing.Optional[str]` β€” If provided, will only return leads with this contact. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**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. -
+
+## Filestorage AuditTrail +
client.filestorage.audit_trail.list(...)
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. - -
-
+#### πŸ“ Description
-**email_addresses:** `typing.Optional[str]` β€” If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. - -
-
-
-**expand:** `typing.Optional[LeadsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +Gets a list of audit trail events.
- -
-
- -**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/). -
+#### πŸ”Œ Usage +
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.audit_trail.list() + +``` +
+
+#### βš™οΈ Parameters +
-**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. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -17412,7 +17834,7 @@ client.crm.leads.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**end_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred before this time
@@ -17420,7 +17842,7 @@ client.crm.leads.list()
-**owner_id:** `typing.Optional[str]` β€” If provided, will only return leads with this owner. +**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`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_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`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -17436,7 +17858,7 @@ client.crm.leads.list()
-**phone_numbers:** `typing.Optional[str]` β€” If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. +**start_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred after this time
@@ -17444,7 +17866,7 @@ client.crm.leads.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**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.
@@ -17464,7 +17886,8 @@ client.crm.leads.list()
-
client.crm.leads.create(...) +## Filestorage AvailableActions +
client.filestorage.available_actions.retrieve()
@@ -17476,7 +17899,7 @@ client.crm.leads.list()
-Creates a `Lead` object with the given values. +Returns a list of models and actions available for an account.
@@ -17492,15 +17915,12 @@ Creates a `Lead` object with the given values. ```python from merge import Merge -from merge.resources.crm import LeadRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.create( - model=LeadRequest(), -) +client.filestorage.available_actions.retrieve() ``` @@ -17516,30 +17936,6 @@ client.crm.leads.create(
-**model:** `LeadRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -17552,7 +17948,8 @@ client.crm.leads.create(
-
client.crm.leads.retrieve(...) +## Filestorage Scopes +
client.filestorage.scopes.default_scopes_retrieve()
@@ -17564,7 +17961,7 @@ client.crm.leads.create(
-Returns a `Lead` object with the given `id`. +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).
@@ -17585,9 +17982,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.retrieve( - id="id", -) +client.filestorage.scopes.default_scopes_retrieve() ``` @@ -17603,38 +17998,6 @@ client.crm.leads.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` β€” 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_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -17647,7 +18010,7 @@ client.crm.leads.retrieve(
-
client.crm.leads.meta_post_retrieve() +
client.filestorage.scopes.linked_account_scopes_retrieve()
@@ -17659,7 +18022,7 @@ client.crm.leads.retrieve(
-Returns metadata for `Lead` POSTs. +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).
@@ -17680,7 +18043,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.meta_post_retrieve() +client.filestorage.scopes.linked_account_scopes_retrieve() ``` @@ -17708,7 +18071,7 @@ client.crm.leads.meta_post_retrieve()
-
client.crm.leads.remote_field_classes_list(...) +
client.filestorage.scopes.linked_account_scopes_create(...)
@@ -17720,7 +18083,7 @@ client.crm.leads.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +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)
@@ -17736,12 +18099,38 @@ Returns a list of `RemoteFieldClass` objects. ```python from merge import Merge +from merge.resources.filestorage import ( + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.remote_field_classes_list() +client.filestorage.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], +) ``` @@ -17757,7 +18146,7 @@ client.crm.leads.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β€” The common models you want to update the scopes for
@@ -17765,51 +18154,65 @@ client.crm.leads.remote_field_classes_list()
-**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/). +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+## Filestorage DeleteAccount +
client.filestorage.delete_account.delete()
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
+#### πŸ“ Description
-**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). - -
-
-
-**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value - +Delete a linked account. +
+
+#### πŸ”Œ Usage +
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.delete_account.delete() + +``` +
+
+#### βš™οΈ Parameters + +
+
+
@@ -17825,8 +18228,8 @@ client.crm.leads.remote_field_classes_list()
-## Crm LinkToken -
client.crm.link_token.create(...) +## Filestorage Drives +
client.filestorage.drives.list(...)
@@ -17838,7 +18241,7 @@ client.crm.leads.remote_field_classes_list()
-Creates a link token to be used when linking a new end user. +Returns a list of `Drive` objects.
@@ -17854,18 +18257,12 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.crm import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.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], -) +client.filestorage.drives.list() ``` @@ -17881,15 +18278,7 @@ client.crm.link_token.create(
-**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. +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -17897,7 +18286,7 @@ client.crm.link_token.create(
-**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. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -17905,7 +18294,7 @@ client.crm.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` β€” The integration categories to show in Merge Link. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -17913,7 +18302,7 @@ client.crm.link_token.create(
-**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/. +**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/).
@@ -17921,7 +18310,7 @@ client.crm.link_token.create(
-**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. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17929,7 +18318,7 @@ client.crm.link_token.create(
-**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. +**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).
@@ -17937,7 +18326,7 @@ client.crm.link_token.create(
-**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. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -17945,7 +18334,7 @@ client.crm.link_token.create(
-**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. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -17953,14 +18342,7 @@ client.crm.link_token.create(
-**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. +**name:** `typing.Optional[str]` β€” If provided, will only return drives with this name. This performs an exact match.
@@ -17968,12 +18350,7 @@ client.crm.link_token.create(
-**language:** `typing.Optional[LanguageEnum]` - -The following subset of IETF language tags can be used to configure localization. - -* `en` - en -* `de` - de +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -17981,7 +18358,7 @@ The following subset of IETF language tags can be used to configure localization
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β€” A JSON object containing integration-specific configuration options. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -18001,8 +18378,7 @@ The following subset of IETF language tags can be used to configure localization
-## Crm LinkedAccounts -
client.crm.linked_accounts.list(...) +
client.filestorage.drives.retrieve(...)
@@ -18014,7 +18390,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a `Drive` object with the given `id`.
@@ -18035,7 +18411,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.linked_accounts.list() +client.filestorage.drives.retrieve( + id="id", +) ``` @@ -18051,17 +18429,7 @@ client.crm.linked_accounts.list()
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` - -Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` - -- `hris` - hris -- `ats` - ats -- `accounting` - accounting -- `ticketing` - ticketing -- `crm` - crm -- `mktg` - mktg -- `filestorage` - filestorage +**id:** `str`
@@ -18069,7 +18437,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -18077,91 +18445,65 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_email_address:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given email address. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**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. -
+
+## Filestorage FieldMapping +
client.filestorage.field_mapping.field_mappings_retrieve()
-**end_user_origin_ids:** `typing.Optional[str]` β€” Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. - -
-
+#### πŸ“ Description
-**id:** `typing.Optional[str]` - -
-
-
-**ids:** `typing.Optional[str]` β€” Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. - +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/).
- -
-
- -**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. -
+#### πŸ”Œ Usage +
-**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. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.field_mapping.field_mappings_retrieve() -**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - +``` +
+
+#### βš™οΈ Parameters +
-**status:** `typing.Optional[str]` β€” Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` - -
-
-
@@ -18177,8 +18519,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Crm Notes -
client.crm.notes.list(...) +
client.filestorage.field_mapping.field_mappings_create(...)
@@ -18190,7 +18531,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Note` objects. +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.
@@ -18211,7 +18552,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.list() +client.filestorage.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) ``` @@ -18227,7 +18575,7 @@ client.crm.notes.list()
-**account_id:** `typing.Optional[str]` β€” If provided, will only return notes with this account. +**target_field_name:** `str` β€” The name of the target field you want this remote field to map to.
@@ -18235,7 +18583,7 @@ client.crm.notes.list()
-**contact_id:** `typing.Optional[str]` β€” If provided, will only return notes with this contact. +**target_field_description:** `str` β€” The description of the target field you want this remote field to map to.
@@ -18243,7 +18591,7 @@ client.crm.notes.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**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.
@@ -18251,7 +18599,7 @@ client.crm.notes.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**remote_method:** `str` β€” The method of the remote endpoint where the remote field is coming from.
@@ -18259,7 +18607,7 @@ client.crm.notes.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**remote_url_path:** `str` β€” The path of the remote endpoint where the remote field is coming from.
@@ -18267,7 +18615,7 @@ client.crm.notes.list()
-**expand:** `typing.Optional[NotesListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**common_model_name:** `str` β€” The name of the Common Model that the remote field corresponds to in a given category.
@@ -18275,79 +18623,70 @@ client.crm.notes.list()
-**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/). +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. -
-
-
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. -
+
+
client.filestorage.field_mapping.field_mappings_destroy(...)
-**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). - -
-
+#### πŸ“ Description
-**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. - +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 +
-**opportunity_id:** `typing.Optional[str]` β€” If provided, will only return notes with this opportunity. - -
-
-
-**owner_id:** `typing.Optional[str]` β€” If provided, will only return notes with this owner. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) + +``` +
+
+#### βš™οΈ Parameters +
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - -
-
-
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**field_mapping_id:** `str`
@@ -18367,7 +18706,7 @@ client.crm.notes.list()
-
client.crm.notes.create(...) +
client.filestorage.field_mapping.field_mappings_partial_update(...)
@@ -18379,7 +18718,7 @@ client.crm.notes.list()
-Creates a `Note` object with the given values. +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.
@@ -18395,14 +18734,13 @@ Creates a `Note` object with the given values. ```python from merge import Merge -from merge.resources.crm import NoteRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.create( - model=NoteRequest(), +client.filestorage.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -18419,7 +18757,7 @@ client.crm.notes.create(
-**model:** `NoteRequest` +**field_mapping_id:** `str`
@@ -18427,7 +18765,7 @@ client.crm.notes.create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**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.
@@ -18435,7 +18773,15 @@ client.crm.notes.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**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.
@@ -18455,7 +18801,7 @@ client.crm.notes.create(
-
client.crm.notes.retrieve(...) +
client.filestorage.field_mapping.remote_fields_retrieve(...)
@@ -18467,7 +18813,7 @@ client.crm.notes.create(
-Returns a `Note` object with the given `id`. +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/).
@@ -18488,9 +18834,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.retrieve( - id="id", -) +client.filestorage.field_mapping.remote_fields_retrieve() ``` @@ -18506,23 +18850,7 @@ client.crm.notes.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[NotesRetrieveRequestExpand]` β€” 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. +**common_models:** `typing.Optional[str]` β€” A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -18530,7 +18858,7 @@ client.crm.notes.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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.
@@ -18550,7 +18878,7 @@ client.crm.notes.retrieve(
-
client.crm.notes.meta_post_retrieve() +
client.filestorage.field_mapping.target_fields_retrieve()
@@ -18562,7 +18890,7 @@ client.crm.notes.retrieve(
-Returns metadata for `Note` POSTs. +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/).
@@ -18583,7 +18911,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.meta_post_retrieve() +client.filestorage.field_mapping.target_fields_retrieve() ``` @@ -18611,7 +18939,8 @@ client.crm.notes.meta_post_retrieve()
-
client.crm.notes.remote_field_classes_list(...) +## Filestorage Files +
client.filestorage.files.list(...)
@@ -18623,7 +18952,7 @@ client.crm.notes.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `File` objects.
@@ -18644,7 +18973,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.remote_field_classes_list() +client.filestorage.files.list() ``` @@ -18660,6 +18989,22 @@ client.crm.notes.remote_field_classes_list()
+**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.
@@ -18668,6 +19013,30 @@ client.crm.notes.remote_field_classes_list()
+**drive_id:** `typing.Optional[str]` β€” Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive. + +
+
+ +
+
+ +**expand:** `typing.Optional[FilesListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**folder_id:** `typing.Optional[str]` β€” Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory. + +
+
+ +
+
+ **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/).
@@ -18684,7 +19053,7 @@ client.crm.notes.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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).
@@ -18692,7 +19061,7 @@ client.crm.notes.remote_field_classes_list()
-**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). +**mime_type:** `typing.Optional[str]` β€” If provided, will only return files with these mime_types. Multiple values can be separated by commas.
@@ -18700,7 +19069,23 @@ client.crm.notes.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value +**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 files with this name. This performs an exact match.
@@ -18716,6 +19101,14 @@ client.crm.notes.remote_field_classes_list()
+**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -18728,8 +19121,7 @@ client.crm.notes.remote_field_classes_list()
-## Crm Opportunities -
client.crm.opportunities.list(...) +
client.filestorage.files.create(...)
@@ -18741,7 +19133,7 @@ client.crm.notes.remote_field_classes_list()
-Returns a list of `Opportunity` objects. +Creates a `File` object with the given values.
@@ -18757,12 +19149,15 @@ Returns a list of `Opportunity` objects. ```python from merge import Merge +from merge.resources.filestorage import FileRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.list() +client.filestorage.files.create( + model=FileRequest(), +) ``` @@ -18778,7 +19173,7 @@ client.crm.opportunities.list()
-**account_id:** `typing.Optional[str]` β€” If provided, will only return opportunities with this account. +**model:** `FileRequest`
@@ -18786,7 +19181,7 @@ client.crm.opportunities.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -18794,7 +19189,7 @@ client.crm.opportunities.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -18802,55 +19197,70 @@ client.crm.opportunities.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[OpportunitiesListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.filestorage.files.retrieve(...)
-**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/). - -
-
+#### πŸ“ Description
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - +Returns a `File` object with the given `id`. +
+
+#### πŸ”Œ Usage +
-**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). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.files.retrieve( + id="id", +) + +``` +
+
+#### βš™οΈ Parameters +
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +
+
+ +**id:** `str`
@@ -18858,7 +19268,7 @@ client.crm.opportunities.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**expand:** `typing.Optional[FilesRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -18866,7 +19276,7 @@ client.crm.opportunities.list()
-**owner_id:** `typing.Optional[str]` β€” If provided, will only return opportunities with this owner. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -18874,47 +19284,71 @@ client.crm.opportunities.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+
+
-
-
-**remote_created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return opportunities created in the third party platform after this datetime. -
+
+
client.filestorage.files.download_retrieve(...)
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. - -
-
+#### πŸ“ Description
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - +
+
+ +Returns the `File` content with the given `id` as a stream of bytes.
+
+
+ +#### πŸ”Œ Usage
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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) - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.files.download_retrieve( + id="string", + mime_type="string", +) + +``` +
+
+#### βš™οΈ Parameters +
-**stage_id:** `typing.Optional[str]` β€” If provided, will only return opportunities with this stage. +
+
+ +**id:** `str`
@@ -18922,13 +19356,7 @@ client.crm.opportunities.list()
-**status:** `typing.Optional[OpportunitiesListRequestStatus]` - -If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') - -- `OPEN` - OPEN -- `WON` - WON -- `LOST` - LOST +**mime_type:** `typing.Optional[str]` β€” If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article.
@@ -18948,7 +19376,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-
client.crm.opportunities.create(...) +
client.filestorage.files.meta_post_retrieve()
@@ -18960,7 +19388,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-Creates an `Opportunity` object with the given values. +Returns metadata for `FileStorageFile` POSTs.
@@ -18976,15 +19404,12 @@ Creates an `Opportunity` object with the given values. ```python from merge import Merge -from merge.resources.crm import OpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.create( - model=OpportunityRequest(), -) +client.filestorage.files.meta_post_retrieve() ``` @@ -19000,30 +19425,6 @@ client.crm.opportunities.create(
-**model:** `OpportunityRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -19036,7 +19437,8 @@ client.crm.opportunities.create(
-
client.crm.opportunities.retrieve(...) +## Filestorage Folders +
client.filestorage.folders.list(...)
@@ -19048,7 +19450,7 @@ client.crm.opportunities.create(
-Returns an `Opportunity` object with the given `id`. +Returns a list of `Folder` objects.
@@ -19069,9 +19471,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.retrieve( - id="id", -) +client.filestorage.folders.list() ``` @@ -19087,7 +19487,7 @@ client.crm.opportunities.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -19095,7 +19495,39 @@ client.crm.opportunities.retrieve(
-**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+ +
+
+ +**drive_id:** `typing.Optional[str]` β€” If provided, will only return folders in this drive. + +
+
+ +
+
+ +**expand:** `typing.Optional[FoldersListRequestExpand]` β€” 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/).
@@ -19111,7 +19543,7 @@ client.crm.opportunities.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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).
@@ -19119,7 +19551,7 @@ client.crm.opportunities.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` β€” Deprecated. Use show_enum_origins. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -19127,7 +19559,39 @@ client.crm.opportunities.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` β€” 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) +**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. This performs an exact match. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
+ +
+
+ +**parent_folder_id:** `typing.Optional[str]` β€” If provided, will only return folders in this parent folder. If null, will return folders in root directory. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -19147,7 +19611,7 @@ client.crm.opportunities.retrieve(
-
client.crm.opportunities.partial_update(...) +
client.filestorage.folders.create(...)
@@ -19159,7 +19623,7 @@ client.crm.opportunities.retrieve(
-Updates an `Opportunity` object with the given `id`. +Creates a `Folder` object with the given values.
@@ -19175,15 +19639,14 @@ Updates an `Opportunity` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedOpportunityRequest +from merge.resources.filestorage import FolderRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.partial_update( - id="id", - model=PatchedOpportunityRequest(), +client.filestorage.folders.create( + model=FolderRequest(), ) ``` @@ -19200,15 +19663,7 @@ client.crm.opportunities.partial_update(
-**id:** `str` - -
-
- -
-
- -**model:** `PatchedOpportunityRequest` +**model:** `FolderRequest`
@@ -19244,7 +19699,7 @@ client.crm.opportunities.partial_update(
-
client.crm.opportunities.meta_patch_retrieve(...) +
client.filestorage.folders.retrieve(...)
@@ -19256,7 +19711,7 @@ client.crm.opportunities.partial_update(
-Returns metadata for `Opportunity` PATCHs. +Returns a `Folder` object with the given `id`.
@@ -19277,7 +19732,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.meta_patch_retrieve( +client.filestorage.folders.retrieve( id="id", ) @@ -19303,6 +19758,22 @@ client.crm.opportunities.meta_patch_retrieve(
+**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` β€” 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. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -19315,7 +19786,7 @@ client.crm.opportunities.meta_patch_retrieve(
-
client.crm.opportunities.meta_post_retrieve() +
client.filestorage.folders.meta_post_retrieve()
@@ -19327,7 +19798,7 @@ client.crm.opportunities.meta_patch_retrieve(
-Returns metadata for `Opportunity` POSTs. +Returns metadata for `FileStorageFolder` POSTs.
@@ -19348,7 +19819,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.meta_post_retrieve() +client.filestorage.folders.meta_post_retrieve() ``` @@ -19376,7 +19847,8 @@ client.crm.opportunities.meta_post_retrieve()
-
client.crm.opportunities.remote_field_classes_list(...) +## Filestorage GenerateKey +
client.filestorage.generate_key.create(...)
@@ -19388,7 +19860,7 @@ client.crm.opportunities.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Create a remote key.
@@ -19409,7 +19881,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.remote_field_classes_list() +client.filestorage.generate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -19425,7 +19899,7 @@ client.crm.opportunities.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**name:** `str` β€” The name of the remote key
@@ -19433,47 +19907,69 @@ client.crm.opportunities.remote_field_classes_list()
-**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/). +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+## Filestorage Groups +
client.filestorage.groups.list(...)
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
+#### πŸ“ Description
-**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). - +
+
+ +Returns a list of `Group` objects. +
+
+#### πŸ”Œ Usage +
-**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.groups.list() + +```
+
+
+ +#### βš™οΈ Parameters
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +
+
+ +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -19481,75 +19977,71 @@ client.crm.opportunities.remote_field_classes_list()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
-
-
+
+
+**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +
-
-## Crm Passthrough -
client.crm.passthrough.create(...)
-#### πŸ“ Description +**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. + +
+
+
-Pull data from an endpoint not currently supported by Merge. -
-
+**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). + -#### πŸ”Œ Usage -
+**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge -from merge.resources.crm import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
+**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. + -#### βš™οΈ Parameters -
+**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
+
-**request:** `DataPassthroughRequest` +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -19569,8 +20061,7 @@ client.crm.passthrough.create(
-## Crm RegenerateKey -
client.crm.regenerate_key.create(...) +
client.filestorage.groups.retrieve(...)
@@ -19582,7 +20073,7 @@ client.crm.passthrough.create(
-Exchange remote keys. +Returns a `Group` object with the given `id`.
@@ -19603,8 +20094,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.regenerate_key.create( - name="Remote Deployment Key 1", +client.filestorage.groups.retrieve( + id="id", ) ``` @@ -19621,7 +20112,15 @@ client.crm.regenerate_key.create(
-**name:** `str` β€” The name of the remote key +**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19641,8 +20140,8 @@ client.crm.regenerate_key.create(
-## Crm Stages -
client.crm.stages.list(...) +## Filestorage Issues +
client.filestorage.issues.list(...)
@@ -19654,7 +20153,7 @@ client.crm.regenerate_key.create(
-Returns a list of `Stage` objects. +Gets all issues for Organization.
@@ -19675,7 +20174,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.list() +client.filestorage.issues.list() ``` @@ -19691,7 +20190,7 @@ client.crm.stages.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**account_token:** `typing.Optional[str]`
@@ -19699,7 +20198,7 @@ client.crm.stages.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -19707,7 +20206,7 @@ client.crm.stages.list()
-**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
@@ -19715,7 +20214,7 @@ client.crm.stages.list()
-**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/). +**end_user_organization_name:** `typing.Optional[str]`
@@ -19723,7 +20222,7 @@ client.crm.stages.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**first_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was after this datetime.
@@ -19731,7 +20230,7 @@ client.crm.stages.list()
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**first_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was before this datetime.
@@ -19739,7 +20238,7 @@ client.crm.stages.list()
-**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). +**include_muted:** `typing.Optional[str]` β€” If true, will include muted issues
@@ -19747,7 +20246,7 @@ client.crm.stages.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**integration_name:** `typing.Optional[str]`
@@ -19755,7 +20254,23 @@ client.crm.stages.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**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.
@@ -19771,7 +20286,20 @@ client.crm.stages.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**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. Options: ('ONGOING', 'RESOLVED') + +- `ONGOING` - ONGOING +- `RESOLVED` - RESOLVED
@@ -19791,7 +20319,7 @@ client.crm.stages.list()
-
client.crm.stages.retrieve(...) +
client.filestorage.issues.retrieve(...)
@@ -19803,7 +20331,7 @@ client.crm.stages.list()
-Returns a `Stage` object with the given `id`. +Get a specific issue.
@@ -19824,7 +20352,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.retrieve( +client.filestorage.issues.retrieve( id="id", ) @@ -19850,22 +20378,6 @@ client.crm.stages.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -19878,7 +20390,8 @@ client.crm.stages.retrieve(
-
client.crm.stages.remote_field_classes_list(...) +## Filestorage LinkToken +
client.filestorage.link_token.create(...)
@@ -19890,7 +20403,7 @@ client.crm.stages.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Creates a link token to be used when linking a new end user.
@@ -19906,12 +20419,18 @@ Returns a list of `RemoteFieldClass` objects. ```python from merge import Merge +from merge.resources.filestorage import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.remote_field_classes_list() +client.filestorage.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], +) ``` @@ -19927,7 +20446,7 @@ client.crm.stages.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**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.
@@ -19935,7 +20454,7 @@ client.crm.stages.remote_field_classes_list()
-**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/). +**end_user_organization_name:** `str` β€” Your end user's organization.
@@ -19943,7 +20462,7 @@ client.crm.stages.remote_field_classes_list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -19951,7 +20470,7 @@ client.crm.stages.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**categories:** `typing.Sequence[CategoriesEnum]` β€” The integration categories to show in Merge Link.
@@ -19959,7 +20478,7 @@ client.crm.stages.remote_field_classes_list()
-**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). +**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/.
@@ -19967,7 +20486,7 @@ client.crm.stages.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value +**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.
@@ -19975,7 +20494,59 @@ client.crm.stages.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**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[LanguageEnum]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de + +
+
+ +
+
+ +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β€” A JSON object containing integration-specific configuration options.
@@ -19995,8 +20566,8 @@ client.crm.stages.remote_field_classes_list()
-## Crm SyncStatus -
client.crm.sync_status.list(...) +## Filestorage LinkedAccounts +
client.filestorage.linked_accounts.list(...)
@@ -20008,7 +20579,7 @@ client.crm.stages.remote_field_classes_list()
-Get syncing status. Possible values: `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). +List linked accounts for your organization.
@@ -20029,7 +20600,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.sync_status.list() +client.filestorage.linked_accounts.list() ``` @@ -20045,7 +20616,17 @@ client.crm.sync_status.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**category:** `typing.Optional[LinkedAccountsListRequestCategory]` + +Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` + +- `hris` - hris +- `ats` - ats +- `accounting` - accounting +- `ticketing` - ticketing +- `crm` - crm +- `mktg` - mktg +- `filestorage` - filestorage
@@ -20053,7 +20634,7 @@ client.crm.sync_status.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -20061,65 +20642,91 @@ client.crm.sync_status.list()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-## Crm ForceResync -
client.crm.force_resync.sync_status_resync_create()
-#### πŸ“ Description +**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. + +
+
+
-Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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. +**id:** `typing.Optional[str]` +
+ +
+
+ +**ids:** `typing.Optional[str]` β€” Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +
-#### πŸ”Œ Usage -
+**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. + +
+
+
-```python -from merge import Merge +**integration_name:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given integration name. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.force_resync.sync_status_resync_create() +
+
-``` +**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. +
-#### βš™οΈ Parameters -
+**status:** `typing.Optional[str]` β€” Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` + +
+
+
@@ -20135,8 +20742,8 @@ client.crm.force_resync.sync_status_resync_create()
-## Crm Tasks -
client.crm.tasks.list(...) +## Filestorage Passthrough +
client.filestorage.passthrough.create(...)
@@ -20148,7 +20755,7 @@ client.crm.force_resync.sync_status_resync_create()
-Returns a list of `Task` objects. +Pull data from an endpoint not currently supported by Merge.
@@ -20164,12 +20771,18 @@ Returns a list of `Task` objects. ```python from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.list() +client.filestorage.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -20185,7 +20798,7 @@ client.crm.tasks.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**request:** `DataPassthroughRequest`
@@ -20193,87 +20806,71 @@ client.crm.tasks.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` β€” The pagination cursor value. -
-
-
-**expand:** `typing.Optional[TasksListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+## Filestorage RegenerateKey +
client.filestorage.regenerate_key.create(...)
-**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/). - -
-
+#### πŸ“ Description
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - +Exchange remote keys.
- -
-
- -**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). -
+#### πŸ”Œ Usage +
-**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. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.regenerate_key.create( + name="Remote Deployment Key 1", +) + +```
+ + + +#### βš™οΈ Parameters
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - -
-
-
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**name:** `str` β€” The name of the remote key
@@ -20293,7 +20890,8 @@ client.crm.tasks.list()
-
client.crm.tasks.create(...) +## Filestorage SyncStatus +
client.filestorage.sync_status.list(...)
@@ -20305,7 +20903,7 @@ client.crm.tasks.list()
-Creates a `Task` object with the given values. +Get syncing status. Possible values: `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).
@@ -20321,15 +20919,12 @@ Creates a `Task` object with the given values. ```python from merge import Merge -from merge.resources.crm import TaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.create( - model=TaskRequest(), -) +client.filestorage.sync_status.list() ``` @@ -20345,15 +20940,7 @@ client.crm.tasks.create(
-**model:** `TaskRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -20361,7 +20948,7 @@ client.crm.tasks.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -20381,7 +20968,8 @@ client.crm.tasks.create(
-
client.crm.tasks.retrieve(...) +## Filestorage ForceResync +
client.filestorage.force_resync.sync_status_resync_create()
@@ -20393,7 +20981,7 @@ client.crm.tasks.create(
-Returns a `Task` object with the given `id`. +Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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.
@@ -20414,9 +21002,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.retrieve( - id="id", -) +client.filestorage.force_resync.sync_status_resync_create() ``` @@ -20432,55 +21018,61 @@ client.crm.tasks.retrieve(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[TasksRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+## Filestorage Users +
client.filestorage.users.list(...)
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### πŸ“ Description
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
-
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. - +Returns a list of `User` objects.
+#### πŸ”Œ Usage - - -
+
+
-
client.crm.tasks.partial_update(...)
-#### πŸ“ Description +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.users.list() + +``` +
+
+
+
+ +#### βš™οΈ Parameters
@@ -20488,48 +21080,63 @@ client.crm.tasks.retrieve(
-Updates a `Task` object with the given `id`. +**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. +
-#### πŸ”Œ Usage -
+**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+
-```python -from merge import Merge -from merge.resources.crm import PatchedTaskRequest +**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/). + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.tasks.partial_update( - id="id", - model=PatchedTaskRequest(), -) +
+
-``` +**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). +
-#### βš™οΈ Parameters -
+**is_me:** `typing.Optional[str]` β€” If provided, will only return the user object for requestor. + +
+
+
-**id:** `str` +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -20537,7 +21144,7 @@ client.crm.tasks.partial_update(
-**model:** `PatchedTaskRequest` +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -20545,7 +21152,7 @@ client.crm.tasks.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -20553,7 +21160,7 @@ client.crm.tasks.partial_update(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -20573,7 +21180,7 @@ client.crm.tasks.partial_update(
-
client.crm.tasks.meta_patch_retrieve(...) +
client.filestorage.users.retrieve(...)
@@ -20585,7 +21192,7 @@ client.crm.tasks.partial_update(
-Returns metadata for `Task` PATCHs. +Returns a `User` object with the given `id`.
@@ -20606,7 +21213,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.meta_patch_retrieve( +client.filestorage.users.retrieve( id="id", ) @@ -20632,6 +21239,14 @@ client.crm.tasks.meta_patch_retrieve(
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -20644,7 +21259,8 @@ client.crm.tasks.meta_patch_retrieve(
-
client.crm.tasks.meta_post_retrieve() +## Filestorage WebhookReceivers +
client.filestorage.webhook_receivers.list()
@@ -20656,7 +21272,7 @@ client.crm.tasks.meta_patch_retrieve(
-Returns metadata for `Task` POSTs. +Returns a list of `WebhookReceiver` objects.
@@ -20677,7 +21293,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.meta_post_retrieve() +client.filestorage.webhook_receivers.list() ``` @@ -20705,7 +21321,7 @@ client.crm.tasks.meta_post_retrieve()
-
client.crm.tasks.remote_field_classes_list(...) +
client.filestorage.webhook_receivers.create(...)
@@ -20717,7 +21333,7 @@ client.crm.tasks.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Creates a `WebhookReceiver` object with the given values.
@@ -20738,7 +21354,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.remote_field_classes_list() +client.filestorage.webhook_receivers.create( + event="event", + is_active=True, +) ``` @@ -20754,7 +21373,7 @@ client.crm.tasks.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**event:** `str`
@@ -20762,7 +21381,7 @@ client.crm.tasks.remote_field_classes_list()
-**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/). +**is_active:** `bool`
@@ -20770,7 +21389,7 @@ client.crm.tasks.remote_field_classes_list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**key:** `typing.Optional[str]`
@@ -20778,31 +21397,133 @@ client.crm.tasks.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
+ + + + +
+## Ticketing AccountDetails +
client.ticketing.account_details.retrieve()
-**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). - +#### πŸ“ 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.ticketing.account_details.retrieve() + +``` +
+
+#### βš™οΈ Parameters +
-**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value +
+
+ +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+
+
+ + +
+
+
+## Ticketing AccountToken +
client.ticketing.account_token.retrieve(...)
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +#### πŸ“ 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.ticketing.account_token.retrieve( + public_token="public_token", +) + +``` +
+
+
+
+ +#### βš™οΈ Parameters + +
+
+ +
+
+ +**public_token:** `str`
@@ -20822,8 +21543,8 @@ client.crm.tasks.remote_field_classes_list()
-## Crm Users -
client.crm.users.list(...) +## Ticketing Accounts +
client.ticketing.accounts.list(...)
@@ -20835,7 +21556,7 @@ client.crm.tasks.remote_field_classes_list()
-Returns a list of `User` objects. +Returns a list of `Account` objects.
@@ -20856,7 +21577,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.list() +client.ticketing.accounts.list() ``` @@ -20912,14 +21633,6 @@ client.crm.users.list()
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **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).
@@ -20972,7 +21685,7 @@ client.crm.users.list()
-
client.crm.users.retrieve(...) +
client.ticketing.accounts.retrieve(...)
@@ -20984,7 +21697,7 @@ client.crm.users.list()
-Returns a `User` object with the given `id`. +Returns an `Account` object with the given `id`.
@@ -21005,7 +21718,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.retrieve( +client.ticketing.accounts.retrieve( id="id", ) @@ -21039,14 +21752,6 @@ client.crm.users.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -21059,7 +21764,8 @@ client.crm.users.retrieve(
-
client.crm.users.ignore_create(...) +## Ticketing AsyncPassthrough +
client.ticketing.async_passthrough.create(...)
@@ -21071,7 +21777,7 @@ client.crm.users.retrieve(
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -21087,16 +21793,16 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum +from merge.resources.ticketing import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.ignore_create( - model_id="model_id", - request=IgnoreCommonModelRequest( - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +client.ticketing.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", ), ) @@ -21114,15 +21820,7 @@ client.crm.users.ignore_create(
-**model_id:** `str` - -
-
- -
-
- -**request:** `IgnoreCommonModelRequest` +**request:** `DataPassthroughRequest`
@@ -21142,7 +21840,7 @@ client.crm.users.ignore_create(
-
client.crm.users.remote_field_classes_list(...) +
client.ticketing.async_passthrough.retrieve(...)
@@ -21154,7 +21852,7 @@ client.crm.users.ignore_create(
-Returns a list of `RemoteFieldClass` objects. +Retrieves data from earlier async-passthrough POST request
@@ -21175,7 +21873,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.remote_field_classes_list() +client.ticketing.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) ``` @@ -21191,55 +21891,7 @@ client.crm.users.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. - -
-
- -
-
- -**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_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**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). - -
-
- -
-
- -**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value - -
-
- -
-
- -**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**async_passthrough_receipt_id:** `str`
@@ -21259,8 +21911,8 @@ client.crm.users.remote_field_classes_list()
-## Crm WebhookReceivers -
client.crm.webhook_receivers.list() +## Ticketing Attachments +
client.ticketing.attachments.list(...)
@@ -21272,7 +21924,7 @@ client.crm.users.remote_field_classes_list()
-Returns a list of `WebhookReceiver` objects. +Returns a list of `Attachment` objects.
@@ -21293,7 +21945,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.list() +client.ticketing.attachments.list() ``` @@ -21309,71 +21961,87 @@ client.crm.webhook_receivers.list()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-
client.crm.webhook_receivers.create(...)
-#### πŸ“ Description +**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+**expand:** `typing.Optional[typing.Literal["ticket"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+
-Creates a `WebhookReceiver` object with the given values. -
-
+**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/). + -#### πŸ”Œ Usage -
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-```python -from merge import Merge +**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). + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.webhook_receivers.create( - event="event", - is_active=True, -) +
+
-``` +**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. +
-#### βš™οΈ Parameters -
+**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
+
-**event:** `str` +**remote_created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return attachments created in the third party platform after this datetime.
@@ -21381,7 +22049,7 @@ client.crm.webhook_receivers.create(
-**is_active:** `bool` +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -21389,7 +22057,7 @@ client.crm.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**ticket_id:** `typing.Optional[str]` β€” If provided, will only return comments for this ticket.
@@ -21409,8 +22077,7 @@ client.crm.webhook_receivers.create(
-## Hris AccountDetails -
client.hris.account_details.retrieve() +
client.ticketing.attachments.create(...)
@@ -21422,7 +22089,7 @@ client.crm.webhook_receivers.create(
-Get details for a linked account. +Creates an `Attachment` object with the given values.
@@ -21438,12 +22105,15 @@ Get details for a linked account. ```python from merge import Merge +from merge.resources.ticketing import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_details.retrieve() +client.ticketing.attachments.create( + model=AttachmentRequest(), +) ``` @@ -21459,6 +22129,30 @@ client.hris.account_details.retrieve()
+**model:** `AttachmentRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -21471,8 +22165,7 @@ client.hris.account_details.retrieve()
-## Hris AccountToken -
client.hris.account_token.retrieve(...) +
client.ticketing.attachments.retrieve(...)
@@ -21484,7 +22177,7 @@ client.hris.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Returns an `Attachment` object with the given `id`.
@@ -21505,8 +22198,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_token.retrieve( - public_token="public_token", +client.ticketing.attachments.retrieve( + id="id", ) ``` @@ -21523,7 +22216,23 @@ client.hris.account_token.retrieve(
-**public_token:** `str` +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["ticket"]]` β€” 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.
@@ -21543,8 +22252,7 @@ client.hris.account_token.retrieve(
-## Hris AsyncPassthrough -
client.hris.async_passthrough.create(...) +
client.ticketing.attachments.download_retrieve(...)
@@ -21556,7 +22264,7 @@ client.hris.account_token.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns the `File` content with the given `id` as a stream of bytes.
@@ -21572,17 +22280,14 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.ticketing.attachments.download_retrieve( + id="string", + mime_type="string", ) ``` @@ -21599,7 +22304,15 @@ client.hris.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**id:** `str` + +
+
+ +
+
+ +**mime_type:** `typing.Optional[str]` β€” If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article.
@@ -21619,7 +22332,7 @@ client.hris.async_passthrough.create(
-
client.hris.async_passthrough.retrieve(...) +
client.ticketing.attachments.meta_post_retrieve()
@@ -21631,7 +22344,7 @@ client.hris.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Returns metadata for `TicketingAttachment` POSTs.
@@ -21652,9 +22365,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) +client.ticketing.attachments.meta_post_retrieve() ``` @@ -21670,14 +22381,6 @@ client.hris.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -21690,8 +22393,8 @@ client.hris.async_passthrough.retrieve(
-## Hris AuditTrail -
client.hris.audit_trail.list(...) +## Ticketing AuditTrail +
client.ticketing.audit_trail.list(...)
@@ -21724,7 +22427,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.audit_trail.list() +client.ticketing.audit_trail.list() ```
@@ -21800,8 +22503,8 @@ client.hris.audit_trail.list()
-## Hris AvailableActions -
client.hris.available_actions.retrieve() +## Ticketing AvailableActions +
client.ticketing.available_actions.retrieve()
@@ -21834,7 +22537,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.available_actions.retrieve() +client.ticketing.available_actions.retrieve() ```
@@ -21862,8 +22565,8 @@ client.hris.available_actions.retrieve()
-## Hris BankInfo -
client.hris.bank_info.list(...) +## Ticketing Collections +
client.ticketing.collections.list(...)
@@ -21875,7 +22578,7 @@ client.hris.available_actions.retrieve()
-Returns a list of `BankInfo` objects. +Returns a list of `Collection` objects.
@@ -21896,7 +22599,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.list() +client.ticketing.collections.list() ``` @@ -21912,20 +22615,7 @@ client.hris.bank_info.list()
-**account_type:** `typing.Optional[BankInfoListRequestAccountType]` - -If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') - -- `SAVINGS` - SAVINGS -- `CHECKING` - CHECKING - -
-
- -
-
- -**bank_name:** `typing.Optional[str]` β€” If provided, will only return BankInfo's with this bank name. +**collection_type:** `typing.Optional[str]` β€” If provided, will only return collections of the given type.
@@ -21957,15 +22647,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**employee_id:** `typing.Optional[str]` β€” If provided, will only return bank accounts for this employee. - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["employee"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["parent_collection"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22013,7 +22695,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` β€” Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -22021,7 +22703,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**parent_collection_id:** `typing.Optional[str]` β€” If provided, will only return collections whose parent collection matches the given id.
@@ -22029,7 +22711,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` β€” Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` β€” Deprecated. Use show_enum_origins.
@@ -22045,7 +22727,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**show_enum_origins:** `typing.Optional[typing.Literal["account_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) +**show_enum_origins:** `typing.Optional[typing.Literal["collection_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)
@@ -22065,7 +22747,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
client.hris.bank_info.retrieve(...) +
client.ticketing.collections.retrieve(...)
@@ -22077,7 +22759,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-Returns a `BankInfo` object with the given `id`. +Returns a `Collection` object with the given `id`.
@@ -22098,7 +22780,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.retrieve( +client.ticketing.collections.retrieve( id="id", ) @@ -22124,7 +22806,7 @@ client.hris.bank_info.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["parent_collection"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22140,7 +22822,7 @@ client.hris.bank_info.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` β€” Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` β€” Deprecated. Use show_enum_origins.
@@ -22148,7 +22830,7 @@ client.hris.bank_info.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["account_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) +**show_enum_origins:** `typing.Optional[typing.Literal["collection_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)
@@ -22168,8 +22850,7 @@ client.hris.bank_info.retrieve(
-## Hris Benefits -
client.hris.benefits.list(...) +
client.ticketing.collections.users_list(...)
@@ -22181,7 +22862,7 @@ client.hris.bank_info.retrieve(
-Returns a list of `Benefit` objects. +Returns a list of `User` objects.
@@ -22202,7 +22883,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.list() +client.ticketing.collections.users_list( + parent_id="parent_id", +) ``` @@ -22218,15 +22901,7 @@ client.hris.benefits.list()
-**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. +**parent_id:** `str`
@@ -22242,15 +22917,7 @@ client.hris.benefits.list()
-**employee_id:** `typing.Optional[str]` β€” If provided, will return the benefits associated with the employee. - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["employee"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[CollectionsUsersListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22282,22 +22949,6 @@ client.hris.benefits.list()
-**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.
@@ -22306,14 +22957,6 @@ client.hris.benefits.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -22326,7 +22969,8 @@ client.hris.benefits.list()
-
client.hris.benefits.retrieve(...) +## Ticketing Comments +
client.ticketing.comments.list(...)
@@ -22338,7 +22982,7 @@ client.hris.benefits.list()
-Returns a `Benefit` object with the given `id`. +Returns a list of `Comment` objects.
@@ -22359,9 +23003,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.retrieve( - id="id", -) +client.ticketing.comments.list() ``` @@ -22377,93 +23019,15 @@ client.hris.benefits.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["employee"]]` β€” 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. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
- -
- - - - -
- -## Hris Companies -
client.hris.companies.list(...) -
-
- -#### πŸ“ Description - -
-
- -
-
- -Returns a list of `Company` objects. -
-
-
-
- -#### πŸ”Œ Usage - -
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.companies.list() - -``` -
-
-
-
- -#### βš™οΈ 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.
@@ -22471,7 +23035,7 @@ client.hris.companies.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -22479,7 +23043,7 @@ client.hris.companies.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**expand:** `typing.Optional[CommentsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22535,304 +23099,23 @@ client.hris.companies.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.hris.companies.retrieve(...) -
-
- -#### πŸ“ Description - -
-
- -
-
- -Returns a `Company` object with the given `id`. -
-
-
-
- -#### πŸ”Œ Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.companies.retrieve( - id="id", -) - -``` -
-
-
-
- -#### βš™οΈ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Hris Scopes -
client.hris.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.hris.scopes.default_scopes_retrieve() - -``` -
-
-
-
- -#### βš™οΈ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**remote_created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return Comments created in the third party platform after this datetime.
-
-
- - -
-
-
- -
client.hris.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.hris.scopes.linked_account_scopes_retrieve() - -``` -
-
-
-
- -#### βš™οΈ Parameters
-
-
- -**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
-
-
- - -
-
-
- -
client.hris.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.hris import ( - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - ), - 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 +**ticket_id:** `typing.Optional[str]` β€” If provided, will only return comments for this ticket.
@@ -22852,8 +23135,7 @@ client.hris.scopes.linked_account_scopes_create(
-## Hris DeleteAccount -
client.hris.delete_account.delete() +
client.ticketing.comments.create(...)
@@ -22865,7 +23147,7 @@ client.hris.scopes.linked_account_scopes_create(
-Delete a linked account. +Creates a `Comment` object with the given values.
@@ -22881,74 +23163,15 @@ Delete a linked account. ```python from merge import Merge +from merge.resources.ticketing import CommentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.delete_account.delete() - -``` - -
- - - -#### βš™οΈ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. - -
-
-
-
- - - - -
- -## Hris Dependents -
client.hris.dependents.list(...) -
-
- -#### πŸ“ Description - -
-
- -
-
- -Returns a list of `Dependent` objects. -
-
-
-
- -#### πŸ”Œ Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", +client.ticketing.comments.create( + model=CommentRequest(), ) -client.hris.dependents.list() ```
@@ -22964,71 +23187,7 @@ client.hris.dependents.list()
-**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. - -
-
- -
-
- -**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_sensitive_fields:** `typing.Optional[bool]` β€” Whether to include sensitive fields (such as social security numbers) in the response. - -
-
- -
-
- -**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. +**model:** `CommentRequest`
@@ -23036,7 +23195,7 @@ client.hris.dependents.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -23044,7 +23203,7 @@ client.hris.dependents.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -23064,7 +23223,7 @@ client.hris.dependents.list()
-
client.hris.dependents.retrieve(...) +
client.ticketing.comments.retrieve(...)
@@ -23076,7 +23235,7 @@ client.hris.dependents.list()
-Returns a `Dependent` object with the given `id`. +Returns a `Comment` object with the given `id`.
@@ -23097,7 +23256,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.retrieve( +client.ticketing.comments.retrieve( id="id", ) @@ -23123,7 +23282,7 @@ client.hris.dependents.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23131,7 +23290,7 @@ client.hris.dependents.retrieve(
-**include_sensitive_fields:** `typing.Optional[bool]` β€” Whether to include sensitive fields (such as social security numbers) in the response. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23151,8 +23310,7 @@ client.hris.dependents.retrieve(
-## Hris EmployeePayrollRuns -
client.hris.employee_payroll_runs.list(...) +
client.ticketing.comments.meta_post_retrieve()
@@ -23164,7 +23322,7 @@ client.hris.dependents.retrieve(
-Returns a list of `EmployeePayrollRun` objects. +Returns metadata for `Comment` POSTs.
@@ -23185,7 +23343,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.list() +client.ticketing.comments.meta_post_retrieve() ``` @@ -23201,55 +23359,69 @@ client.hris.employee_payroll_runs.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. -
+
+## Ticketing Contacts +
client.ticketing.contacts.list(...)
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. - -
-
+#### πŸ“ Description
-**employee_id:** `typing.Optional[str]` β€” If provided, will only return employee payroll runs for this employee. - -
-
-
-**ended_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return employee payroll runs ended after this datetime. - +Returns a list of `Contact` objects. +
+
+#### πŸ”Œ Usage +
-**ended_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return employee payroll runs ended before this datetime. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.contacts.list() + +``` +
+
+#### βš™οΈ Parameters +
-**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
+
+ +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -23257,7 +23429,7 @@ client.hris.employee_payroll_runs.list()
-**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/). +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -23265,7 +23437,7 @@ client.hris.employee_payroll_runs.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -23273,7 +23445,7 @@ client.hris.employee_payroll_runs.list()
-**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). +**expand:** `typing.Optional[typing.Literal["account"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23281,7 +23453,7 @@ client.hris.employee_payroll_runs.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**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/).
@@ -23289,7 +23461,7 @@ client.hris.employee_payroll_runs.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23297,7 +23469,7 @@ client.hris.employee_payroll_runs.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**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).
@@ -23305,7 +23477,7 @@ client.hris.employee_payroll_runs.list()
-**payroll_run_id:** `typing.Optional[str]` β€” If provided, will only return employee payroll runs for this employee. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -23313,7 +23485,7 @@ client.hris.employee_payroll_runs.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -23321,7 +23493,7 @@ client.hris.employee_payroll_runs.list()
-**started_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return employee payroll runs started after this datetime. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -23329,7 +23501,7 @@ client.hris.employee_payroll_runs.list()
-**started_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return employee payroll runs started before this datetime. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -23349,7 +23521,7 @@ client.hris.employee_payroll_runs.list()
-
client.hris.employee_payroll_runs.retrieve(...) +
client.ticketing.contacts.create(...)
@@ -23361,7 +23533,7 @@ client.hris.employee_payroll_runs.list()
-Returns an `EmployeePayrollRun` object with the given `id`. +Creates a `Contact` object with the given values.
@@ -23377,13 +23549,14 @@ Returns an `EmployeePayrollRun` object with the given `id`. ```python from merge import Merge +from merge.resources.ticketing import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.retrieve( - id="id", +client.ticketing.contacts.create( + model=ContactRequest(), ) ``` @@ -23400,7 +23573,7 @@ client.hris.employee_payroll_runs.retrieve(
-**id:** `str` +**model:** `ContactRequest`
@@ -23408,7 +23581,7 @@ client.hris.employee_payroll_runs.retrieve(
-**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -23416,7 +23589,7 @@ client.hris.employee_payroll_runs.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -23436,8 +23609,7 @@ client.hris.employee_payroll_runs.retrieve(
-## Hris Employees -
client.hris.employees.list(...) +
client.ticketing.contacts.retrieve(...)
@@ -23449,7 +23621,7 @@ client.hris.employee_payroll_runs.retrieve(
-Returns a list of `Employee` objects. +Returns a `Contact` object with the given `id`.
@@ -23470,7 +23642,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.list() +client.ticketing.contacts.retrieve( + id="id", +) ``` @@ -23486,7 +23660,7 @@ client.hris.employees.list()
-**company_id:** `typing.Optional[str]` β€” If provided, will only return employees for this company. +**id:** `str`
@@ -23494,7 +23668,7 @@ client.hris.employees.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**expand:** `typing.Optional[typing.Literal["account"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23502,7 +23676,7 @@ client.hris.employees.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23510,245 +23684,278 @@ client.hris.employees.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**display_full_name:** `typing.Optional[str]` β€” If provided, will only return employees with this display name. -
+
+
client.ticketing.contacts.meta_post_retrieve()
-**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` - -If provided, will only return employees with this employment status. +#### πŸ“ Description -- `ACTIVE` - ACTIVE -- `PENDING` - PENDING -- `INACTIVE` - INACTIVE - -
-
+
+
-**employment_type:** `typing.Optional[str]` β€” If provided, will only return employees that have an employment of the specified employment_type. - +Returns metadata for `TicketingContact` POSTs. +
+
+#### πŸ”Œ Usage +
-**expand:** `typing.Optional[EmployeesListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
-
-**first_name:** `typing.Optional[str]` β€” If provided, will only return employees with this first name. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.contacts.meta_post_retrieve() + +``` +
+
+#### βš™οΈ Parameters +
-**groups:** `typing.Optional[str]` β€” If provided, will only return employees matching the group ids; multiple groups can be separated by commas. - -
-
-
-**home_location_id:** `typing.Optional[str]` β€” If provided, will only return employees for this home location. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ + -
-
-**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/). -
+
+## Ticketing Scopes +
client.ticketing.scopes.default_scopes_retrieve()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### πŸ“ Description
-**include_sensitive_fields:** `typing.Optional[bool]` β€” Whether to include sensitive fields (such as social security numbers) in the response. - -
-
-
-**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). - +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 +
-**job_title:** `typing.Optional[str]` β€” If provided, will only return employees that have an employment of the specified job_title. - -
-
-
-**last_name:** `typing.Optional[str]` β€” If provided, will only return employees with this last name. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.scopes.default_scopes_retrieve() + +```
+ + + +#### βš™οΈ Parameters
-**manager_id:** `typing.Optional[str]` β€” If provided, will only return employees for this manager. - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ + -
-
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. -
+
+
client.ticketing.scopes.linked_account_scopes_retrieve()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - -
-
+#### πŸ“ Description
-**pay_group_id:** `typing.Optional[str]` β€” If provided, will only return employees for this pay group - -
-
-
-**personal_email:** `typing.Optional[str]` β€” If provided, will only return Employees with this personal email - +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
-**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. - -
-
-
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.scopes.linked_account_scopes_retrieve() + +``` +
+
+#### βš™οΈ Parameters +
-**show_enum_origins:** `typing.Optional[EmployeesListRequestShowEnumOrigins]` β€” 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) - -
-
-
-**started_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return employees that started after this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ + -
-
-**started_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return employees that started before this datetime. -
+
+
client.ticketing.scopes.linked_account_scopes_create(...)
-**team_id:** `typing.Optional[str]` β€” If provided, will only return employees for this team. - -
-
+#### πŸ“ Description
-**terminated_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return employees that were terminated after this datetime. - -
-
-
-**terminated_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return employees that were terminated before this datetime. - +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 +
-**work_email:** `typing.Optional[str]` β€” If provided, will only return Employees with this work email - +
+
+ +```python +from merge import Merge +from merge.resources.ticketing import ( + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], +) + +``` +
+
+#### βš™οΈ Parameters +
-**work_location_id:** `typing.Optional[str]` β€” If provided, will only return employees for this location. +
+
+ +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β€” The common models you want to update the scopes for
@@ -23768,7 +23975,8 @@ If provided, will only return employees with this employment status.
-
client.hris.employees.create(...) +## Ticketing DeleteAccount +
client.ticketing.delete_account.delete()
@@ -23780,7 +23988,7 @@ If provided, will only return employees with this employment status.
-Creates an `Employee` object with the given values. +Delete a linked account.
@@ -23796,15 +24004,12 @@ Creates an `Employee` object with the given values. ```python from merge import Merge -from merge.resources.hris import EmployeeRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.create( - model=EmployeeRequest(), -) +client.ticketing.delete_account.delete() ``` @@ -23820,27 +24025,65 @@ client.hris.employees.create(
-**model:** `EmployeeRequest` +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
+ + + + +
+ +## Ticketing FieldMapping +
client.ticketing.field_mapping.field_mappings_retrieve() +
+
+ +#### πŸ“ Description
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. - +
+
+ +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 +
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.field_mappings_retrieve() + +``` +
+
+#### βš™οΈ Parameters + +
+
+
@@ -23856,7 +24099,7 @@ client.hris.employees.create(
-
client.hris.employees.retrieve(...) +
client.ticketing.field_mapping.field_mappings_create(...)
@@ -23868,7 +24111,7 @@ client.hris.employees.create(
-Returns an `Employee` object with the given `id`. +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.
@@ -23889,8 +24132,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.retrieve( - id="id", +client.ticketing.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", ) ``` @@ -23907,7 +24155,7 @@ client.hris.employees.retrieve(
-**id:** `str` +**target_field_name:** `str` β€” The name of the target field you want this remote field to map to.
@@ -23915,7 +24163,7 @@ client.hris.employees.retrieve(
-**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**target_field_description:** `str` β€” The description of the target field you want this remote field to map to.
@@ -23923,7 +24171,7 @@ client.hris.employees.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -23931,7 +24179,7 @@ client.hris.employees.retrieve(
-**include_sensitive_fields:** `typing.Optional[bool]` β€” Whether to include sensitive fields (such as social security numbers) in the response. +**remote_method:** `str` β€” The method of the remote endpoint where the remote field is coming from.
@@ -23939,7 +24187,7 @@ client.hris.employees.retrieve(
-**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**remote_url_path:** `str` β€” The path of the remote endpoint where the remote field is coming from.
@@ -23947,7 +24195,7 @@ client.hris.employees.retrieve(
-**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` β€” 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) +**common_model_name:** `str` β€” The name of the Common Model that the remote field corresponds to in a given category.
@@ -23967,7 +24215,7 @@ client.hris.employees.retrieve(
-
client.hris.employees.ignore_create(...) +
client.ticketing.field_mapping.field_mappings_destroy(...)
@@ -23979,7 +24227,7 @@ client.hris.employees.retrieve(
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +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.
@@ -23995,15 +24243,13 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.hris import ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.ignore_create( - model_id="model_id", - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +client.ticketing.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -24020,7 +24266,7 @@ client.hris.employees.ignore_create(
-**model_id:** `str` +**field_mapping_id:** `str`
@@ -24028,39 +24274,62 @@ client.hris.employees.ignore_create(
-**reason:** `IgnoreCommonModelRequestReason` +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**message:** `typing.Optional[str]` -
+
+
client.ticketing.field_mapping.field_mappings_partial_update(...)
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. - +#### πŸ“ 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 -
-
-
+
+
-
client.hris.employees.meta_post_retrieve()
-#### πŸ“ Description +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) + +``` +
+
+
+
+ +#### βš™οΈ Parameters
@@ -24068,40 +24337,35 @@ client.hris.employees.ignore_create(
-Returns metadata for `Employee` POSTs. -
-
+**field_mapping_id:** `str` +
-#### πŸ”Œ Usage -
+**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. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.employees.meta_post_retrieve() - -``` -
-
+**remote_method:** `typing.Optional[str]` β€” The method of the remote endpoint where the remote field is coming from. + -#### βš™οΈ Parameters -
+**remote_url_path:** `typing.Optional[str]` β€” The path of the remote endpoint where the remote field is coming from. + +
+
+
@@ -24117,8 +24381,7 @@ client.hris.employees.meta_post_retrieve()
-## Hris EmployerBenefits -
client.hris.employer_benefits.list(...) +
client.ticketing.field_mapping.remote_fields_retrieve(...)
@@ -24130,7 +24393,7 @@ client.hris.employees.meta_post_retrieve()
-Returns a list of `EmployerBenefit` objects. +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/).
@@ -24151,7 +24414,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.list() +client.ticketing.field_mapping.remote_fields_retrieve() ``` @@ -24167,7 +24430,7 @@ client.hris.employer_benefits.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**common_models:** `typing.Optional[str]` β€” A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -24175,7 +24438,7 @@ client.hris.employer_benefits.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**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.
@@ -24183,67 +24446,64 @@ client.hris.employer_benefits.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**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/). -
+
+
client.ticketing.field_mapping.target_fields_retrieve()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### πŸ“ Description
-**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. - +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
-**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. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.target_fields_retrieve() + +``` +
+
+#### βš™οΈ Parameters +
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
-
@@ -24259,7 +24519,8 @@ client.hris.employer_benefits.list()
-
client.hris.employer_benefits.retrieve(...) +## Ticketing GenerateKey +
client.ticketing.generate_key.create(...)
@@ -24271,7 +24532,7 @@ client.hris.employer_benefits.list()
-Returns an `EmployerBenefit` object with the given `id`. +Create a remote key.
@@ -24292,8 +24553,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.retrieve( - id="id", +client.ticketing.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -24310,15 +24571,7 @@ client.hris.employer_benefits.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**name:** `str` β€” The name of the remote key
@@ -24338,8 +24591,8 @@ client.hris.employer_benefits.retrieve(
-## Hris Employments -
client.hris.employments.list(...) +## Ticketing Issues +
client.ticketing.issues.list(...)
@@ -24351,7 +24604,7 @@ client.hris.employer_benefits.retrieve(
-Returns a list of `Employment` objects. +Gets all issues for Organization.
@@ -24372,7 +24625,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.list() +client.ticketing.issues.list() ``` @@ -24388,7 +24641,7 @@ client.hris.employments.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**account_token:** `typing.Optional[str]`
@@ -24396,7 +24649,7 @@ client.hris.employments.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -24404,7 +24657,7 @@ client.hris.employments.list()
-**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
@@ -24412,7 +24665,7 @@ client.hris.employments.list()
-**employee_id:** `typing.Optional[str]` β€” If provided, will only return employments for this employee. +**end_user_organization_name:** `typing.Optional[str]`
@@ -24420,7 +24673,7 @@ client.hris.employments.list()
-**expand:** `typing.Optional[EmploymentsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**first_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was after this datetime.
@@ -24428,7 +24681,7 @@ client.hris.employments.list()
-**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/). +**first_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was before this datetime.
@@ -24436,7 +24689,7 @@ client.hris.employments.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**include_muted:** `typing.Optional[str]` β€” If true, will include muted issues
@@ -24444,7 +24697,7 @@ client.hris.employments.list()
-**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). +**integration_name:** `typing.Optional[str]`
@@ -24452,7 +24705,7 @@ client.hris.employments.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +**last_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was after this datetime.
@@ -24460,7 +24713,7 @@ client.hris.employments.list()
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +**last_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was before this datetime.
@@ -24468,7 +24721,7 @@ client.hris.employments.list()
-**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` β€” Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. +**linked_account_id:** `typing.Optional[str]` β€” If provided, will only include issues pertaining to the linked account passed in.
@@ -24484,7 +24737,7 @@ client.hris.employments.list()
-**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**start_date:** `typing.Optional[str]` β€” If included, will only include issues whose most recent action occurred after this time
@@ -24492,15 +24745,12 @@ client.hris.employments.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
+**status:** `typing.Optional[IssuesListRequestStatus]` -
-
+Status of the issue. Options: ('ONGOING', 'RESOLVED') -**show_enum_origins:** `typing.Optional[EmploymentsListRequestShowEnumOrigins]` β€” 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) +- `ONGOING` - ONGOING +- `RESOLVED` - RESOLVED
@@ -24520,7 +24770,7 @@ client.hris.employments.list()
-
client.hris.employments.retrieve(...) +
client.ticketing.issues.retrieve(...)
@@ -24532,7 +24782,7 @@ client.hris.employments.list()
-Returns an `Employment` object with the given `id`. +Get a specific issue.
@@ -24553,7 +24803,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.retrieve( +client.ticketing.issues.retrieve( id="id", ) @@ -24579,38 +24829,6 @@ client.hris.employments.retrieve(
-**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` β€” 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. - -
-
- -
-
- -**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[EmploymentsRetrieveRequestShowEnumOrigins]` β€” 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.
@@ -24623,8 +24841,8 @@ client.hris.employments.retrieve(
-## Hris FieldMapping -
client.hris.field_mapping.field_mappings_retrieve() +## Ticketing LinkToken +
client.ticketing.link_token.create(...)
@@ -24636,7 +24854,7 @@ client.hris.employments.retrieve(
-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/). +Creates a link token to be used when linking a new end user.
@@ -24652,12 +24870,18 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw ```python from merge import Merge +from merge.resources.ticketing import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_retrieve() +client.ticketing.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], +) ``` @@ -24673,75 +24897,55 @@ client.hris.field_mapping.field_mappings_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-
client.hris.field_mapping.field_mappings_create(...)
-#### πŸ“ Description - -
-
+**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. + +
+
-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. -
-
+**categories:** `typing.Sequence[CategoriesEnum]` β€” The integration categories to show in Merge Link. +
-#### πŸ”Œ Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", -) - -``` -
-
+**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/. +
-#### βš™οΈ Parameters -
+**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. + +
+
+
-**target_field_name:** `str` β€” The name of the target field you want this remote field to map to. +**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.
@@ -24749,7 +24953,7 @@ client.hris.field_mapping.field_mappings_create(
-**target_field_description:** `str` β€” The description of the target field you want this remote field to map to. +**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.
@@ -24757,7 +24961,7 @@ client.hris.field_mapping.field_mappings_create(
-**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. +**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.
@@ -24765,7 +24969,14 @@ client.hris.field_mapping.field_mappings_create(
-**remote_method:** `str` β€” The method of the remote endpoint where the remote field is coming from. +**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.
@@ -24773,7 +24984,12 @@ client.hris.field_mapping.field_mappings_create(
-**remote_url_path:** `str` β€” The path of the remote endpoint where the remote field is coming from. +**language:** `typing.Optional[LanguageEnum]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de
@@ -24781,7 +24997,7 @@ client.hris.field_mapping.field_mappings_create(
-**common_model_name:** `str` β€” The name of the Common Model that the remote field corresponds to in a given category. +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β€” A JSON object containing integration-specific configuration options.
@@ -24801,7 +25017,8 @@ client.hris.field_mapping.field_mappings_create(
-
client.hris.field_mapping.field_mappings_destroy(...) +## Ticketing LinkedAccounts +
client.ticketing.linked_accounts.list(...)
@@ -24813,7 +25030,7 @@ client.hris.field_mapping.field_mappings_create(
-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. +List linked accounts for your organization.
@@ -24834,9 +25051,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.ticketing.linked_accounts.list() ``` @@ -24852,7 +25067,17 @@ client.hris.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**category:** `typing.Optional[LinkedAccountsListRequestCategory]` + +Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` + +- `hris` - hris +- `ats` - ats +- `accounting` - accounting +- `ticketing` - ticketing +- `crm` - crm +- `mktg` - mktg +- `filestorage` - filestorage
@@ -24860,70 +25085,71 @@ client.hris.field_mapping.field_mappings_destroy(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-
client.hris.field_mapping.field_mappings_partial_update(...)
-#### πŸ“ Description +**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. + +
+
+
-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. -
-
+**end_user_origin_ids:** `typing.Optional[str]` β€” Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. + -#### πŸ”Œ Usage -
+**id:** `typing.Optional[str]` + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", -) - -``` -
-
+**ids:** `typing.Optional[str]` β€” Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. + -#### βš™οΈ Parameters -
+**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. + +
+
+
-**field_mapping_id:** `str` +**integration_name:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given integration name.
@@ -24931,7 +25157,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-**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. +**is_test_account:** `typing.Optional[str]` β€” If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -24939,7 +25165,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` β€” The method of the remote endpoint where the remote field is coming from. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -24947,7 +25173,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` β€” The path of the remote endpoint where the remote field is coming from. +**status:** `typing.Optional[str]` β€” Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -24967,7 +25193,8 @@ client.hris.field_mapping.field_mappings_partial_update(
-
client.hris.field_mapping.remote_fields_retrieve(...) +## Ticketing Passthrough +
client.ticketing.passthrough.create(...)
@@ -24979,7 +25206,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-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/). +Pull data from an endpoint not currently supported by Merge.
@@ -24995,12 +25222,18 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields ```python from merge import Merge +from merge.resources.ticketing import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.remote_fields_retrieve() +client.ticketing.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -25016,15 +25249,7 @@ client.hris.field_mapping.remote_fields_retrieve()
-**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:** `DataPassthroughRequest`
@@ -25044,7 +25269,8 @@ client.hris.field_mapping.remote_fields_retrieve()
-
client.hris.field_mapping.target_fields_retrieve() +## Ticketing Projects +
client.ticketing.projects.list(...)
@@ -25056,7 +25282,7 @@ client.hris.field_mapping.remote_fields_retrieve()
-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/). +Returns a list of `Project` objects.
@@ -25077,7 +25303,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.target_fields_retrieve() +client.ticketing.projects.list() ``` @@ -25093,6 +25319,86 @@ client.hris.field_mapping.target_fields_retrieve()
+**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. + +
+
+ +
+
+ +**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. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -25105,8 +25411,7 @@ client.hris.field_mapping.target_fields_retrieve()
-## Hris GenerateKey -
client.hris.generate_key.create(...) +
client.ticketing.projects.retrieve(...)
@@ -25118,7 +25423,7 @@ client.hris.field_mapping.target_fields_retrieve()
-Create a remote key. +Returns a `Project` object with the given `id`.
@@ -25139,8 +25444,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.generate_key.create( - name="Remote Deployment Key 1", +client.ticketing.projects.retrieve( + id="id", ) ``` @@ -25157,7 +25462,15 @@ client.hris.generate_key.create(
-**name:** `str` β€” The name of the remote key +**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25177,8 +25490,7 @@ client.hris.generate_key.create(
-## Hris Groups -
client.hris.groups.list(...) +
client.ticketing.projects.users_list(...)
@@ -25190,7 +25502,7 @@ client.hris.generate_key.create(
-Returns a list of `Group` objects. +Returns a list of `User` objects.
@@ -25211,7 +25523,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.list() +client.ticketing.projects.users_list( + parent_id="parent_id", +) ``` @@ -25227,7 +25541,7 @@ client.hris.groups.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**parent_id:** `str`
@@ -25235,7 +25549,7 @@ client.hris.groups.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -25243,7 +25557,7 @@ client.hris.groups.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25275,38 +25589,6 @@ client.hris.groups.list()
-**is_commonly_used_as_team:** `typing.Optional[str]` β€” If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform. - -
-
- -
-
- -**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. - -
-
- -
-
- -**names:** `typing.Optional[str]` β€” If provided, will only return groups with these names. Multiple values can be separated by commas. - -
-
- -
-
- **page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -25315,38 +25597,6 @@ client.hris.groups.list()
-**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) - -
-
- -
-
- -**types:** `typing.Optional[str]` β€” If provided, will only return groups of these types. Multiple values can be separated by commas. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -25359,7 +25609,8 @@ client.hris.groups.list()
-
client.hris.groups.retrieve(...) +## Ticketing RegenerateKey +
client.ticketing.regenerate_key.create(...)
@@ -25371,7 +25622,7 @@ client.hris.groups.list()
-Returns a `Group` object with the given `id`. +Exchange remote keys.
@@ -25392,8 +25643,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.retrieve( - id="id", +client.ticketing.regenerate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -25410,31 +25661,7 @@ client.hris.groups.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**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) +**name:** `str` β€” The name of the remote key
@@ -25454,8 +25681,8 @@ client.hris.groups.retrieve(
-## Hris Issues -
client.hris.issues.list(...) +## Ticketing Roles +
client.ticketing.roles.list(...)
@@ -25467,7 +25694,7 @@ client.hris.groups.retrieve(
-Gets all issues for Organization. +Returns a list of `Role` objects.
@@ -25488,7 +25715,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.list() +client.ticketing.roles.list() ``` @@ -25504,31 +25731,7 @@ client.hris.issues.list()
-**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]` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -25536,7 +25739,7 @@ client.hris.issues.list()
-**first_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was after this datetime. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -25544,7 +25747,7 @@ client.hris.issues.list()
-**first_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose first incident time was before this datetime. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -25552,7 +25755,7 @@ client.hris.issues.list()
-**include_muted:** `typing.Optional[str]` β€” If true, will include muted issues +**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/).
@@ -25560,7 +25763,7 @@ client.hris.issues.list()
-**integration_name:** `typing.Optional[str]` +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25568,7 +25771,7 @@ client.hris.issues.list()
-**last_incident_time_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was after this datetime. +**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).
@@ -25576,7 +25779,7 @@ client.hris.issues.list()
-**last_incident_time_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return issues whose last incident time was before this datetime. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -25584,7 +25787,7 @@ client.hris.issues.list()
-**linked_account_id:** `typing.Optional[str]` β€” If provided, will only include issues pertaining to the linked account passed in. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -25600,20 +25803,7 @@ client.hris.issues.list()
-**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. Options: ('ONGOING', 'RESOLVED') - -- `ONGOING` - ONGOING -- `RESOLVED` - RESOLVED +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -25633,7 +25823,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.hris.issues.retrieve(...) +
client.ticketing.roles.retrieve(...)
@@ -25645,7 +25835,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns a `Role` object with the given `id`.
@@ -25666,7 +25856,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.retrieve( +client.ticketing.roles.retrieve( id="id", ) @@ -25692,6 +25882,14 @@ client.hris.issues.retrieve(
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -25704,8 +25902,8 @@ client.hris.issues.retrieve(
-## Hris LinkToken -
client.hris.link_token.create(...) +## Ticketing SyncStatus +
client.ticketing.sync_status.list(...)
@@ -25717,7 +25915,7 @@ client.hris.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Get syncing status. Possible values: `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).
@@ -25733,18 +25931,12 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.hris import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.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], -) +client.ticketing.sync_status.list() ``` @@ -25760,7 +25952,7 @@ client.hris.link_token.create(
-**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. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -25768,7 +25960,7 @@ client.hris.link_token.create(
-**end_user_organization_name:** `str` β€” Your end user's organization. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -25776,95 +25968,65 @@ client.hris.link_token.create(
-**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. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**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/. -
+
+## Ticketing ForceResync +
client.ticketing.force_resync.sync_status_resync_create()
-**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. - -
-
+#### πŸ“ Description
-**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. - +Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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.
- -
-
- -**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. -
+#### πŸ”Œ Usage +
-**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[LanguageEnum]` +```python +from merge import Merge -The following subset of IETF language tags can be used to configure localization. +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.force_resync.sync_status_resync_create() -* `en` - en -* `de` - de - +```
+ + + +#### βš™οΈ Parameters
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β€” A JSON object containing integration-specific configuration options. - -
-
-
@@ -25880,8 +26042,8 @@ The following subset of IETF language tags can be used to configure localization
-## Hris LinkedAccounts -
client.hris.linked_accounts.list(...) +## Ticketing Tags +
client.ticketing.tags.list(...)
@@ -25893,7 +26055,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a list of `Tag` objects.
@@ -25914,7 +26076,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.linked_accounts.list() +client.ticketing.tags.list() ``` @@ -25930,17 +26092,15 @@ client.hris.linked_accounts.list()
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. + +
+
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` +
+
-- `hris` - hris -- `ats` - ats -- `accounting` - accounting -- `ticketing` - ticketing -- `crm` - crm -- `mktg` - mktg -- `filestorage` - filestorage +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -25956,7 +26116,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_email_address:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given email address. +**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/).
@@ -25964,7 +26124,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_organization_name:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given organization name. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25972,7 +26132,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_id:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given origin ID. +**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).
@@ -25980,7 +26140,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_ids:** `typing.Optional[str]` β€” Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -25988,7 +26148,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -25996,7 +26156,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**ids:** `typing.Optional[str]` β€” Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -26004,7 +26164,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**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. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -26012,23 +26172,70 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` β€” If provided, will only return linked accounts associated with the given integration name. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
+ + + +
+ +
client.ticketing.tags.retrieve(...)
-**is_test_account:** `typing.Optional[str]` β€” If included, will only include test linked accounts. If not included, will only include non-test linked accounts. - +#### πŸ“ Description + +
+
+ +
+
+ +Returns a `Tag` object with the given `id`. +
+
+#### πŸ”Œ Usage +
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.tags.retrieve( + id="id", +) + +``` +
+
+
+
+ +#### βš™οΈ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -26036,7 +26243,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` β€” Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26056,8 +26263,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Hris Locations -
client.hris.locations.list(...) +## Ticketing Teams +
client.ticketing.teams.list(...)
@@ -26069,7 +26276,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Location` objects. +Returns a list of `Team` objects.
@@ -26090,7 +26297,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.list() +client.ticketing.teams.list() ``` @@ -26154,19 +26361,6 @@ client.hris.locations.list()
-**location_type:** `typing.Optional[LocationsListRequestLocationType]` - -If provided, will only return locations with this location_type - -- `HOME` - HOME -- `WORK` - WORK - -
-
- -
-
- **modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -26191,14 +26385,6 @@ If provided, will only return locations with this location_type
-**remote_fields:** `typing.Optional[typing.Literal["location_type"]]` β€” Deprecated. Use show_enum_origins. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -26207,14 +26393,6 @@ If provided, will only return locations with this location_type
-**show_enum_origins:** `typing.Optional[typing.Literal["location_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.
@@ -26227,7 +26405,7 @@ If provided, will only return locations with this location_type
-
client.hris.locations.retrieve(...) +
client.ticketing.teams.retrieve(...)
@@ -26239,7 +26417,7 @@ If provided, will only return locations with this location_type
-Returns a `Location` object with the given `id`. +Returns a `Team` object with the given `id`.
@@ -26260,7 +26438,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.retrieve( +client.ticketing.teams.retrieve( id="id", ) @@ -26294,22 +26472,6 @@ client.hris.locations.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["location_type"]]` β€” Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["location_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.
@@ -26322,8 +26484,8 @@ client.hris.locations.retrieve(
-## Hris Passthrough -
client.hris.passthrough.create(...) +## Ticketing Tickets +
client.ticketing.tickets.list(...)
@@ -26335,7 +26497,7 @@ client.hris.locations.retrieve(
-Pull data from an endpoint not currently supported by Merge. +Returns a list of `Ticket` objects.
@@ -26351,18 +26513,12 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) +client.ticketing.tickets.list() ``` @@ -26378,7 +26534,7 @@ client.hris.passthrough.create(
-**request:** `DataPassthroughRequest` +**account_id:** `typing.Optional[str]` β€” If provided, will only return tickets for this account.
@@ -26386,69 +26542,71 @@ client.hris.passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**assignee_ids:** `typing.Optional[str]` β€” If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas.
- -
+
+
+**collection_ids:** `typing.Optional[str]` β€” If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas. +
-
-## Hris PayGroups -
client.hris.pay_groups.list(...)
-#### πŸ“ Description +**completed_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets completed after this datetime. + +
+
+**completed_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets completed before this datetime. + +
+
+
-Returns a list of `PayGroup` objects. -
-
+**contact_id:** `typing.Optional[str]` β€” If provided, will only return tickets for this contact. + -#### πŸ”Œ Usage -
+**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.pay_groups.list() - -``` -
-
+**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. + -#### βš™οΈ Parameters -
+**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**due_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets due after this datetime.
@@ -26456,7 +26614,7 @@ client.hris.pay_groups.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**due_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets due before this datetime.
@@ -26464,7 +26622,7 @@ client.hris.pay_groups.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**expand:** `typing.Optional[TicketsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -26488,6 +26646,14 @@ client.hris.pay_groups.list()
+**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **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).
@@ -26520,7 +26686,7 @@ client.hris.pay_groups.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**parent_ticket_id:** `typing.Optional[str]` β€” If provided, will only return sub tickets of the parent_ticket_id.
@@ -26528,70 +26694,101 @@ client.hris.pay_groups.list()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**priority:** `typing.Optional[TicketsListRequestPriority]` + +If provided, will only return tickets of this priority. + +- `URGENT` - URGENT +- `HIGH` - HIGH +- `NORMAL` - NORMAL +- `LOW` - LOW
+ +
+
+ +**remote_created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets created in the third party platform after this datetime. +
+
+
+**remote_created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets created in the third party platform before this datetime. +
-
-
client.hris.pay_groups.retrieve(...)
-#### πŸ“ Description +**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. + +
+
+**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. + +
+
+
-Returns a `PayGroup` object with the given `id`. +**remote_updated_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets updated in the third party platform after this datetime. +
+ +
+
+ +**remote_updated_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets updated in the third party platform before this datetime. +
-#### πŸ”Œ Usage -
+**show_enum_origins:** `typing.Optional[TicketsListRequestShowEnumOrigins]` β€” 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) + +
+
+
-```python -from merge import Merge +**status:** `typing.Optional[TicketsListRequestStatus]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.pay_groups.retrieve( - id="id", -) +If provided, will only return tickets of this status. -``` -
-
+- `OPEN` - OPEN +- `CLOSED` - CLOSED +- `IN_PROGRESS` - IN_PROGRESS +- `ON_HOLD` - ON_HOLD + -#### βš™οΈ Parameters -
+**tags:** `typing.Optional[str]` β€” If provided, will only return tickets matching the tags; multiple tags can be separated by commas. + +
+
+
-**id:** `str` +**ticket_type:** `typing.Optional[str]` β€” If provided, will only return tickets of this type.
@@ -26599,7 +26796,7 @@ client.hris.pay_groups.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**ticket_url:** `typing.Optional[str]` β€” If provided, will only return tickets where the URL matches or contains the substring
@@ -26619,8 +26816,7 @@ client.hris.pay_groups.retrieve(
-## Hris PayrollRuns -
client.hris.payroll_runs.list(...) +
client.ticketing.tickets.create(...)
@@ -26632,7 +26828,7 @@ client.hris.pay_groups.retrieve(
-Returns a list of `PayrollRun` objects. +Creates a `Ticket` object with the given values.
@@ -26648,12 +26844,15 @@ Returns a list of `PayrollRun` objects. ```python from merge import Merge +from merge.resources.ticketing import TicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.list() +client.ticketing.tickets.create( + model=TicketRequest(), +) ``` @@ -26669,7 +26868,7 @@ client.hris.payroll_runs.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**model:** `TicketRequest`
@@ -26677,7 +26876,7 @@ client.hris.payroll_runs.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -26685,7 +26884,7 @@ client.hris.payroll_runs.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -26693,71 +26892,70 @@ client.hris.payroll_runs.list()
-**ended_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return payroll runs ended after this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**ended_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return payroll runs ended before this datetime. -
+
+
client.ticketing.tickets.retrieve(...)
-**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/). - -
-
+#### πŸ“ Description
-**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). - +Returns a `Ticket` object with the given `id`.
+ + + +#### πŸ”Œ Usage
-**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. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.tickets.retrieve( + id="id", +) + +``` +
+
+#### βš™οΈ Parameters +
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - -
-
-
-**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**id:** `str`
@@ -26765,7 +26963,7 @@ client.hris.payroll_runs.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -26773,15 +26971,7 @@ client.hris.payroll_runs.list()
-**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` - -If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') - -- `REGULAR` - REGULAR -- `OFF_CYCLE` - OFF_CYCLE -- `CORRECTION` - CORRECTION -- `TERMINATION` - TERMINATION -- `SIGN_ON_BONUS` - SIGN_ON_BONUS +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26789,7 +26979,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**show_enum_origins:** `typing.Optional[PayrollRunsListRequestShowEnumOrigins]` β€” 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) +**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -26797,7 +26987,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**started_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return payroll runs started after this datetime. +**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins.
@@ -26805,7 +26995,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**started_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return payroll runs started before this datetime. +**show_enum_origins:** `typing.Optional[TicketsRetrieveRequestShowEnumOrigins]` β€” 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)
@@ -26825,7 +27015,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-
client.hris.payroll_runs.retrieve(...) +
client.ticketing.tickets.partial_update(...)
@@ -26837,7 +27027,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-Returns a `PayrollRun` object with the given `id`. +Updates a `Ticket` object with the given `id`.
@@ -26853,13 +27043,15 @@ Returns a `PayrollRun` object with the given `id`. ```python from merge import Merge +from merge.resources.ticketing import PatchedTicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.retrieve( +client.ticketing.tickets.partial_update( id="id", + model=PatchedTicketRequest(), ) ``` @@ -26884,7 +27076,7 @@ client.hris.payroll_runs.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**model:** `PatchedTicketRequest`
@@ -26892,7 +27084,7 @@ client.hris.payroll_runs.retrieve(
-**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -26900,7 +27092,7 @@ client.hris.payroll_runs.retrieve(
-**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` β€” 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) +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -26920,8 +27112,7 @@ client.hris.payroll_runs.retrieve(
-## Hris RegenerateKey -
client.hris.regenerate_key.create(...) +
client.ticketing.tickets.collaborators_list(...)
@@ -26933,7 +27124,7 @@ client.hris.payroll_runs.retrieve(
-Exchange remote keys. +Returns a list of `User` objects.
@@ -26954,8 +27145,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.regenerate_key.create( - name="Remote Deployment Key 1", +client.ticketing.tickets.collaborators_list( + parent_id="parent_id", ) ``` @@ -26972,7 +27163,7 @@ client.hris.regenerate_key.create(
-**name:** `str` β€” The name of the remote key +**parent_id:** `str`
@@ -26980,69 +27171,39 @@ client.hris.regenerate_key.create(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
- -
- - - - -
-## Hris SyncStatus -
client.hris.sync_status.list(...)
-#### πŸ“ Description - -
-
+**expand:** `typing.Optional[TicketsCollaboratorsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
-Get syncing status. Possible values: `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). -
-
+**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/). +
-#### πŸ”Œ Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.sync_status.list() - -``` -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### βš™οΈ Parameters - -
-
-
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**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).
@@ -27070,8 +27231,7 @@ client.hris.sync_status.list()
-## Hris ForceResync -
client.hris.force_resync.sync_status_resync_create() +
client.ticketing.tickets.meta_patch_retrieve(...)
@@ -27083,7 +27243,7 @@ client.hris.sync_status.list()
-Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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. +Returns metadata for `Ticket` PATCHs.
@@ -27104,7 +27264,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.force_resync.sync_status_resync_create() +client.ticketing.tickets.meta_patch_retrieve( + id="id", +) ``` @@ -27120,6 +27282,14 @@ client.hris.force_resync.sync_status_resync_create()
+**id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -27132,8 +27302,7 @@ client.hris.force_resync.sync_status_resync_create()
-## Hris Teams -
client.hris.teams.list(...) +
client.ticketing.tickets.meta_post_retrieve()
@@ -27145,7 +27314,7 @@ client.hris.force_resync.sync_status_resync_create()
-Returns a list of `Team` objects. +Returns metadata for `Ticket` POSTs.
@@ -27166,7 +27335,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.list() +client.ticketing.tickets.meta_post_retrieve() ``` @@ -27182,166 +27351,92 @@ client.hris.teams.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. -
-
-
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. -
+
+
client.ticketing.tickets.remote_field_classes_list(...)
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
+#### πŸ“ Description
-**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. - +Returns a list of `RemoteFieldClass` objects.
- -
-
- -**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). -
+#### πŸ”Œ Usage +
-**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. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.tickets.remote_field_classes_list() -**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - +```
- -
-
- -**parent_team_id:** `typing.Optional[str]` β€” If provided, will only return teams with this parent team. -
+#### βš™οΈ Parameters +
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
-
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
- - - - - - -
- -
client.hris.teams.retrieve(...) -
-
- -#### πŸ“ Description - -
-
-Returns a `Team` object with the given `id`. -
-
+**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/). +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.teams.retrieve( - id="id", -) - -``` -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### βš™οΈ Parameters - -
-
-
-**id:** `str` +**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).
@@ -27349,7 +27444,7 @@ client.hris.teams.retrieve(
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value
@@ -27357,7 +27452,7 @@ client.hris.teams.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -27377,8 +27472,8 @@ client.hris.teams.retrieve(
-## Hris TimeOff -
client.hris.time_off.list(...) +## Ticketing Users +
client.ticketing.users.list(...)
@@ -27390,7 +27485,7 @@ client.hris.teams.retrieve(
-Returns a list of `TimeOff` objects. +Returns a list of `User` objects.
@@ -27411,7 +27506,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.list() +client.ticketing.users.list() ``` @@ -27427,14 +27522,6 @@ client.hris.time_off.list()
-**approver_id:** `typing.Optional[str]` β€” If provided, will only return time off for this approver. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -27459,23 +27546,7 @@ client.hris.time_off.list()
-**employee_id:** `typing.Optional[str]` β€” If provided, will only return time off for this employee. - -
-
- -
-
- -**ended_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return employees that ended after this datetime. - -
-
- -
-
- -**ended_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return time-offs that ended before this datetime. +**email_address:** `typing.Optional[str]` β€” If provided, will only return users with emails equal to this value (case insensitive).
@@ -27483,7 +27554,7 @@ client.hris.time_off.list()
-**expand:** `typing.Optional[TimeOffListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[UsersListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -27539,7 +27610,7 @@ client.hris.time_off.list()
-**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -27547,40 +27618,70 @@ client.hris.time_off.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
+ + +
+
+ +
client.ticketing.users.retrieve(...)
-**request_type:** `typing.Optional[TimeOffListRequestRequestType]` +#### πŸ“ Description -If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') +
+
-- `VACATION` - VACATION -- `SICK` - SICK -- `PERSONAL` - PERSONAL -- `JURY_DUTY` - JURY_DUTY -- `VOLUNTEER` - VOLUNTEER -- `BEREAVEMENT` - BEREAVEMENT - +
+
+ +Returns a `User` object with the given `id`. +
+
+#### πŸ”Œ Usage +
-**show_enum_origins:** `typing.Optional[TimeOffListRequestShowEnumOrigins]` β€” 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) - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.users.retrieve( + id="id", +) + +```
+
+
+ +#### βš™οΈ Parameters
-**started_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return time-offs that started after this datetime. +
+
+ +**id:** `str`
@@ -27588,7 +27689,7 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-**started_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return time-offs that started before this datetime. +**expand:** `typing.Optional[UsersRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -27596,15 +27697,7 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-**status:** `typing.Optional[TimeOffListRequestStatus]` - -If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') - -- `REQUESTED` - REQUESTED -- `APPROVED` - APPROVED -- `DECLINED` - DECLINED -- `CANCELLED` - CANCELLED -- `DELETED` - DELETED +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -27624,7 +27717,8 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-
client.hris.time_off.create(...) +## Ticketing WebhookReceivers +
client.ticketing.webhook_receivers.list()
@@ -27636,7 +27730,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-Creates a `TimeOff` object with the given values. +Returns a list of `WebhookReceiver` objects.
@@ -27652,15 +27746,12 @@ Creates a `TimeOff` object with the given values. ```python from merge import Merge -from merge.resources.hris import TimeOffRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.create( - model=TimeOffRequest(), -) +client.ticketing.webhook_receivers.list() ``` @@ -27676,30 +27767,6 @@ client.hris.time_off.create(
-**model:** `TimeOffRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -27712,7 +27779,7 @@ client.hris.time_off.create(
-
client.hris.time_off.retrieve(...) +
client.ticketing.webhook_receivers.create(...)
@@ -27724,7 +27791,7 @@ client.hris.time_off.create(
-Returns a `TimeOff` object with the given `id`. +Creates a `WebhookReceiver` object with the given values.
@@ -27745,8 +27812,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.retrieve( - id="id", +client.ticketing.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -27763,23 +27831,7 @@ client.hris.time_off.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` β€” 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. +**event:** `str`
@@ -27787,7 +27839,7 @@ client.hris.time_off.retrieve(
-**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**is_active:** `bool`
@@ -27795,7 +27847,7 @@ client.hris.time_off.retrieve(
-**show_enum_origins:** `typing.Optional[TimeOffRetrieveRequestShowEnumOrigins]` β€” 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) +**key:** `typing.Optional[str]`
@@ -27815,7 +27867,8 @@ client.hris.time_off.retrieve(
-
client.hris.time_off.meta_post_retrieve() +## Hris AccountDetails +
client.hris.account_details.retrieve()
@@ -27827,7 +27880,7 @@ client.hris.time_off.retrieve(
-Returns metadata for `TimeOff` POSTs. +Get details for a linked account.
@@ -27848,7 +27901,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.meta_post_retrieve() +client.hris.account_details.retrieve() ``` @@ -27876,8 +27929,8 @@ client.hris.time_off.meta_post_retrieve()
-## Hris TimeOffBalances -
client.hris.time_off_balances.list(...) +## Hris AccountToken +
client.hris.account_token.retrieve(...)
@@ -27889,7 +27942,7 @@ client.hris.time_off.meta_post_retrieve()
-Returns a list of `TimeOffBalance` objects. +Returns the account token for the end user with the provided public token.
@@ -27910,7 +27963,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.list() +client.hris.account_token.retrieve( + public_token="public_token", +) ``` @@ -27926,15 +27981,7 @@ client.hris.time_off_balances.list()
-**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. +**public_token:** `str`
@@ -27942,112 +27989,75 @@ client.hris.time_off_balances.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**employee_id:** `typing.Optional[str]` β€” If provided, will only return time off balances for this employee. -
-
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+## Hris AsyncPassthrough +
client.hris.async_passthrough.create(...)
-**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/). - -
-
+#### πŸ“ Description
-**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). - +Asynchronously pull data from an endpoint not currently supported by Merge.
- -
-
- -**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. - -
-
+#### πŸ”Œ Usage
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - -
-
-
-**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` +```python +from merge import Merge +from merge.resources.hris import DataPassthroughRequest, MethodEnum -If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) -- `VACATION` - VACATION -- `SICK` - SICK -- `PERSONAL` - PERSONAL -- `JURY_DUTY` - JURY_DUTY -- `VOLUNTEER` - VOLUNTEER -- `BEREAVEMENT` - BEREAVEMENT - +```
- -
-
- -**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` β€” Deprecated. Use show_enum_origins. -
+#### βš™οΈ Parameters +
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
-
-**show_enum_origins:** `typing.Optional[typing.Literal["policy_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:** `DataPassthroughRequest`
@@ -28067,7 +28077,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
client.hris.time_off_balances.retrieve(...) +
client.hris.async_passthrough.retrieve(...)
@@ -28079,7 +28089,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-Returns a `TimeOffBalance` object with the given `id`. +Retrieves data from earlier async-passthrough POST request
@@ -28100,8 +28110,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.retrieve( - id="id", +client.hris.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -28118,39 +28128,7 @@ client.hris.time_off_balances.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["employee"]]` β€” 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. - -
-
- -
-
- -**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` β€” Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["policy_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) +**async_passthrough_receipt_id:** `str`
@@ -28170,8 +28148,8 @@ client.hris.time_off_balances.retrieve(
-## Hris TimesheetEntries -
client.hris.timesheet_entries.list(...) +## Hris AuditTrail +
client.hris.audit_trail.list(...)
@@ -28183,7 +28161,7 @@ client.hris.time_off_balances.retrieve(
-Returns a list of `TimesheetEntry` objects. +Gets a list of audit trail events.
@@ -28204,7 +28182,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.list() +client.hris.audit_trail.list() ``` @@ -28220,7 +28198,7 @@ client.hris.timesheet_entries.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -28228,7 +28206,7 @@ client.hris.timesheet_entries.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**end_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred before this time
@@ -28236,7 +28214,7 @@ client.hris.timesheet_entries.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**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`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_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`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -28244,7 +28222,7 @@ client.hris.timesheet_entries.list()
-**employee_id:** `typing.Optional[str]` β€” If provided, will only return timesheet entries for this employee. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -28252,7 +28230,7 @@ client.hris.timesheet_entries.list()
-**ended_after:** `typing.Optional[str]` β€” If provided, will only return timesheet entries ended after this datetime. +**start_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred after this time
@@ -28260,7 +28238,7 @@ client.hris.timesheet_entries.list()
-**ended_before:** `typing.Optional[str]` β€” If provided, will only return timesheet entries ended before this datetime. +**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.
@@ -28268,83 +28246,65 @@ client.hris.timesheet_entries.list()
-**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/). +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**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). -
+
+## Hris AvailableActions +
client.hris.available_actions.retrieve()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. - -
-
+#### πŸ“ Description
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` β€” Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time. - +Returns a list of models and actions available for an account.
- -
-
- -**page_size:** `typing.Optional[int]` β€” Number of results to return per page. -
+#### πŸ”Œ Usage +
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - -
-
-
-**started_after:** `typing.Optional[str]` β€” If provided, will only return timesheet entries started after this datetime. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.available_actions.retrieve() + +```
+ + + +#### βš™οΈ Parameters
-**started_before:** `typing.Optional[str]` β€” If provided, will only return timesheet entries started before this datetime. - -
-
-
@@ -28360,7 +28320,8 @@ client.hris.timesheet_entries.list()
-
client.hris.timesheet_entries.create(...) +## Hris BankInfo +
client.hris.bank_info.list(...)
@@ -28372,7 +28333,7 @@ client.hris.timesheet_entries.list()
-Creates a `TimesheetEntry` object with the given values. +Returns a list of `BankInfo` objects.
@@ -28388,15 +28349,12 @@ Creates a `TimesheetEntry` object with the given values. ```python from merge import Merge -from merge.resources.hris import TimesheetEntryRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.create( - model=TimesheetEntryRequest(), -) +client.hris.bank_info.list() ``` @@ -28412,7 +28370,12 @@ client.hris.timesheet_entries.create(
-**model:** `TimesheetEntryRequest` +**account_type:** `typing.Optional[BankInfoListRequestAccountType]` + +If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') + +- `SAVINGS` - SAVINGS +- `CHECKING` - CHECKING
@@ -28420,7 +28383,7 @@ client.hris.timesheet_entries.create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**bank_name:** `typing.Optional[str]` β€” If provided, will only return BankInfo's with this bank name.
@@ -28428,7 +28391,7 @@ client.hris.timesheet_entries.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -28436,70 +28399,103 @@ client.hris.timesheet_entries.create(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
+ +
+
+ +**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +
+
+
+**employee_id:** `typing.Optional[str]` β€” If provided, will only return bank accounts for this employee. +
-
-
client.hris.timesheet_entries.retrieve(...)
-#### πŸ“ Description +**expand:** `typing.Optional[typing.Literal["employee"]]` β€” 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/). + +
+
+
-Returns a `TimesheetEntry` object with the given `id`. +**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). +
-#### πŸ”Œ Usage -
+**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.timesheet_entries.retrieve( - id="id", -) +
+
-``` +**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` β€” Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. +
+ +
+
+ +**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +
-#### βš™οΈ Parameters -
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` β€” Deprecated. Use show_enum_origins. + +
+
+
-**id:** `str` +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -28507,7 +28503,7 @@ client.hris.timesheet_entries.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**show_enum_origins:** `typing.Optional[typing.Literal["account_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)
@@ -28527,7 +28523,7 @@ client.hris.timesheet_entries.retrieve(
-
client.hris.timesheet_entries.meta_post_retrieve() +
client.hris.bank_info.retrieve(...)
@@ -28539,7 +28535,7 @@ client.hris.timesheet_entries.retrieve(
-Returns metadata for `TimesheetEntry` POSTs. +Returns a `BankInfo` object with the given `id`.
@@ -28560,7 +28556,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.meta_post_retrieve() +client.hris.bank_info.retrieve( + id="id", +) ``` @@ -28576,65 +28574,43 @@ client.hris.timesheet_entries.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**id:** `str`
- -
+
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-## Hris WebhookReceivers -
client.hris.webhook_receivers.list()
-#### πŸ“ Description - -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Returns a list of `WebhookReceiver` objects. -
-
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` β€” Deprecated. Use show_enum_origins. +
-#### πŸ”Œ Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.webhook_receivers.list() - -``` -
-
+**show_enum_origins:** `typing.Optional[typing.Literal["account_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) +
-#### βš™οΈ Parameters - -
-
-
@@ -28650,7 +28626,8 @@ client.hris.webhook_receivers.list()
-
client.hris.webhook_receivers.create(...) +## Hris Benefits +
client.hris.benefits.list(...)
@@ -28662,7 +28639,7 @@ client.hris.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns a list of `Benefit` objects.
@@ -28683,10 +28660,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.webhook_receivers.create( - event="event", - is_active=True, -) +client.hris.benefits.list() ``` @@ -28702,7 +28676,7 @@ client.hris.webhook_receivers.create(
-**event:** `str` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -28710,7 +28684,7 @@ client.hris.webhook_receivers.create(
-**is_active:** `bool` +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -28718,7 +28692,7 @@ client.hris.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -28726,65 +28700,75 @@ client.hris.webhook_receivers.create(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**employee_id:** `typing.Optional[str]` β€” If provided, will return the benefits associated with the employee.
- -
+
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-## Ticketing AccountDetails -
client.ticketing.account_details.retrieve()
-#### πŸ“ Description +**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. + +
+
+
-Get details for a linked account. -
-
+**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). + -#### πŸ”Œ Usage -
+**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.account_details.retrieve() - -``` +**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. +
-#### βš™οΈ Parameters -
+**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. + +
+
+
@@ -28800,8 +28784,7 @@ client.ticketing.account_details.retrieve()
-## Ticketing AccountToken -
client.ticketing.account_token.retrieve(...) +
client.hris.benefits.retrieve(...)
@@ -28813,7 +28796,7 @@ client.ticketing.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Returns a `Benefit` object with the given `id`.
@@ -28834,8 +28817,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.account_token.retrieve( - public_token="public_token", +client.hris.benefits.retrieve( + id="id", ) ``` @@ -28852,7 +28835,23 @@ client.ticketing.account_token.retrieve(
-**public_token:** `str` +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["employee"]]` β€” 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.
@@ -28872,8 +28871,8 @@ client.ticketing.account_token.retrieve(
-## Ticketing Accounts -
client.ticketing.accounts.list(...) +## Hris Companies +
client.hris.companies.list(...)
@@ -28885,7 +28884,7 @@ client.ticketing.account_token.retrieve(
-Returns a list of `Account` objects. +Returns a list of `Company` objects.
@@ -28906,7 +28905,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.list() +client.hris.companies.list() ``` @@ -29014,7 +29013,7 @@ client.ticketing.accounts.list()
-
client.ticketing.accounts.retrieve(...) +
client.hris.companies.retrieve(...)
@@ -29026,7 +29025,7 @@ client.ticketing.accounts.list()
-Returns an `Account` object with the given `id`. +Returns a `Company` object with the given `id`.
@@ -29047,7 +29046,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.retrieve( +client.hris.companies.retrieve( id="id", ) @@ -29093,8 +29092,8 @@ client.ticketing.accounts.retrieve(
-## Ticketing AsyncPassthrough -
client.ticketing.async_passthrough.create(...) +## Hris Scopes +
client.hris.scopes.default_scopes_retrieve()
@@ -29106,7 +29105,7 @@ client.ticketing.accounts.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +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).
@@ -29122,18 +29121,12 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.ticketing import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) +client.hris.scopes.default_scopes_retrieve() ``` @@ -29149,10 +29142,63 @@ client.ticketing.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
+ + + + +
+ +
client.hris.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.hris.scopes.linked_account_scopes_retrieve() + +``` +
+
+
+
+ +#### βš™οΈ Parameters + +
+
@@ -29169,7 +29215,7 @@ client.ticketing.async_passthrough.create(
-
client.ticketing.async_passthrough.retrieve(...) +
client.hris.scopes.linked_account_scopes_create(...)
@@ -29181,7 +29227,7 @@ client.ticketing.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +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)
@@ -29197,13 +29243,37 @@ Retrieves data from earlier async-passthrough POST request ```python from merge import Merge +from merge.resources.hris import ( + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", +client.hris.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], ) ``` @@ -29220,7 +29290,7 @@ client.ticketing.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β€” The common models you want to update the scopes for
@@ -29240,8 +29310,8 @@ client.ticketing.async_passthrough.retrieve(
-## Ticketing Attachments -
client.ticketing.attachments.list(...) +## Hris DeleteAccount +
client.hris.delete_account.delete()
@@ -29253,7 +29323,7 @@ client.ticketing.async_passthrough.retrieve(
-Returns a list of `Attachment` objects. +Delete a linked account.
@@ -29274,7 +29344,69 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.list() +client.hris.delete_account.delete() + +``` + +
+ + + +#### βš™οΈ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Hris Dependents +
client.hris.dependents.list(...) +
+
+ +#### πŸ“ Description + +
+
+ +
+
+ +Returns a list of `Dependent` objects. +
+
+
+
+ +#### πŸ”Œ Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.dependents.list() ```
@@ -29314,7 +29446,7 @@ client.ticketing.attachments.list()
-**expand:** `typing.Optional[typing.Literal["ticket"]]` β€” 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/).
@@ -29322,7 +29454,7 @@ client.ticketing.attachments.list()
-**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.
@@ -29330,7 +29462,7 @@ client.ticketing.attachments.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**include_sensitive_fields:** `typing.Optional[bool]` β€” Whether to include sensitive fields (such as social security numbers) in the response.
@@ -29370,14 +29502,6 @@ client.ticketing.attachments.list()
-**remote_created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return attachments created in the third party platform after this datetime. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -29386,14 +29510,6 @@ client.ticketing.attachments.list()
-**ticket_id:** `typing.Optional[str]` β€” If provided, will only return comments for this ticket. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -29406,7 +29522,7 @@ client.ticketing.attachments.list()
-
client.ticketing.attachments.create(...) +
client.hris.dependents.retrieve(...)
@@ -29418,7 +29534,7 @@ client.ticketing.attachments.list()
-Creates an `Attachment` object with the given values. +Returns a `Dependent` object with the given `id`.
@@ -29434,14 +29550,13 @@ Creates an `Attachment` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.create( - model=AttachmentRequest(), +client.hris.dependents.retrieve( + id="id", ) ``` @@ -29458,7 +29573,7 @@ client.ticketing.attachments.create(
-**model:** `AttachmentRequest` +**id:** `str`
@@ -29466,7 +29581,7 @@ client.ticketing.attachments.create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29474,7 +29589,7 @@ client.ticketing.attachments.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**include_sensitive_fields:** `typing.Optional[bool]` β€” Whether to include sensitive fields (such as social security numbers) in the response.
@@ -29494,7 +29609,8 @@ client.ticketing.attachments.create(
-
client.ticketing.attachments.retrieve(...) +## Hris EmployeePayrollRuns +
client.hris.employee_payroll_runs.list(...)
@@ -29506,7 +29622,7 @@ client.ticketing.attachments.create(
-Returns an `Attachment` object with the given `id`. +Returns a list of `EmployeePayrollRun` objects.
@@ -29527,9 +29643,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.retrieve( - id="id", -) +client.hris.employee_payroll_runs.list() ``` @@ -29545,7 +29659,7 @@ client.ticketing.attachments.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -29553,7 +29667,7 @@ client.ticketing.attachments.retrieve(
-**expand:** `typing.Optional[typing.Literal["ticket"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -29561,7 +29675,7 @@ client.ticketing.attachments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -29569,71 +29683,47 @@ client.ticketing.attachments.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**employee_id:** `typing.Optional[str]` β€” If provided, will only return employee payroll runs for this employee.
- -
+
+
+**ended_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return employee payroll runs ended after this datetime. +
-
-
client.ticketing.attachments.download_retrieve(...)
-#### πŸ“ Description - -
-
+**ended_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return employee payroll runs ended before this datetime. + +
+
-Returns the `File` content with the given `id` as a stream of bytes. -
-
+**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.attachments.download_retrieve( - id="string", - mime_type="string", -) - -``` -
-
+**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/). +
-#### βš™οΈ Parameters -
-
-
- -**id:** `str` +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29641,7 +29731,7 @@ client.ticketing.attachments.download_retrieve(
-**mime_type:** `typing.Optional[str]` β€” If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article. +**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).
@@ -29649,64 +29739,59 @@ client.ticketing.attachments.download_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-
client.ticketing.attachments.meta_post_retrieve()
-#### πŸ“ Description - -
-
+**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
-Returns metadata for `TicketingAttachment` POSTs. -
-
+**payroll_run_id:** `typing.Optional[str]` β€” If provided, will only return employee payroll runs for this employee. +
-#### πŸ”Œ Usage -
+**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.attachments.meta_post_retrieve() - -``` -
-
+**started_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return employee payroll runs started after this datetime. + -#### βš™οΈ Parameters -
+**started_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return employee payroll runs started before this datetime. + +
+
+
@@ -29722,8 +29807,7 @@ client.ticketing.attachments.meta_post_retrieve()
-## Ticketing AuditTrail -
client.ticketing.audit_trail.list(...) +
client.hris.employee_payroll_runs.retrieve(...)
@@ -29735,7 +29819,7 @@ client.ticketing.attachments.meta_post_retrieve()
-Gets a list of audit trail events. +Returns an `EmployeePayrollRun` object with the given `id`.
@@ -29756,7 +29840,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.audit_trail.list() +client.hris.employee_payroll_runs.retrieve( + id="id", +) ``` @@ -29772,31 +29858,7 @@ client.ticketing.audit_trail.list()
-**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`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_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`, `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. +**id:** `str`
@@ -29804,7 +29866,7 @@ client.ticketing.audit_trail.list()
-**start_date:** `typing.Optional[str]` β€” If included, will only include audit trail events that occurred after this time +**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -29812,7 +29874,7 @@ client.ticketing.audit_trail.list()
-**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. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29832,8 +29894,8 @@ client.ticketing.audit_trail.list()
-## Ticketing AvailableActions -
client.ticketing.available_actions.retrieve() +## Hris Employees +
client.hris.employees.list(...)
@@ -29845,7 +29907,7 @@ client.ticketing.audit_trail.list()
-Returns a list of models and actions available for an account. +Returns a list of `Employee` objects.
@@ -29866,7 +29928,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.available_actions.retrieve() +client.hris.employees.list() ``` @@ -29882,69 +29944,93 @@ client.ticketing.available_actions.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**company_id:** `typing.Optional[str]` β€” If provided, will only return employees for this company.
- -
+
+
+**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +
-
-## Ticketing Collections -
client.ticketing.collections.list(...)
-#### πŸ“ Description +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. + +
+
+**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+
-Returns a list of `Collection` objects. -
-
+**display_full_name:** `typing.Optional[str]` β€” If provided, will only return employees with this display name. + -#### πŸ”Œ Usage -
+**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` + +If provided, will only return employees with this employment status. + +- `ACTIVE` - ACTIVE +- `PENDING` - PENDING +- `INACTIVE` - INACTIVE + +
+
+
-```python -from merge import Merge +**employment_type:** `typing.Optional[str]` β€” If provided, will only return employees that have an employment of the specified employment_type. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.collections.list() +
+
-``` +**expand:** `typing.Optional[EmployeesListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
+ +
+
+ +**first_name:** `typing.Optional[str]` β€” If provided, will only return employees with this first name. +
-#### βš™οΈ Parameters -
+**groups:** `typing.Optional[str]` β€” If provided, will only return employees matching the group ids; multiple groups can be separated by commas. + +
+
+
-**collection_type:** `typing.Optional[str]` β€” If provided, will only return collections of the given type. +**home_location_id:** `typing.Optional[str]` β€” If provided, will only return employees for this home location.
@@ -29952,7 +30038,7 @@ client.ticketing.collections.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**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/).
@@ -29960,7 +30046,7 @@ client.ticketing.collections.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29968,7 +30054,7 @@ client.ticketing.collections.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**include_sensitive_fields:** `typing.Optional[bool]` β€” Whether to include sensitive fields (such as social security numbers) in the response.
@@ -29976,7 +30062,7 @@ client.ticketing.collections.list()
-**expand:** `typing.Optional[typing.Literal["parent_collection"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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).
@@ -29984,7 +30070,7 @@ client.ticketing.collections.list()
-**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/). +**job_title:** `typing.Optional[str]` β€” If provided, will only return employees that have an employment of the specified job_title.
@@ -29992,7 +30078,7 @@ client.ticketing.collections.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**last_name:** `typing.Optional[str]` β€” If provided, will only return employees with this last name.
@@ -30000,7 +30086,7 @@ client.ticketing.collections.list()
-**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). +**manager_id:** `typing.Optional[str]` β€” If provided, will only return employees for this manager.
@@ -30032,7 +30118,7 @@ client.ticketing.collections.list()
-**parent_collection_id:** `typing.Optional[str]` β€” If provided, will only return collections whose parent collection matches the given id. +**pay_group_id:** `typing.Optional[str]` β€” If provided, will only return employees for this pay group
@@ -30040,7 +30126,15 @@ client.ticketing.collections.list()
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` β€” Deprecated. Use show_enum_origins. +**personal_email:** `typing.Optional[str]` β€” If provided, will only return Employees with this personal email + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins.
@@ -30056,7 +30150,63 @@ client.ticketing.collections.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["collection_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) +**show_enum_origins:** `typing.Optional[EmployeesListRequestShowEnumOrigins]` β€” 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) + +
+
+ +
+
+ +**started_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return employees that started after this datetime. + +
+
+ +
+
+ +**started_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return employees that started before this datetime. + +
+
+ +
+
+ +**team_id:** `typing.Optional[str]` β€” If provided, will only return employees for this team. + +
+
+ +
+
+ +**terminated_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return employees that were terminated after this datetime. + +
+
+ +
+
+ +**terminated_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return employees that were terminated before this datetime. + +
+
+ +
+
+ +**work_email:** `typing.Optional[str]` β€” If provided, will only return Employees with this work email + +
+
+ +
+
+ +**work_location_id:** `typing.Optional[str]` β€” If provided, will only return employees for this location.
@@ -30076,7 +30226,7 @@ client.ticketing.collections.list()
-
client.ticketing.collections.retrieve(...) +
client.hris.employees.create(...)
@@ -30088,7 +30238,7 @@ client.ticketing.collections.list()
-Returns a `Collection` object with the given `id`. +Creates an `Employee` object with the given values.
@@ -30104,13 +30254,14 @@ Returns a `Collection` object with the given `id`. ```python from merge import Merge +from merge.resources.hris import EmployeeRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.retrieve( - id="id", +client.hris.employees.create( + model=EmployeeRequest(), ) ``` @@ -30127,23 +30278,7 @@ client.ticketing.collections.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["parent_collection"]]` β€” 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. +**model:** `EmployeeRequest`
@@ -30151,7 +30286,7 @@ client.ticketing.collections.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` β€” Deprecated. Use show_enum_origins. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -30159,7 +30294,7 @@ client.ticketing.collections.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["collection_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) +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -30179,7 +30314,7 @@ client.ticketing.collections.retrieve(
-
client.ticketing.collections.users_list(...) +
client.hris.employees.retrieve(...)
@@ -30191,7 +30326,7 @@ client.ticketing.collections.retrieve(
-Returns a list of `User` objects. +Returns an `Employee` object with the given `id`.
@@ -30212,8 +30347,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.users_list( - parent_id="parent_id", +client.hris.employees.retrieve( + id="id", ) ``` @@ -30230,15 +30365,7 @@ client.ticketing.collections.users_list(
-**parent_id:** `str` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**id:** `str`
@@ -30246,7 +30373,7 @@ client.ticketing.collections.users_list(
-**expand:** `typing.Optional[CollectionsUsersListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30254,7 +30381,7 @@ client.ticketing.collections.users_list(
-**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.
@@ -30262,7 +30389,7 @@ client.ticketing.collections.users_list(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**include_sensitive_fields:** `typing.Optional[bool]` β€” Whether to include sensitive fields (such as social security numbers) in the response.
@@ -30270,7 +30397,7 @@ client.ticketing.collections.users_list(
-**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[EmployeesRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins.
@@ -30278,7 +30405,7 @@ client.ticketing.collections.users_list(
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` β€” 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)
@@ -30298,8 +30425,7 @@ client.ticketing.collections.users_list(
-## Ticketing Comments -
client.ticketing.comments.list(...) +
client.hris.employees.ignore_create(...)
@@ -30311,7 +30437,7 @@ client.ticketing.collections.users_list(
-Returns a list of `Comment` objects. +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
@@ -30327,12 +30453,16 @@ Returns a list of `Comment` objects. ```python from merge import Merge +from merge.resources.hris import ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.list() +client.hris.employees.ignore_create( + model_id="model_id", + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +) ``` @@ -30348,7 +30478,7 @@ client.ticketing.comments.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**model_id:** `str`
@@ -30356,7 +30486,7 @@ client.ticketing.comments.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**reason:** `IgnoreCommonModelRequestReason`
@@ -30364,7 +30494,7 @@ client.ticketing.comments.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**message:** `typing.Optional[str]`
@@ -30372,83 +30502,64 @@ client.ticketing.comments.list()
-**expand:** `typing.Optional[CommentsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
- -
-
- -**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. -
+
+
client.hris.employees.meta_post_retrieve()
-**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). - -
-
+#### πŸ“ Description
-**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. - +Returns metadata for `Employee` POSTs.
- -
-
- -**page_size:** `typing.Optional[int]` β€” Number of results to return per page. -
+#### πŸ”Œ Usage +
-**remote_created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return Comments created in the third party platform after this datetime. - -
-
-
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.employees.meta_post_retrieve() + +``` +
+
+#### βš™οΈ Parameters +
-**ticket_id:** `typing.Optional[str]` β€” If provided, will only return comments for this ticket. - -
-
-
@@ -30464,7 +30575,8 @@ client.ticketing.comments.list()
-
client.ticketing.comments.create(...) +## Hris EmployerBenefits +
client.hris.employer_benefits.list(...)
@@ -30476,7 +30588,7 @@ client.ticketing.comments.list()
-Creates a `Comment` object with the given values. +Returns a list of `EmployerBenefit` objects.
@@ -30492,15 +30604,12 @@ Creates a `Comment` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import CommentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.create( - model=CommentRequest(), -) +client.hris.employer_benefits.list() ``` @@ -30516,7 +30625,7 @@ client.ticketing.comments.create(
-**model:** `CommentRequest` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -30524,7 +30633,7 @@ client.ticketing.comments.create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
@@ -30532,7 +30641,7 @@ client.ticketing.comments.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -30540,70 +30649,39 @@ client.ticketing.comments.create(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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/).
- -
- - - -
- -
client.ticketing.comments.retrieve(...)
-#### πŸ“ Description - -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Returns a `Comment` object with the given `id`. -
-
+**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). +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.comments.retrieve( - id="id", -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. +
-#### βš™οΈ Parameters - -
-
-
-**id:** `str` +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -30611,7 +30689,7 @@ client.ticketing.comments.retrieve(
-**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -30619,7 +30697,7 @@ client.ticketing.comments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -30639,7 +30717,7 @@ client.ticketing.comments.retrieve(
-
client.ticketing.comments.meta_post_retrieve() +
client.hris.employer_benefits.retrieve(...)
@@ -30651,7 +30729,7 @@ client.ticketing.comments.retrieve(
-Returns metadata for `Comment` POSTs. +Returns an `EmployerBenefit` object with the given `id`.
@@ -30672,7 +30750,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.meta_post_retrieve() +client.hris.employer_benefits.retrieve( + id="id", +) ``` @@ -30688,6 +30768,22 @@ client.ticketing.comments.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -30700,8 +30796,8 @@ client.ticketing.comments.meta_post_retrieve()
-## Ticketing Contacts -
client.ticketing.contacts.list(...) +## Hris Employments +
client.hris.employments.list(...)
@@ -30713,7 +30809,7 @@ client.ticketing.comments.meta_post_retrieve()
-Returns a list of `Contact` objects. +Returns a list of `Employment` objects.
@@ -30734,7 +30830,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.list() +client.hris.employments.list() ``` @@ -30774,7 +30870,15 @@ client.ticketing.contacts.list()
-**expand:** `typing.Optional[typing.Literal["account"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**employee_id:** `typing.Optional[str]` β€” If provided, will only return employments for this employee. + +
+
+ +
+
+ +**expand:** `typing.Optional[EmploymentsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30822,6 +30926,14 @@ client.ticketing.contacts.list()
+**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` β€” Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. + +
+
+ +
+
+ **page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -30830,6 +30942,14 @@ client.ticketing.contacts.list()
+**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -30838,6 +30958,14 @@ client.ticketing.contacts.list()
+**show_enum_origins:** `typing.Optional[EmploymentsListRequestShowEnumOrigins]` β€” 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.
@@ -30850,7 +30978,7 @@ client.ticketing.contacts.list()
-
client.ticketing.contacts.create(...) +
client.hris.employments.retrieve(...)
@@ -30862,7 +30990,7 @@ client.ticketing.contacts.list()
-Creates a `Contact` object with the given values. +Returns an `Employment` object with the given `id`.
@@ -30878,14 +31006,13 @@ Creates a `Contact` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.create( - model=ContactRequest(), +client.hris.employments.retrieve( + id="id", ) ``` @@ -30902,7 +31029,7 @@ client.ticketing.contacts.create(
-**model:** `ContactRequest` +**id:** `str`
@@ -30910,7 +31037,7 @@ client.ticketing.contacts.create(
-**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. +**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30918,7 +31045,23 @@ client.ticketing.contacts.create(
-**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[EmploymentsRetrieveRequestShowEnumOrigins]` β€” 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)
@@ -30938,7 +31081,8 @@ client.ticketing.contacts.create(
-
client.ticketing.contacts.retrieve(...) +## Hris FieldMapping +
client.hris.field_mapping.field_mappings_retrieve()
@@ -30950,7 +31094,7 @@ client.ticketing.contacts.create(
-Returns a `Contact` object with the given `id`. +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/).
@@ -30971,9 +31115,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.retrieve( - id="id", -) +client.hris.field_mapping.field_mappings_retrieve() ``` @@ -30989,30 +31131,6 @@ client.ticketing.contacts.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["account"]]` β€” 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. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -31025,7 +31143,7 @@ client.ticketing.contacts.retrieve(
-
client.ticketing.contacts.meta_post_retrieve() +
client.hris.field_mapping.field_mappings_create(...)
@@ -31037,7 +31155,7 @@ client.ticketing.contacts.retrieve(
-Returns metadata for `TicketingContact` POSTs. +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.
@@ -31058,7 +31176,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.meta_post_retrieve() +client.hris.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) ``` @@ -31074,65 +31199,51 @@ client.ticketing.contacts.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**target_field_name:** `str` β€” The name of the target field you want this remote field to map to.
- -
+
+
+**target_field_description:** `str` β€” The description of the target field you want this remote field to map to. +
-
-## Ticketing Scopes -
client.ticketing.scopes.default_scopes_retrieve()
-#### πŸ“ Description - -
-
+**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. + +
+
-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). -
-
+**remote_method:** `str` β€” The method of the remote endpoint where the remote field is coming from. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.scopes.default_scopes_retrieve() - -``` -
-
+**remote_url_path:** `str` β€” The path of the remote endpoint where the remote field is coming from. +
-#### βš™οΈ Parameters -
+**common_model_name:** `str` β€” The name of the Common Model that the remote field corresponds to in a given category. + +
+
+
@@ -31148,7 +31259,7 @@ client.ticketing.scopes.default_scopes_retrieve()
-
client.ticketing.scopes.linked_account_scopes_retrieve() +
client.hris.field_mapping.field_mappings_destroy(...)
@@ -31160,7 +31271,7 @@ client.ticketing.scopes.default_scopes_retrieve()
-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). +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.
@@ -31181,7 +31292,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.scopes.linked_account_scopes_retrieve() +client.hris.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -31197,6 +31310,14 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
+**field_mapping_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -31209,7 +31330,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-
client.ticketing.scopes.linked_account_scopes_create(...) +
client.hris.field_mapping.field_mappings_partial_update(...)
@@ -31221,7 +31342,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-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) +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.
@@ -31237,37 +31358,13 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.ticketing import ( - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +client.hris.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -31284,7 +31381,31 @@ client.ticketing.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β€” The common models you want to update the scopes for +**field_mapping_id:** `str` + +
+
+ +
+
+ +**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.
@@ -31304,8 +31425,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-## Ticketing DeleteAccount -
client.ticketing.delete_account.delete() +
client.hris.field_mapping.remote_fields_retrieve(...)
@@ -31317,7 +31437,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-Delete a linked account. +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/).
@@ -31338,7 +31458,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.delete_account.delete() +client.hris.field_mapping.remote_fields_retrieve() ``` @@ -31354,6 +31474,22 @@ client.ticketing.delete_account.delete()
+**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.
@@ -31366,8 +31502,7 @@ client.ticketing.delete_account.delete()
-## Ticketing FieldMapping -
client.ticketing.field_mapping.field_mappings_retrieve() +
client.hris.field_mapping.target_fields_retrieve()
@@ -31379,7 +31514,7 @@ client.ticketing.delete_account.delete()
-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/). +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/).
@@ -31400,7 +31535,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_retrieve() +client.hris.field_mapping.target_fields_retrieve() ``` @@ -31428,7 +31563,8 @@ client.ticketing.field_mapping.field_mappings_retrieve()
-
client.ticketing.field_mapping.field_mappings_create(...) +## Hris GenerateKey +
client.hris.generate_key.create(...)
@@ -31440,7 +31576,7 @@ client.ticketing.field_mapping.field_mappings_retrieve()
-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. +Create a remote key.
@@ -31461,13 +31597,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", +client.hris.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -31484,47 +31615,7 @@ client.ticketing.field_mapping.field_mappings_create(
-**target_field_name:** `str` β€” The name of the target field you want this remote field to map to. - -
-
- -
-
- -**target_field_description:** `str` β€” The description of the target field you want this remote field to map to. - -
-
- -
-
- -**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. +**name:** `str` β€” The name of the remote key
@@ -31544,7 +31635,8 @@ client.ticketing.field_mapping.field_mappings_create(
-
client.ticketing.field_mapping.field_mappings_destroy(...) +## Hris Groups +
client.hris.groups.list(...)
@@ -31556,7 +31648,7 @@ client.ticketing.field_mapping.field_mappings_create(
-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. +Returns a list of `Group` objects.
@@ -31577,9 +31669,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.hris.groups.list() ``` @@ -31595,7 +31685,7 @@ client.ticketing.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime.
@@ -31603,70 +31693,31 @@ client.ticketing.field_mapping.field_mappings_destroy(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime.
- -
- - - - -
- -
client.ticketing.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. -
-
+**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +
-#### πŸ”Œ Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", -) - -``` -
-
+**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/). +
-#### βš™οΈ Parameters -
-
-
- -**field_mapping_id:** `str` +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31674,7 +31725,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**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. +**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).
@@ -31682,7 +31733,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` β€” The method of the remote endpoint where the remote field is coming from. +**is_commonly_used_as_team:** `typing.Optional[str]` β€” If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform.
@@ -31690,7 +31741,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` β€” The path of the remote endpoint where the remote field is coming from. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -31698,68 +31749,47 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
-
-
+
+
+**names:** `typing.Optional[str]` β€” If provided, will only return groups with these names. Multiple values can be separated by commas. +
-
-
client.ticketing.field_mapping.remote_fields_retrieve(...)
-#### πŸ“ Description - -
-
+**page_size:** `typing.Optional[int]` β€” Number of results to return per page. + +
+
-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/). -
-
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` β€” Deprecated. Use show_enum_origins. +
-#### πŸ”Œ Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.field_mapping.remote_fields_retrieve() - -``` -
-
+**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +
-#### βš™οΈ 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. +**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)
@@ -31767,7 +31797,7 @@ client.ticketing.field_mapping.remote_fields_retrieve()
-**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. +**types:** `typing.Optional[str]` β€” If provided, will only return groups of these types. Multiple values can be separated by commas.
@@ -31787,7 +31817,7 @@ client.ticketing.field_mapping.remote_fields_retrieve()
-
client.ticketing.field_mapping.target_fields_retrieve() +
client.hris.groups.retrieve(...)
@@ -31799,7 +31829,7 @@ client.ticketing.field_mapping.remote_fields_retrieve()
-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/). +Returns a `Group` object with the given `id`.
@@ -31820,7 +31850,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.target_fields_retrieve() +client.hris.groups.retrieve( + id="id", +) ``` @@ -31836,71 +31868,31 @@ client.ticketing.field_mapping.target_fields_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**id:** `str`
- -
- - - - -
- -## Ticketing GenerateKey -
client.ticketing.generate_key.create(...) -
-
- -#### πŸ“ Description
-
-
- -Create a remote key. -
-
+**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### πŸ”Œ Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` β€” Deprecated. Use show_enum_origins. +
-#### βš™οΈ Parameters - -
-
-
-**name:** `str` β€” The name of the remote key +**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)
@@ -31920,8 +31912,8 @@ client.ticketing.generate_key.create(
-## Ticketing Issues -
client.ticketing.issues.list(...) +## Hris Issues +
client.hris.issues.list(...)
@@ -31954,7 +31946,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.list() +client.hris.issues.list() ```
@@ -32099,7 +32091,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.ticketing.issues.retrieve(...) +
client.hris.issues.retrieve(...)
@@ -32132,7 +32124,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.retrieve( +client.hris.issues.retrieve( id="id", ) @@ -32170,8 +32162,8 @@ client.ticketing.issues.retrieve(
-## Ticketing LinkToken -
client.ticketing.link_token.create(...) +## Hris LinkToken +
client.hris.link_token.create(...)
@@ -32199,13 +32191,13 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.ticketing import CategoriesEnum +from merge.resources.hris import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.link_token.create( +client.hris.link_token.create( end_user_email_address="example@gmail.com", end_user_organization_name="Test Organization", end_user_origin_id="12345", @@ -32346,8 +32338,8 @@ The following subset of IETF language tags can be used to configure localization
-## Ticketing LinkedAccounts -
client.ticketing.linked_accounts.list(...) +## Hris LinkedAccounts +
client.hris.linked_accounts.list(...)
@@ -32380,7 +32372,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.linked_accounts.list() +client.hris.linked_accounts.list() ```
@@ -32522,84 +32514,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Ticketing Passthrough -
client.ticketing.passthrough.create(...) -
-
- -#### πŸ“ Description - -
-
- -
-
- -Pull data from an endpoint not currently supported by Merge. -
-
-
-
- -#### πŸ”Œ Usage - -
-
- -
-
- -```python -from merge import Merge -from merge.resources.ticketing import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
-
-
- -#### βš™οΈ Parameters - -
-
- -
-
- -**request:** `DataPassthroughRequest` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Ticketing Projects -
client.ticketing.projects.list(...) +## Hris Locations +
client.hris.locations.list(...)
@@ -32611,7 +32527,7 @@ client.ticketing.passthrough.create(
-Returns a list of `Project` objects. +Returns a list of `Location` objects.
@@ -32632,7 +32548,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.list() +client.hris.locations.list() ``` @@ -32696,15 +32612,12 @@ client.ticketing.projects.list()
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. - -
-
+**location_type:** `typing.Optional[LocationsListRequestLocationType]` -
-
+If provided, will only return locations with this location_type -**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. +- `HOME` - HOME +- `WORK` - WORK
@@ -32712,7 +32625,7 @@ client.ticketing.projects.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned.
@@ -32720,7 +32633,7 @@ client.ticketing.projects.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -32728,70 +32641,23 @@ client.ticketing.projects.list()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
- -
- - - - -
- -
client.ticketing.projects.retrieve(...) -
-
- -#### πŸ“ Description - -
-
- -
-
- -Returns a `Project` object with the given `id`. -
-
-
-
- -#### πŸ”Œ Usage - -
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.projects.retrieve( - id="id", -) - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["location_type"]]` β€” Deprecated. Use show_enum_origins. +
-#### βš™οΈ Parameters - -
-
-
-**id:** `str` +**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -32799,7 +32665,7 @@ client.ticketing.projects.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**show_enum_origins:** `typing.Optional[typing.Literal["location_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)
@@ -32819,7 +32685,7 @@ client.ticketing.projects.retrieve(
-
client.ticketing.projects.users_list(...) +
client.hris.locations.retrieve(...)
@@ -32831,7 +32697,7 @@ client.ticketing.projects.retrieve(
-Returns a list of `User` objects. +Returns a `Location` object with the given `id`.
@@ -32852,8 +32718,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.users_list( - parent_id="parent_id", +client.hris.locations.retrieve( + id="id", ) ``` @@ -32870,31 +32736,7 @@ client.ticketing.projects.users_list(
-**parent_id:** `str` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` β€” The pagination cursor value. - -
-
- -
-
- -**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` β€” 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/). +**id:** `str`
@@ -32910,7 +32752,7 @@ client.ticketing.projects.users_list(
-**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["location_type"]]` β€” Deprecated. Use show_enum_origins.
@@ -32918,7 +32760,7 @@ client.ticketing.projects.users_list(
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**show_enum_origins:** `typing.Optional[typing.Literal["location_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)
@@ -32938,8 +32780,8 @@ client.ticketing.projects.users_list(
-## Ticketing RegenerateKey -
client.ticketing.regenerate_key.create(...) +## Hris Passthrough +
client.hris.passthrough.create(...)
@@ -32951,7 +32793,7 @@ client.ticketing.projects.users_list(
-Exchange remote keys. +Pull data from an endpoint not currently supported by Merge.
@@ -32967,13 +32809,17 @@ Exchange remote keys. ```python from merge import Merge +from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.regenerate_key.create( - name="Remote Deployment Key 1", +client.hris.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -32990,7 +32836,7 @@ client.ticketing.regenerate_key.create(
-**name:** `str` β€” The name of the remote key +**request:** `DataPassthroughRequest`
@@ -33010,8 +32856,8 @@ client.ticketing.regenerate_key.create(
-## Ticketing Roles -
client.ticketing.roles.list(...) +## Hris PayGroups +
client.hris.pay_groups.list(...)
@@ -33023,7 +32869,7 @@ client.ticketing.regenerate_key.create(
-Returns a list of `Role` objects. +Returns a list of `PayGroup` objects.
@@ -33044,7 +32890,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.list() +client.hris.pay_groups.list() ``` @@ -33152,7 +32998,7 @@ client.ticketing.roles.list()
-
client.ticketing.roles.retrieve(...) +
client.hris.pay_groups.retrieve(...)
@@ -33164,7 +33010,7 @@ client.ticketing.roles.list()
-Returns a `Role` object with the given `id`. +Returns a `PayGroup` object with the given `id`.
@@ -33185,7 +33031,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.retrieve( +client.hris.pay_groups.retrieve( id="id", ) @@ -33231,8 +33077,8 @@ client.ticketing.roles.retrieve(
-## Ticketing SyncStatus -
client.ticketing.sync_status.list(...) +## Hris PayrollRuns +
client.hris.payroll_runs.list(...)
@@ -33244,7 +33090,7 @@ client.ticketing.roles.retrieve(
-Get syncing status. Possible values: `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). +Returns a list of `PayrollRun` objects.
@@ -33265,7 +33111,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.sync_status.list() +client.hris.payroll_runs.list() ``` @@ -33281,6 +33127,22 @@ client.ticketing.sync_status.list()
+**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.
@@ -33289,7 +33151,7 @@ client.ticketing.sync_status.list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**ended_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return payroll runs ended after this datetime.
@@ -33297,65 +33159,115 @@ client.ticketing.sync_status.list()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**ended_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return payroll runs ended before this datetime.
+ +
+
+ +**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. +
-
-## Ticketing ForceResync -
client.ticketing.force_resync.sync_status_resync_create()
-#### πŸ“ Description +**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. + +
+
+
-Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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. +**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. +
-#### πŸ”Œ Usage +
+
+ +**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. + +
+
+**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. + +
+
+
-```python -from merge import Merge +**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.force_resync.sync_status_resync_create() +If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') -``` +- `REGULAR` - REGULAR +- `OFF_CYCLE` - OFF_CYCLE +- `CORRECTION` - CORRECTION +- `TERMINATION` - TERMINATION +- `SIGN_ON_BONUS` - SIGN_ON_BONUS +
+ +
+
+ +**show_enum_origins:** `typing.Optional[PayrollRunsListRequestShowEnumOrigins]` β€” 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) +
-#### βš™οΈ Parameters +
+
+ +**started_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return payroll runs started after this datetime. + +
+
+**started_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return payroll runs started before this datetime. + +
+
+
@@ -33371,8 +33283,7 @@ client.ticketing.force_resync.sync_status_resync_create()
-## Ticketing Tags -
client.ticketing.tags.list(...) +
client.hris.payroll_runs.retrieve(...)
@@ -33384,7 +33295,7 @@ client.ticketing.force_resync.sync_status_resync_create()
-Returns a list of `Tag` objects. +Returns a `PayrollRun` object with the given `id`.
@@ -33405,7 +33316,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.list() +client.hris.payroll_runs.retrieve( + id="id", +) ``` @@ -33421,7 +33334,7 @@ client.ticketing.tags.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**id:** `str`
@@ -33429,7 +33342,7 @@ client.ticketing.tags.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -33437,7 +33350,7 @@ client.ticketing.tags.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins.
@@ -33445,7 +33358,7 @@ client.ticketing.tags.list()
-**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/). +**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` β€” 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)
@@ -33453,47 +33366,71 @@ client.ticketing.tags.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**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). -
+
+## Hris RegenerateKey +
client.hris.regenerate_key.create(...)
-**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. - -
-
+#### πŸ“ Description
-**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned. - +
+
+ +Exchange remote keys. +
+
+#### πŸ”Œ Usage +
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.regenerate_key.create( + name="Remote Deployment Key 1", +) + +``` +
+
+#### βš™οΈ Parameters +
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +
+
+ +**name:** `str` β€” The name of the remote key
@@ -33513,7 +33450,8 @@ client.ticketing.tags.list()
-
client.ticketing.tags.retrieve(...) +## Hris SyncStatus +
client.hris.sync_status.list(...)
@@ -33525,7 +33463,7 @@ client.ticketing.tags.list()
-Returns a `Tag` object with the given `id`. +Get syncing status. Possible values: `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).
@@ -33546,9 +33484,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.retrieve( - id="id", -) +client.hris.sync_status.list() ``` @@ -33564,7 +33500,7 @@ client.ticketing.tags.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` β€” The pagination cursor value.
@@ -33572,7 +33508,7 @@ client.ticketing.tags.retrieve(
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -33592,8 +33528,70 @@ client.ticketing.tags.retrieve(
-## Ticketing Teams -
client.ticketing.teams.list(...) +## Hris ForceResync +
client.hris.force_resync.sync_status_resync_create() +
+
+ +#### πŸ“ Description + +
+
+ +
+
+ +Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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. +
+
+
+
+ +#### πŸ”Œ Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.force_resync.sync_status_resync_create() + +``` +
+
+
+
+ +#### βš™οΈ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Hris Teams +
client.hris.teams.list(...)
@@ -33626,7 +33624,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.list() +client.hris.teams.list() ```
@@ -33666,6 +33664,14 @@ client.ticketing.teams.list()
+**expand:** `typing.Optional[typing.Literal["parent_team"]]` β€” 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/).
@@ -33714,6 +33720,14 @@ client.ticketing.teams.list()
+**parent_team_id:** `typing.Optional[str]` β€” If provided, will only return teams with this parent team. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -33734,7 +33748,7 @@ client.ticketing.teams.list()
-
client.ticketing.teams.retrieve(...) +
client.hris.teams.retrieve(...)
@@ -33767,7 +33781,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.retrieve( +client.hris.teams.retrieve( id="id", ) @@ -33793,6 +33807,14 @@ client.ticketing.teams.retrieve(
+**expand:** `typing.Optional[typing.Literal["parent_team"]]` β€” 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.
@@ -33813,8 +33835,8 @@ client.ticketing.teams.retrieve(
-## Ticketing Tickets -
client.ticketing.tickets.list(...) +## Hris TimeOff +
client.hris.time_off.list(...)
@@ -33826,7 +33848,7 @@ client.ticketing.teams.retrieve(
-Returns a list of `Ticket` objects. +Returns a list of `TimeOff` objects.
@@ -33847,7 +33869,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.list() +client.hris.time_off.list() ``` @@ -33863,47 +33885,7 @@ client.ticketing.tickets.list()
-**account_id:** `typing.Optional[str]` β€” If provided, will only return tickets for this account. - -
-
- -
-
- -**assignee_ids:** `typing.Optional[str]` β€” If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas. - -
-
- -
-
- -**collection_ids:** `typing.Optional[str]` β€” If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas. - -
-
- -
-
- -**completed_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets completed after this datetime. - -
-
- -
-
- -**completed_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets completed before this datetime. - -
-
- -
-
- -**contact_id:** `typing.Optional[str]` β€” If provided, will only return tickets for this contact. +**approver_id:** `typing.Optional[str]` β€” If provided, will only return time off for this approver.
@@ -33935,7 +33917,7 @@ client.ticketing.tickets.list()
-**due_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets due after this datetime. +**employee_id:** `typing.Optional[str]` β€” If provided, will only return time off for this employee.
@@ -33943,7 +33925,7 @@ client.ticketing.tickets.list()
-**due_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets due before this datetime. +**ended_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return employees that ended after this datetime.
@@ -33951,7 +33933,7 @@ client.ticketing.tickets.list()
-**expand:** `typing.Optional[TicketsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**ended_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return time-offs that ended before this datetime.
@@ -33959,7 +33941,7 @@ client.ticketing.tickets.list()
-**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/). +**expand:** `typing.Optional[TimeOffListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -33967,7 +33949,7 @@ client.ticketing.tickets.list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**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/).
@@ -33975,7 +33957,7 @@ client.ticketing.tickets.list()
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34015,46 +33997,7 @@ client.ticketing.tickets.list()
-**parent_ticket_id:** `typing.Optional[str]` β€” If provided, will only return sub tickets of the parent_ticket_id. - -
-
- -
-
- -**priority:** `typing.Optional[TicketsListRequestPriority]` - -If provided, will only return tickets of this priority. - -- `URGENT` - URGENT -- `HIGH` - HIGH -- `NORMAL` - NORMAL -- `LOW` - LOW - -
-
- -
-
- -**remote_created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets created in the third party platform after this datetime. - -
-
- -
-
- -**remote_created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets created in the third party platform before this datetime. - -
-
- -
-
- -**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` β€” Deprecated. Use show_enum_origins.
@@ -34070,15 +34013,16 @@ If provided, will only return tickets of this priority.
-**remote_updated_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets updated in the third party platform after this datetime. - -
-
+**request_type:** `typing.Optional[TimeOffListRequestRequestType]` -
-
+If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') -**remote_updated_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return tickets updated in the third party platform before this datetime. +- `VACATION` - VACATION +- `SICK` - SICK +- `PERSONAL` - PERSONAL +- `JURY_DUTY` - JURY_DUTY +- `VOLUNTEER` - VOLUNTEER +- `BEREAVEMENT` - BEREAVEMENT
@@ -34086,7 +34030,7 @@ If provided, will only return tickets of this priority.
-**show_enum_origins:** `typing.Optional[TicketsListRequestShowEnumOrigins]` β€” 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) +**show_enum_origins:** `typing.Optional[TimeOffListRequestShowEnumOrigins]` β€” 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)
@@ -34094,14 +34038,7 @@ If provided, will only return tickets of this priority.
-**status:** `typing.Optional[TicketsListRequestStatus]` - -If provided, will only return tickets of this status. - -- `OPEN` - OPEN -- `CLOSED` - CLOSED -- `IN_PROGRESS` - IN_PROGRESS -- `ON_HOLD` - ON_HOLD +**started_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return time-offs that started after this datetime.
@@ -34109,7 +34046,7 @@ If provided, will only return tickets of this status.
-**tags:** `typing.Optional[str]` β€” If provided, will only return tickets matching the tags; multiple tags can be separated by commas. +**started_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return time-offs that started before this datetime.
@@ -34117,15 +34054,15 @@ If provided, will only return tickets of this status.
-**ticket_type:** `typing.Optional[str]` β€” If provided, will only return tickets of this type. - -
-
+**status:** `typing.Optional[TimeOffListRequestStatus]` -
-
+If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') -**ticket_url:** `typing.Optional[str]` β€” If provided, will only return tickets where the URL matches or contains the substring +- `REQUESTED` - REQUESTED +- `APPROVED` - APPROVED +- `DECLINED` - DECLINED +- `CANCELLED` - CANCELLED +- `DELETED` - DELETED
@@ -34145,7 +34082,7 @@ If provided, will only return tickets of this status.
-
client.ticketing.tickets.create(...) +
client.hris.time_off.create(...)
@@ -34157,7 +34094,7 @@ If provided, will only return tickets of this status.
-Creates a `Ticket` object with the given values. +Creates a `TimeOff` object with the given values.
@@ -34173,14 +34110,14 @@ Creates a `Ticket` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import TicketRequest +from merge.resources.hris import TimeOffRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.create( - model=TicketRequest(), +client.hris.time_off.create( + model=TimeOffRequest(), ) ``` @@ -34197,7 +34134,7 @@ client.ticketing.tickets.create(
-**model:** `TicketRequest` +**model:** `TimeOffRequest`
@@ -34233,7 +34170,7 @@ client.ticketing.tickets.create(
-
client.ticketing.tickets.retrieve(...) +
client.hris.time_off.retrieve(...)
@@ -34245,7 +34182,7 @@ client.ticketing.tickets.create(
-Returns a `Ticket` object with the given `id`. +Returns a `TimeOff` object with the given `id`.
@@ -34266,7 +34203,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.retrieve( +client.hris.time_off.retrieve( id="id", ) @@ -34292,7 +34229,7 @@ client.ticketing.tickets.retrieve(
-**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -34308,15 +34245,7 @@ client.ticketing.tickets.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` β€” Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` β€” Deprecated. Use show_enum_origins.
@@ -34324,7 +34253,7 @@ client.ticketing.tickets.retrieve(
-**show_enum_origins:** `typing.Optional[TicketsRetrieveRequestShowEnumOrigins]` β€” 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) +**show_enum_origins:** `typing.Optional[TimeOffRetrieveRequestShowEnumOrigins]` β€” 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)
@@ -34344,7 +34273,7 @@ client.ticketing.tickets.retrieve(
-
client.ticketing.tickets.partial_update(...) +
client.hris.time_off.meta_post_retrieve()
@@ -34356,7 +34285,7 @@ client.ticketing.tickets.retrieve(
-Updates a `Ticket` object with the given `id`. +Returns metadata for `TimeOff` POSTs.
@@ -34372,16 +34301,12 @@ Updates a `Ticket` object with the given `id`. ```python from merge import Merge -from merge.resources.ticketing import PatchedTicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.partial_update( - id="id", - model=PatchedTicketRequest(), -) +client.hris.time_off.meta_post_retrieve() ``` @@ -34397,38 +34322,6 @@ client.ticketing.tickets.partial_update(
-**id:** `str` - -
-
- -
-
- -**model:** `PatchedTicketRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -34441,7 +34334,8 @@ client.ticketing.tickets.partial_update(
-
client.ticketing.tickets.collaborators_list(...) +## Hris TimeOffBalances +
client.hris.time_off_balances.list(...)
@@ -34453,7 +34347,7 @@ client.ticketing.tickets.partial_update(
-Returns a list of `User` objects. +Returns a list of `TimeOffBalance` objects.
@@ -34474,9 +34368,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.collaborators_list( - parent_id="parent_id", -) +client.hris.time_off_balances.list() ``` @@ -34492,7 +34384,15 @@ client.ticketing.tickets.collaborators_list(
-**parent_id:** `str` +**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.
@@ -34508,7 +34408,15 @@ client.ticketing.tickets.collaborators_list(
-**expand:** `typing.Optional[TicketsCollaboratorsListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**employee_id:** `typing.Optional[str]` β€” If provided, will only return time off balances for this employee. + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["employee"]]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -34540,6 +34448,22 @@ client.ticketing.tickets.collaborators_list(
+**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.
@@ -34548,6 +34472,47 @@ client.ticketing.tickets.collaborators_list(
+**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` + +If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') + +- `VACATION` - VACATION +- `SICK` - SICK +- `PERSONAL` - PERSONAL +- `JURY_DUTY` - JURY_DUTY +- `VOLUNTEER` - VOLUNTEER +- `BEREAVEMENT` - BEREAVEMENT + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["policy_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["policy_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.
@@ -34560,7 +34525,7 @@ client.ticketing.tickets.collaborators_list(
-
client.ticketing.tickets.meta_patch_retrieve(...) +
client.hris.time_off_balances.retrieve(...)
@@ -34572,7 +34537,7 @@ client.ticketing.tickets.collaborators_list(
-Returns metadata for `Ticket` PATCHs. +Returns a `TimeOffBalance` object with the given `id`.
@@ -34593,7 +34558,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_patch_retrieve( +client.hris.time_off_balances.retrieve( id="id", ) @@ -34619,6 +34584,38 @@ client.ticketing.tickets.meta_patch_retrieve(
+**expand:** `typing.Optional[typing.Literal["employee"]]` β€” 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. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` β€” Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["policy_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.
@@ -34631,7 +34628,8 @@ client.ticketing.tickets.meta_patch_retrieve(
-
client.ticketing.tickets.meta_post_retrieve() +## Hris TimesheetEntries +
client.hris.timesheet_entries.list(...)
@@ -34643,7 +34641,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-Returns metadata for `Ticket` POSTs. +Returns a list of `TimesheetEntry` objects.
@@ -34664,7 +34662,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_post_retrieve() +client.hris.timesheet_entries.list() ``` @@ -34680,68 +34678,87 @@ client.ticketing.tickets.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration. +**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. +
-
-
client.ticketing.tickets.remote_field_classes_list(...)
-#### πŸ“ Description +**cursor:** `typing.Optional[str]` β€” The pagination cursor value. + +
+
+**employee_id:** `typing.Optional[str]` β€” If provided, will only return timesheet entries for this employee. + +
+
+
-Returns a list of `RemoteFieldClass` objects. -
-
+**ended_after:** `typing.Optional[str]` β€” If provided, will only return timesheet entries ended after this datetime. + -#### πŸ”Œ Usage -
+**ended_before:** `typing.Optional[str]` β€” If provided, will only return timesheet entries ended before this datetime. + +
+
+
-```python -from merge import Merge +**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/). + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.tickets.remote_field_classes_list() +
+
-``` +**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). +
-#### βš™οΈ Parameters -
+**modified_after:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**modified_before:** `typing.Optional[dt.datetime]` β€” If provided, only objects synced by Merge before this date time will be returned.
@@ -34749,7 +34766,7 @@ client.ticketing.tickets.remote_field_classes_list()
-**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/). +**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` β€” Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
@@ -34757,7 +34774,7 @@ client.ticketing.tickets.remote_field_classes_list()
-**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models. +**page_size:** `typing.Optional[int]` β€” Number of results to return per page.
@@ -34765,7 +34782,7 @@ client.ticketing.tickets.remote_field_classes_list()
-**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_id:** `typing.Optional[str]` β€” The API provider's ID for the given object.
@@ -34773,7 +34790,7 @@ client.ticketing.tickets.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` β€” If provided, will only return remote field classes with this is_common_model_field value +**started_after:** `typing.Optional[str]` β€” If provided, will only return timesheet entries started after this datetime.
@@ -34781,7 +34798,7 @@ client.ticketing.tickets.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +**started_before:** `typing.Optional[str]` β€” If provided, will only return timesheet entries started before this datetime.
@@ -34801,8 +34818,7 @@ client.ticketing.tickets.remote_field_classes_list()
-## Ticketing Users -
client.ticketing.users.list(...) +
client.hris.timesheet_entries.create(...)
@@ -34814,7 +34830,7 @@ client.ticketing.tickets.remote_field_classes_list()
-Returns a list of `User` objects. +Creates a `TimesheetEntry` object with the given values.
@@ -34830,12 +34846,15 @@ Returns a list of `User` objects. ```python from merge import Merge +from merge.resources.hris import TimesheetEntryRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.list() +client.hris.timesheet_entries.create( + model=TimesheetEntryRequest(), +) ``` @@ -34851,7 +34870,7 @@ client.ticketing.users.list()
-**created_after:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created after this datetime. +**model:** `TimesheetEntryRequest`
@@ -34859,7 +34878,7 @@ client.ticketing.users.list()
-**created_before:** `typing.Optional[dt.datetime]` β€” If provided, will only return objects created before this datetime. +**is_debug_mode:** `typing.Optional[bool]` β€” Whether to include debug fields (such as log file links) in the response.
@@ -34867,7 +34886,7 @@ client.ticketing.users.list()
-**cursor:** `typing.Optional[str]` β€” The pagination cursor value. +**run_async:** `typing.Optional[bool]` β€” Whether or not third-party updates should be run asynchronously.
@@ -34875,63 +34894,70 @@ client.ticketing.users.list()
-**email_address:** `typing.Optional[str]` β€” If provided, will only return users with emails equal to this value (case insensitive). +**request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[UsersListRequestExpand]` β€” Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.hris.timesheet_entries.retrieve(...)
-**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/). - -
-
+#### πŸ“ Description
-**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). - +Returns a `TimesheetEntry` object with the given `id`.
+ + + +#### πŸ”Œ Usage
-**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. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.timesheet_entries.retrieve( + id="id", +) + +``` +
+
+#### βš™οΈ Parameters +
-**page_size:** `typing.Optional[int]` β€” Number of results to return per page. +
+
+ +**id:** `str`
@@ -34939,7 +34965,7 @@ client.ticketing.users.list()
-**remote_id:** `typing.Optional[str]` β€” The API provider's ID for the given object. +**include_remote_data:** `typing.Optional[bool]` β€” Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34959,7 +34985,7 @@ client.ticketing.users.list()
-
client.ticketing.users.retrieve(...) +
client.hris.timesheet_entries.meta_post_retrieve()
@@ -34971,7 +34997,7 @@ client.ticketing.users.list()
-Returns a `User` object with the given `id`. +Returns metadata for `TimesheetEntry` POSTs.
@@ -34992,9 +35018,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.retrieve( - id="id", -) +client.hris.timesheet_entries.meta_post_retrieve() ``` @@ -35010,30 +35034,6 @@ client.ticketing.users.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[UsersRetrieveRequestExpand]` β€” 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. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` β€” Request-specific configuration.
@@ -35046,8 +35046,8 @@ client.ticketing.users.retrieve(
-## Ticketing WebhookReceivers -
client.ticketing.webhook_receivers.list() +## Hris WebhookReceivers +
client.hris.webhook_receivers.list()
@@ -35080,7 +35080,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.list() +client.hris.webhook_receivers.list() ```
@@ -35108,7 +35108,7 @@ client.ticketing.webhook_receivers.list()
-
client.ticketing.webhook_receivers.create(...) +
client.hris.webhook_receivers.create(...)
@@ -35141,7 +35141,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.create( +client.hris.webhook_receivers.create( event="event", is_active=True, ) diff --git a/src/merge/client.py b/src/merge/client.py index 4ad6fba0..caad9101 100644 --- a/src/merge/client.py +++ b/src/merge/client.py @@ -4,18 +4,18 @@ from .environment import MergeEnvironment import httpx from .core.client_wrapper import SyncClientWrapper -from .resources.filestorage.client import FilestorageClient from .resources.ats.client import AtsClient from .resources.crm.client import CrmClient -from .resources.hris.client import HrisClient +from .resources.filestorage.client import FilestorageClient from .resources.ticketing.client import TicketingClient +from .resources.hris.client import HrisClient from .resources.accounting.client import AccountingClient from .core.client_wrapper import AsyncClientWrapper -from .resources.filestorage.client import AsyncFilestorageClient from .resources.ats.client import AsyncAtsClient from .resources.crm.client import AsyncCrmClient -from .resources.hris.client import AsyncHrisClient +from .resources.filestorage.client import AsyncFilestorageClient from .resources.ticketing.client import AsyncTicketingClient +from .resources.hris.client import AsyncHrisClient from .resources.accounting.client import AsyncAccountingClient @@ -81,11 +81,11 @@ def __init__( else httpx.Client(timeout=_defaulted_timeout), timeout=_defaulted_timeout, ) - self.filestorage = FilestorageClient(client_wrapper=self._client_wrapper) self.ats = AtsClient(client_wrapper=self._client_wrapper) self.crm = CrmClient(client_wrapper=self._client_wrapper) - self.hris = HrisClient(client_wrapper=self._client_wrapper) + self.filestorage = FilestorageClient(client_wrapper=self._client_wrapper) self.ticketing = TicketingClient(client_wrapper=self._client_wrapper) + self.hris = HrisClient(client_wrapper=self._client_wrapper) self.accounting = AccountingClient(client_wrapper=self._client_wrapper) @@ -151,11 +151,11 @@ def __init__( else httpx.AsyncClient(timeout=_defaulted_timeout), timeout=_defaulted_timeout, ) - self.filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) self.ats = AsyncAtsClient(client_wrapper=self._client_wrapper) self.crm = AsyncCrmClient(client_wrapper=self._client_wrapper) - self.hris = AsyncHrisClient(client_wrapper=self._client_wrapper) + self.filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) self.ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper) + self.hris = AsyncHrisClient(client_wrapper=self._client_wrapper) self.accounting = AsyncAccountingClient(client_wrapper=self._client_wrapper) diff --git a/src/merge/core/client_wrapper.py b/src/merge/core/client_wrapper.py index 29b3e686..42869e75 100644 --- a/src/merge/core/client_wrapper.py +++ b/src/merge/core/client_wrapper.py @@ -24,7 +24,7 @@ def get_headers(self) -> typing.Dict[str, str]: headers: typing.Dict[str, str] = { "X-Fern-Language": "Python", "X-Fern-SDK-Name": "MergePythonClient", - "X-Fern-SDK-Version": "1.1.2", + "X-Fern-SDK-Version": "v1.1.3", } if self._account_token is not None: headers["X-Account-Token"] = self._account_token diff --git a/src/merge/resources/accounting/types/account.py b/src/merge/resources/accounting/types/account.py index bb527945..242de8e3 100644 --- a/src/merge/resources/accounting/types/account.py +++ b/src/merge/resources/accounting/types/account.py @@ -32,33 +32,33 @@ class Account(UniversalBaseModel): Fetch from the `LIST Accounts` endpoint and view a company's accounts. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The account's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The account's description. """ - classification: typing.Optional[AccountClassification] = pydantic.Field() + classification: typing.Optional[AccountClassification] = pydantic.Field(default=None) """ The account's broadest grouping. @@ -69,12 +69,12 @@ class Account(UniversalBaseModel): - `REVENUE` - REVENUE """ - type: typing.Optional[str] = pydantic.Field() + type: typing.Optional[str] = pydantic.Field(default=None) """ The account's type is a narrower and more specific grouping within the account's classification. """ - status: typing.Optional[AccountStatus] = pydantic.Field() + status: typing.Optional[AccountStatus] = pydantic.Field(default=None) """ The account's status. @@ -83,12 +83,12 @@ class Account(UniversalBaseModel): - `INACTIVE` - INACTIVE """ - current_balance: typing.Optional[float] = pydantic.Field() + current_balance: typing.Optional[float] = pydantic.Field(default=None) """ The account's current balance. """ - currency: typing.Optional[AccountCurrency] = pydantic.Field() + currency: typing.Optional[AccountCurrency] = pydantic.Field(default=None) """ The account's currency. @@ -400,28 +400,28 @@ class Account(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - account_number: typing.Optional[str] = pydantic.Field() + account_number: typing.Optional[str] = pydantic.Field(default=None) """ The account's number. """ - parent_account: typing.Optional[str] = pydantic.Field() + parent_account: typing.Optional[str] = pydantic.Field(default=None) """ ID of the parent account. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the account belongs to. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/account_details.py b/src/merge/resources/accounting/types/account_details.py index dc91a6f3..aaf3c5e4 100644 --- a/src/merge/resources/accounting/types/account_details.py +++ b/src/merge/resources/accounting/types/account_details.py @@ -9,22 +9,22 @@ class AccountDetails(UniversalBaseModel): - id: typing.Optional[str] - integration: typing.Optional[str] - integration_slug: typing.Optional[str] - category: typing.Optional[CategoryEnum] - end_user_origin_id: typing.Optional[str] - end_user_organization_name: typing.Optional[str] - end_user_email_address: typing.Optional[str] - status: typing.Optional[str] - webhook_listener_url: typing.Optional[str] - is_duplicate: typing.Optional[bool] = pydantic.Field() + id: typing.Optional[str] = None + integration: typing.Optional[str] = None + integration_slug: typing.Optional[str] = None + category: typing.Optional[CategoryEnum] = None + end_user_origin_id: typing.Optional[str] = None + end_user_organization_name: typing.Optional[str] = None + end_user_email_address: typing.Optional[str] = None + status: typing.Optional[str] = None + webhook_listener_url: typing.Optional[str] = None + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - account_type: typing.Optional[str] - completed_at: typing.Optional[dt.datetime] = pydantic.Field() + account_type: typing.Optional[str] = None + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which account completes the linking flow. """ diff --git a/src/merge/resources/accounting/types/account_details_and_actions.py b/src/merge/resources/accounting/types/account_details_and_actions.py index 30e78b61..4c96905f 100644 --- a/src/merge/resources/accounting/types/account_details_and_actions.py +++ b/src/merge/resources/accounting/types/account_details_and_actions.py @@ -24,24 +24,24 @@ class AccountDetailsAndActions(UniversalBaseModel): """ id: str - category: typing.Optional[CategoryEnum] + category: typing.Optional[CategoryEnum] = None status: AccountDetailsAndActionsStatusEnum - status_detail: typing.Optional[str] - end_user_origin_id: typing.Optional[str] + status_detail: typing.Optional[str] = None + end_user_origin_id: typing.Optional[str] = None end_user_organization_name: str end_user_email_address: str - subdomain: typing.Optional[str] = pydantic.Field() + subdomain: typing.Optional[str] = pydantic.Field(default=None) """ The tenant or domain the customer has provided access to. """ webhook_listener_url: str - is_duplicate: typing.Optional[bool] = pydantic.Field() + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - integration: typing.Optional[AccountDetailsAndActionsIntegration] + integration: typing.Optional[AccountDetailsAndActionsIntegration] = None account_type: str completed_at: dt.datetime diff --git a/src/merge/resources/accounting/types/account_details_and_actions_integration.py b/src/merge/resources/accounting/types/account_details_and_actions_integration.py index 5779ac5b..8e47dbc4 100644 --- a/src/merge/resources/accounting/types/account_details_and_actions_integration.py +++ b/src/merge/resources/accounting/types/account_details_and_actions_integration.py @@ -11,12 +11,12 @@ class AccountDetailsAndActionsIntegration(UniversalBaseModel): name: str categories: typing.List[CategoriesEnum] - image: typing.Optional[str] - square_image: typing.Optional[str] + image: typing.Optional[str] = None + square_image: typing.Optional[str] = None color: str slug: str passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/accounting/types/account_integration.py b/src/merge/resources/accounting/types/account_integration.py index 2d18dedb..1dad1594 100644 --- a/src/merge/resources/accounting/types/account_integration.py +++ b/src/merge/resources/accounting/types/account_integration.py @@ -13,45 +13,45 @@ class AccountIntegration(UniversalBaseModel): Company name. """ - abbreviated_name: typing.Optional[str] = pydantic.Field() + abbreviated_name: typing.Optional[str] = pydantic.Field(default=None) """ Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).

Example: Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors) """ - categories: typing.Optional[typing.List[CategoriesEnum]] = pydantic.Field() + 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() + image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in rectangular shape. """ - square_image: typing.Optional[str] = pydantic.Field() + square_image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in square shape. """ - color: typing.Optional[str] = pydantic.Field() + 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] + slug: typing.Optional[str] = None api_endpoints_to_documentation_urls: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = ( - pydantic.Field() + 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() + 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() + 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. """ diff --git a/src/merge/resources/accounting/types/account_request.py b/src/merge/resources/accounting/types/account_request.py index 0c6e0f15..8cc1256c 100644 --- a/src/merge/resources/accounting/types/account_request.py +++ b/src/merge/resources/accounting/types/account_request.py @@ -30,17 +30,17 @@ class AccountRequest(UniversalBaseModel): Fetch from the `LIST Accounts` endpoint and view a company's accounts. """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The account's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The account's description. """ - classification: typing.Optional[AccountRequestClassification] = pydantic.Field() + classification: typing.Optional[AccountRequestClassification] = pydantic.Field(default=None) """ The account's broadest grouping. @@ -51,12 +51,12 @@ class AccountRequest(UniversalBaseModel): - `REVENUE` - REVENUE """ - type: typing.Optional[str] = pydantic.Field() + type: typing.Optional[str] = pydantic.Field(default=None) """ The account's type is a narrower and more specific grouping within the account's classification. """ - status: typing.Optional[AccountRequestStatus] = pydantic.Field() + status: typing.Optional[AccountRequestStatus] = pydantic.Field(default=None) """ The account's status. @@ -65,12 +65,12 @@ class AccountRequest(UniversalBaseModel): - `INACTIVE` - INACTIVE """ - current_balance: typing.Optional[float] = pydantic.Field() + current_balance: typing.Optional[float] = pydantic.Field(default=None) """ The account's current balance. """ - currency: typing.Optional[AccountRequestCurrency] = pydantic.Field() + currency: typing.Optional[AccountRequestCurrency] = pydantic.Field(default=None) """ The account's currency. @@ -382,23 +382,23 @@ class AccountRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - account_number: typing.Optional[str] = pydantic.Field() + account_number: typing.Optional[str] = pydantic.Field(default=None) """ The account's number. """ - parent_account: typing.Optional[str] = pydantic.Field() + parent_account: typing.Optional[str] = pydantic.Field(default=None) """ ID of the parent account. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the account belongs to. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/accounting/types/account_response.py b/src/merge/resources/accounting/types/account_response.py index f9898c9c..f262d3c7 100644 --- a/src/merge/resources/accounting/types/account_response.py +++ b/src/merge/resources/accounting/types/account_response.py @@ -14,7 +14,7 @@ class AccountResponse(UniversalBaseModel): model: Account warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/accounting/types/accounting_attachment.py b/src/merge/resources/accounting/types/accounting_attachment.py index 539b0035..92a7550c 100644 --- a/src/merge/resources/accounting/types/accounting_attachment.py +++ b/src/merge/resources/accounting/types/accounting_attachment.py @@ -21,44 +21,44 @@ class AccountingAttachment(UniversalBaseModel): Fetch from the `LIST AccountingAttachments` endpoint and view a company's attachments. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - file_name: typing.Optional[str] = pydantic.Field() + file_name: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's name. """ - file_url: typing.Optional[str] = pydantic.Field() + file_url: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's url. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the accounting attachment belongs to. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/accounting_attachment_request.py b/src/merge/resources/accounting/types/accounting_attachment_request.py index 9e7f7195..ac0fbc88 100644 --- a/src/merge/resources/accounting/types/accounting_attachment_request.py +++ b/src/merge/resources/accounting/types/accounting_attachment_request.py @@ -19,23 +19,23 @@ class AccountingAttachmentRequest(UniversalBaseModel): Fetch from the `LIST AccountingAttachments` endpoint and view a company's attachments. """ - file_name: typing.Optional[str] = pydantic.Field() + file_name: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's name. """ - file_url: typing.Optional[str] = pydantic.Field() + file_url: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's url. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the accounting attachment belongs to. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/accounting/types/accounting_attachment_response.py b/src/merge/resources/accounting/types/accounting_attachment_response.py index 478d43d1..3aa134c5 100644 --- a/src/merge/resources/accounting/types/accounting_attachment_response.py +++ b/src/merge/resources/accounting/types/accounting_attachment_response.py @@ -14,7 +14,7 @@ class AccountingAttachmentResponse(UniversalBaseModel): model: AccountingAttachment warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/accounting/types/accounting_period.py b/src/merge/resources/accounting/types/accounting_period.py index 8981df38..1f408444 100644 --- a/src/merge/resources/accounting/types/accounting_period.py +++ b/src/merge/resources/accounting/types/accounting_period.py @@ -22,40 +22,40 @@ class AccountingPeriod(UniversalBaseModel): Common models like `Invoice` and `Transaction` will have `AccountingPeriod` objects which will denote when they occurred. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ Name of the accounting period. """ - status: typing.Optional[AccountingPeriodStatus] - start_date: typing.Optional[dt.datetime] = pydantic.Field() + status: typing.Optional[AccountingPeriodStatus] = None + start_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ Beginning date of the period """ - end_date: typing.Optional[dt.datetime] = pydantic.Field() + end_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ End date of the period """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/accounting_phone_number.py b/src/merge/resources/accounting/types/accounting_phone_number.py index 78cdf5fa..5cb142ef 100644 --- a/src/merge/resources/accounting/types/accounting_phone_number.py +++ b/src/merge/resources/accounting/types/accounting_phone_number.py @@ -20,22 +20,22 @@ class AccountingPhoneNumber(UniversalBaseModel): Fetch from the `GET CompanyInfo` endpoint and view the company's phone numbers. """ - created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - number: typing.Optional[str] = pydantic.Field() + number: typing.Optional[str] = pydantic.Field(default=None) """ The phone number. """ - type: typing.Optional[str] = pydantic.Field() + type: typing.Optional[str] = pydantic.Field(default=None) """ The phone number's type. """ diff --git a/src/merge/resources/accounting/types/accounting_phone_number_request.py b/src/merge/resources/accounting/types/accounting_phone_number_request.py index 0440c794..ca6bb1df 100644 --- a/src/merge/resources/accounting/types/accounting_phone_number_request.py +++ b/src/merge/resources/accounting/types/accounting_phone_number_request.py @@ -19,18 +19,18 @@ class AccountingPhoneNumberRequest(UniversalBaseModel): Fetch from the `GET CompanyInfo` endpoint and view the company's phone numbers. """ - number: typing.Optional[str] = pydantic.Field() + number: typing.Optional[str] = pydantic.Field(default=None) """ The phone number. """ - type: typing.Optional[str] = pydantic.Field() + type: typing.Optional[str] = pydantic.Field(default=None) """ The phone number's type. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/accounting/types/address.py b/src/merge/resources/accounting/types/address.py index 67675a26..cef47058 100644 --- a/src/merge/resources/accounting/types/address.py +++ b/src/merge/resources/accounting/types/address.py @@ -22,17 +22,17 @@ class Address(UniversalBaseModel): Fetch from the `GET CompanyInfo` endpoint and view the company's addresses. """ - created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - type: typing.Optional[AddressType] = pydantic.Field() + type: typing.Optional[AddressType] = pydantic.Field(default=None) """ The address type. @@ -40,28 +40,28 @@ class Address(UniversalBaseModel): - `SHIPPING` - SHIPPING """ - street_1: typing.Optional[str] = pydantic.Field() + street_1: typing.Optional[str] = pydantic.Field(default=None) """ Line 1 of the address's street. """ - street_2: typing.Optional[str] = pydantic.Field() + street_2: typing.Optional[str] = pydantic.Field(default=None) """ Line 2 of the address's street. """ - city: typing.Optional[str] = pydantic.Field() + city: typing.Optional[str] = pydantic.Field(default=None) """ The address's city. """ - state: typing.Optional[typing.Optional[typing.Any]] - country_subdivision: typing.Optional[str] = pydantic.Field() + state: typing.Optional[typing.Optional[typing.Any]] = None + country_subdivision: typing.Optional[str] = pydantic.Field(default=None) """ The address's state or region. """ - country: typing.Optional[AddressCountry] = pydantic.Field() + country: typing.Optional[AddressCountry] = pydantic.Field(default=None) """ The address's country. @@ -316,7 +316,7 @@ class Address(UniversalBaseModel): - `ZW` - Zimbabwe """ - zip_code: typing.Optional[str] = pydantic.Field() + zip_code: typing.Optional[str] = pydantic.Field(default=None) """ The address's zip code. """ diff --git a/src/merge/resources/accounting/types/address_request.py b/src/merge/resources/accounting/types/address_request.py index d4c66ef6..5e856799 100644 --- a/src/merge/resources/accounting/types/address_request.py +++ b/src/merge/resources/accounting/types/address_request.py @@ -21,7 +21,7 @@ class AddressRequest(UniversalBaseModel): Fetch from the `GET CompanyInfo` endpoint and view the company's addresses. """ - type: typing.Optional[AddressRequestType] = pydantic.Field() + type: typing.Optional[AddressRequestType] = pydantic.Field(default=None) """ The address type. @@ -29,27 +29,27 @@ class AddressRequest(UniversalBaseModel): - `SHIPPING` - SHIPPING """ - street_1: typing.Optional[str] = pydantic.Field() + street_1: typing.Optional[str] = pydantic.Field(default=None) """ Line 1 of the address's street. """ - street_2: typing.Optional[str] = pydantic.Field() + street_2: typing.Optional[str] = pydantic.Field(default=None) """ Line 2 of the address's street. """ - city: typing.Optional[str] = pydantic.Field() + city: typing.Optional[str] = pydantic.Field(default=None) """ The address's city. """ - country_subdivision: typing.Optional[str] = pydantic.Field() + country_subdivision: typing.Optional[str] = pydantic.Field(default=None) """ The address's state or region. """ - country: typing.Optional[AddressRequestCountry] = pydantic.Field() + country: typing.Optional[AddressRequestCountry] = pydantic.Field(default=None) """ The address's country. @@ -304,13 +304,13 @@ class AddressRequest(UniversalBaseModel): - `ZW` - Zimbabwe """ - zip_code: typing.Optional[str] = pydantic.Field() + zip_code: typing.Optional[str] = pydantic.Field(default=None) """ The address's zip code. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/accounting/types/advanced_metadata.py b/src/merge/resources/accounting/types/advanced_metadata.py index 6287a842..e570d69f 100644 --- a/src/merge/resources/accounting/types/advanced_metadata.py +++ b/src/merge/resources/accounting/types/advanced_metadata.py @@ -8,11 +8,11 @@ class AdvancedMetadata(UniversalBaseModel): id: str - display_name: typing.Optional[str] - description: typing.Optional[str] - is_required: typing.Optional[bool] - is_custom: typing.Optional[bool] - field_choices: typing.Optional[typing.List[typing.Optional[typing.Any]]] + 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 diff --git a/src/merge/resources/accounting/types/audit_log_event.py b/src/merge/resources/accounting/types/audit_log_event.py index b57101fc..1c32586b 100644 --- a/src/merge/resources/accounting/types/audit_log_event.py +++ b/src/merge/resources/accounting/types/audit_log_event.py @@ -10,13 +10,13 @@ class AuditLogEvent(UniversalBaseModel): - id: typing.Optional[str] - user_name: typing.Optional[str] = pydantic.Field() + 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() + user_email: typing.Optional[str] = pydantic.Field(default=None) """ The User's email at the time of this Event occurring. """ @@ -79,7 +79,7 @@ class AuditLogEvent(UniversalBaseModel): """ event_description: str - created_at: typing.Optional[dt.datetime] + 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 diff --git a/src/merge/resources/accounting/types/available_actions.py b/src/merge/resources/accounting/types/available_actions.py index 5f164db6..57cee06d 100644 --- a/src/merge/resources/accounting/types/available_actions.py +++ b/src/merge/resources/accounting/types/available_actions.py @@ -23,7 +23,7 @@ class AvailableActions(UniversalBaseModel): integration: AccountIntegration passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/accounting/types/balance_sheet.py b/src/merge/resources/accounting/types/balance_sheet.py index c35d04d3..d53242aa 100644 --- a/src/merge/resources/accounting/types/balance_sheet.py +++ b/src/merge/resources/accounting/types/balance_sheet.py @@ -24,28 +24,28 @@ class BalanceSheet(UniversalBaseModel): Fetch from the `LIST BalanceSheets` endpoint and view a company's balance sheets. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The balance sheet's name. """ - currency: typing.Optional[BalanceSheetCurrency] = pydantic.Field() + currency: typing.Optional[BalanceSheetCurrency] = pydantic.Field(default=None) """ The balance sheet's currency. @@ -357,36 +357,36 @@ class BalanceSheet(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - company: typing.Optional[BalanceSheetCompany] = pydantic.Field() + company: typing.Optional[BalanceSheetCompany] = pydantic.Field(default=None) """ `Company` object for the given `BalanceSheet` object. """ - date: typing.Optional[dt.datetime] = pydantic.Field() + date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The balance sheet's date. The balance sheet data will reflect the company's financial position this point in time. """ - net_assets: typing.Optional[float] = pydantic.Field() + net_assets: typing.Optional[float] = pydantic.Field(default=None) """ The balance sheet's net assets. """ - assets: typing.Optional[typing.List[ReportItem]] - liabilities: typing.Optional[typing.List[ReportItem]] - equity: typing.Optional[typing.List[ReportItem]] - remote_generated_at: typing.Optional[dt.datetime] = pydantic.Field() + assets: typing.Optional[typing.List[ReportItem]] = None + liabilities: typing.Optional[typing.List[ReportItem]] = None + equity: typing.Optional[typing.List[ReportItem]] = None + remote_generated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time that balance sheet was generated by the accounting system. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/cash_flow_statement.py b/src/merge/resources/accounting/types/cash_flow_statement.py index ba039347..cf1daad5 100644 --- a/src/merge/resources/accounting/types/cash_flow_statement.py +++ b/src/merge/resources/accounting/types/cash_flow_statement.py @@ -24,28 +24,28 @@ class CashFlowStatement(UniversalBaseModel): Fetch from the `LIST CashFlowStatements` endpoint and view a company's cash flow statements. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The cash flow statement's name. """ - currency: typing.Optional[CashFlowStatementCurrency] = pydantic.Field() + currency: typing.Optional[CashFlowStatementCurrency] = pydantic.Field(default=None) """ The cash flow statement's currency. @@ -357,46 +357,46 @@ class CashFlowStatement(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - company: typing.Optional[CashFlowStatementCompany] = pydantic.Field() + company: typing.Optional[CashFlowStatementCompany] = pydantic.Field(default=None) """ The company the cash flow statement belongs to. """ - start_period: typing.Optional[dt.datetime] = pydantic.Field() + start_period: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The cash flow statement's start period. """ - end_period: typing.Optional[dt.datetime] = pydantic.Field() + end_period: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The cash flow statement's end period. """ - cash_at_beginning_of_period: typing.Optional[float] = pydantic.Field() + cash_at_beginning_of_period: typing.Optional[float] = pydantic.Field(default=None) """ Cash and cash equivalents at the beginning of the cash flow statement's period. """ - cash_at_end_of_period: typing.Optional[float] = pydantic.Field() + cash_at_end_of_period: typing.Optional[float] = pydantic.Field(default=None) """ Cash and cash equivalents at the beginning of the cash flow statement's period. """ - operating_activities: typing.Optional[typing.List[ReportItem]] - investing_activities: typing.Optional[typing.List[ReportItem]] - financing_activities: typing.Optional[typing.List[ReportItem]] - remote_generated_at: typing.Optional[dt.datetime] = pydantic.Field() + operating_activities: typing.Optional[typing.List[ReportItem]] = None + investing_activities: typing.Optional[typing.List[ReportItem]] = None + financing_activities: typing.Optional[typing.List[ReportItem]] = None + remote_generated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time that cash flow statement was generated by the accounting system. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/company_info.py b/src/merge/resources/accounting/types/company_info.py index a3a8c3ed..67de6246 100644 --- a/src/merge/resources/accounting/types/company_info.py +++ b/src/merge/resources/accounting/types/company_info.py @@ -24,48 +24,48 @@ class CompanyInfo(UniversalBaseModel): Fetch from the `GET CompanyInfo` endpoint and view a company's information. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The company's name. """ - legal_name: typing.Optional[str] = pydantic.Field() + legal_name: typing.Optional[str] = pydantic.Field(default=None) """ The company's legal name. """ - tax_number: typing.Optional[str] = pydantic.Field() + tax_number: typing.Optional[str] = pydantic.Field(default=None) """ The company's tax number. """ - fiscal_year_end_month: typing.Optional[int] = pydantic.Field() + fiscal_year_end_month: typing.Optional[int] = pydantic.Field(default=None) """ The company's fiscal year end month. """ - fiscal_year_end_day: typing.Optional[int] = pydantic.Field() + fiscal_year_end_day: typing.Optional[int] = pydantic.Field(default=None) """ The company's fiscal year end day. """ - currency: typing.Optional[CompanyInfoCurrency] = pydantic.Field() + currency: typing.Optional[CompanyInfoCurrency] = pydantic.Field(default=None) """ The currency set in the company's accounting platform. @@ -377,25 +377,25 @@ class CompanyInfo(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's company was created. """ - urls: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + urls: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The company's urls. """ - addresses: typing.Optional[typing.List[Address]] - phone_numbers: typing.Optional[typing.List[AccountingPhoneNumber]] - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + addresses: typing.Optional[typing.List[Address]] = None + phone_numbers: typing.Optional[typing.List[AccountingPhoneNumber]] = 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/contact.py b/src/merge/resources/accounting/types/contact.py index 31c9c2fd..448058b1 100644 --- a/src/merge/resources/accounting/types/contact.py +++ b/src/merge/resources/accounting/types/contact.py @@ -28,48 +28,48 @@ class Contact(UniversalBaseModel): Fetch from the `LIST Contacts` endpoint and view a company's contacts. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The contact's name. """ - is_supplier: typing.Optional[bool] = pydantic.Field() + is_supplier: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the contact is a supplier. """ - is_customer: typing.Optional[bool] = pydantic.Field() + is_customer: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the contact is a customer. """ - email_address: typing.Optional[str] = pydantic.Field() + email_address: typing.Optional[str] = pydantic.Field(default=None) """ The contact's email address. """ - tax_number: typing.Optional[str] = pydantic.Field() + tax_number: typing.Optional[str] = pydantic.Field(default=None) """ The contact's tax number. """ - status: typing.Optional[ContactStatus] = pydantic.Field() + status: typing.Optional[ContactStatus] = pydantic.Field(default=None) """ The contact's status @@ -77,39 +77,39 @@ class Contact(UniversalBaseModel): - `ARCHIVED` - ARCHIVED """ - currency: typing.Optional[str] = pydantic.Field() + currency: typing.Optional[str] = pydantic.Field(default=None) """ The currency the contact's transactions are in. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's contact was updated. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the contact belongs to. """ - addresses: typing.Optional[typing.List[typing.Optional[ContactAddressesItem]]] = pydantic.Field() + addresses: typing.Optional[typing.List[typing.Optional[ContactAddressesItem]]] = pydantic.Field(default=None) """ `Address` object IDs for the given `Contacts` object. """ - phone_numbers: typing.Optional[typing.List[AccountingPhoneNumber]] = pydantic.Field() + phone_numbers: typing.Optional[typing.List[AccountingPhoneNumber]] = pydantic.Field(default=None) """ `AccountingPhoneNumber` object for the given `Contacts` object. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/contact_request.py b/src/merge/resources/accounting/types/contact_request.py index b1a3ebd4..4758ade2 100644 --- a/src/merge/resources/accounting/types/contact_request.py +++ b/src/merge/resources/accounting/types/contact_request.py @@ -26,32 +26,32 @@ class ContactRequest(UniversalBaseModel): Fetch from the `LIST Contacts` endpoint and view a company's contacts. """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The contact's name. """ - is_supplier: typing.Optional[bool] = pydantic.Field() + is_supplier: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the contact is a supplier. """ - is_customer: typing.Optional[bool] = pydantic.Field() + is_customer: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the contact is a customer. """ - email_address: typing.Optional[str] = pydantic.Field() + email_address: typing.Optional[str] = pydantic.Field(default=None) """ The contact's email address. """ - tax_number: typing.Optional[str] = pydantic.Field() + tax_number: typing.Optional[str] = pydantic.Field(default=None) """ The contact's tax number. """ - status: typing.Optional[ContactRequestStatus] = pydantic.Field() + status: typing.Optional[ContactRequestStatus] = pydantic.Field(default=None) """ The contact's status @@ -59,29 +59,29 @@ class ContactRequest(UniversalBaseModel): - `ARCHIVED` - ARCHIVED """ - currency: typing.Optional[str] = pydantic.Field() + currency: typing.Optional[str] = pydantic.Field(default=None) """ The currency the contact's transactions are in. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the contact belongs to. """ - addresses: typing.Optional[typing.List[typing.Optional[ContactRequestAddressesItem]]] = pydantic.Field() + addresses: typing.Optional[typing.List[typing.Optional[ContactRequestAddressesItem]]] = pydantic.Field(default=None) """ `Address` object IDs for the given `Contacts` object. """ - phone_numbers: typing.Optional[typing.List[AccountingPhoneNumberRequest]] = pydantic.Field() + phone_numbers: typing.Optional[typing.List[AccountingPhoneNumberRequest]] = pydantic.Field(default=None) """ `AccountingPhoneNumber` object for the given `Contacts` object. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/contact_response.py b/src/merge/resources/accounting/types/contact_response.py index e6b04c7b..d4f98755 100644 --- a/src/merge/resources/accounting/types/contact_response.py +++ b/src/merge/resources/accounting/types/contact_response.py @@ -14,7 +14,7 @@ class ContactResponse(UniversalBaseModel): model: Contact warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/accounting/types/credit_note.py b/src/merge/resources/accounting/types/credit_note.py index bd46401b..3554359c 100644 --- a/src/merge/resources/accounting/types/credit_note.py +++ b/src/merge/resources/accounting/types/credit_note.py @@ -30,28 +30,28 @@ class CreditNote(UniversalBaseModel): Fetch from the `LIST CreditNotes` endpoint and view a company's credit notes. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - transaction_date: typing.Optional[dt.datetime] = pydantic.Field() + transaction_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The credit note's transaction date. """ - status: typing.Optional[CreditNoteStatus] = pydantic.Field() + status: typing.Optional[CreditNoteStatus] = pydantic.Field(default=None) """ The credit note's status. @@ -60,44 +60,44 @@ class CreditNote(UniversalBaseModel): - `PAID` - PAID """ - number: typing.Optional[str] = pydantic.Field() + number: typing.Optional[str] = pydantic.Field(default=None) """ The credit note's number. """ - contact: typing.Optional[CreditNoteContact] = pydantic.Field() + contact: typing.Optional[CreditNoteContact] = pydantic.Field(default=None) """ The credit note's contact. """ - company: typing.Optional[CreditNoteCompany] = pydantic.Field() + company: typing.Optional[CreditNoteCompany] = pydantic.Field(default=None) """ The company the credit note belongs to. """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The credit note's exchange rate. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The credit note's total amount. """ - remaining_credit: typing.Optional[float] = pydantic.Field() + remaining_credit: typing.Optional[float] = pydantic.Field(default=None) """ The amount of value remaining in the credit note that the customer can use. """ - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - line_items: typing.Optional[typing.List[CreditNoteLineItem]] - tracking_categories: typing.Optional[typing.List[typing.Optional[CreditNoteTrackingCategoriesItem]]] - currency: typing.Optional[CreditNoteCurrency] = pydantic.Field() + line_items: typing.Optional[typing.List[CreditNoteLineItem]] = None + tracking_categories: typing.Optional[typing.List[typing.Optional[CreditNoteTrackingCategoriesItem]]] = None + currency: typing.Optional[CreditNoteCurrency] = pydantic.Field(default=None) """ The credit note's currency. @@ -409,38 +409,40 @@ class CreditNote(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's credit note was created. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's credit note was updated. """ - payments: typing.Optional[typing.List[typing.Optional[CreditNotePaymentsItem]]] = pydantic.Field() + payments: typing.Optional[typing.List[typing.Optional[CreditNotePaymentsItem]]] = pydantic.Field(default=None) """ Array of `Payment` object IDs """ - applied_payments: typing.Optional[typing.List[typing.Optional[CreditNoteAppliedPaymentsItem]]] = pydantic.Field() + applied_payments: typing.Optional[typing.List[typing.Optional[CreditNoteAppliedPaymentsItem]]] = pydantic.Field( + default=None + ) """ A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ - accounting_period: typing.Optional[CreditNoteAccountingPeriod] = pydantic.Field() + accounting_period: typing.Optional[CreditNoteAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the CreditNote was generated in. """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/credit_note_line_item.py b/src/merge/resources/accounting/types/credit_note_line_item.py index 216581c6..2fe848cc 100644 --- a/src/merge/resources/accounting/types/credit_note_line_item.py +++ b/src/merge/resources/accounting/types/credit_note_line_item.py @@ -10,79 +10,79 @@ class CreditNoteLineItem(UniversalBaseModel): - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - item: typing.Optional[CreditNoteLineItemItem] - name: typing.Optional[str] = pydantic.Field() + item: typing.Optional[CreditNoteLineItemItem] = None + name: typing.Optional[str] = pydantic.Field(default=None) """ The credit note line item's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The description of the item that is owed. """ - quantity: typing.Optional[str] = pydantic.Field() + quantity: typing.Optional[str] = pydantic.Field(default=None) """ The credit note line item's quantity. """ - memo: typing.Optional[str] = pydantic.Field() + memo: typing.Optional[str] = pydantic.Field(default=None) """ The credit note line item's memo. """ - unit_price: typing.Optional[str] = pydantic.Field() + unit_price: typing.Optional[str] = pydantic.Field(default=None) """ The credit note line item's unit price. """ - tax_rate: typing.Optional[str] = pydantic.Field() + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - total_line_amount: typing.Optional[str] = pydantic.Field() + total_line_amount: typing.Optional[str] = pydantic.Field(default=None) """ The credit note line item's total. """ - tracking_category: typing.Optional[str] = pydantic.Field() + tracking_category: typing.Optional[str] = pydantic.Field(default=None) """ The credit note line item's associated tracking category. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The credit note line item's associated tracking categories. """ - account: typing.Optional[str] = pydantic.Field() + account: typing.Optional[str] = pydantic.Field(default=None) """ The credit note line item's account. """ - company: typing.Optional[CreditNoteLineItemCompany] = pydantic.Field() + company: typing.Optional[CreditNoteLineItemCompany] = pydantic.Field(default=None) """ The company the credit note belongs to. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/accounting/types/data_passthrough_request.py b/src/merge/resources/accounting/types/data_passthrough_request.py index f2718105..2b0595cf 100644 --- a/src/merge/resources/accounting/types/data_passthrough_request.py +++ b/src/merge/resources/accounting/types/data_passthrough_request.py @@ -28,28 +28,28 @@ class DataPassthroughRequest(UniversalBaseModel): The path of the request in the third party's platform. """ - base_url_override: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + 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[RequestFormatEnum] - normalize_response: typing.Optional[bool] = pydantic.Field() + request_format: typing.Optional[RequestFormatEnum] = 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`. """ diff --git a/src/merge/resources/accounting/types/error_validation_problem.py b/src/merge/resources/accounting/types/error_validation_problem.py index 58ea87e6..91565918 100644 --- a/src/merge/resources/accounting/types/error_validation_problem.py +++ b/src/merge/resources/accounting/types/error_validation_problem.py @@ -8,7 +8,7 @@ class ErrorValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/accounting/types/expense.py b/src/merge/resources/accounting/types/expense.py index 1336b7c8..318ca76b 100644 --- a/src/merge/resources/accounting/types/expense.py +++ b/src/merge/resources/accounting/types/expense.py @@ -31,58 +31,58 @@ class Expense(UniversalBaseModel): Fetch from the `GET Expense` endpoint and view a company's expense. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - transaction_date: typing.Optional[dt.datetime] = pydantic.Field() + transaction_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the transaction occurred. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the expense was created. """ - account: typing.Optional[ExpenseAccount] = pydantic.Field() + account: typing.Optional[ExpenseAccount] = pydantic.Field(default=None) """ The expense's payment account. """ - contact: typing.Optional[ExpenseContact] = pydantic.Field() + contact: typing.Optional[ExpenseContact] = pydantic.Field(default=None) """ The expense's contact. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The expense's total amount. """ - sub_total: typing.Optional[float] = pydantic.Field() + sub_total: typing.Optional[float] = pydantic.Field(default=None) """ The expense's total amount before tax. """ - total_tax_amount: typing.Optional[float] = pydantic.Field() + total_tax_amount: typing.Optional[float] = pydantic.Field(default=None) """ The expense's total tax amount. """ - currency: typing.Optional[ExpenseCurrency] = pydantic.Field() + currency: typing.Optional[ExpenseCurrency] = pydantic.Field(default=None) """ The expense's currency. @@ -394,41 +394,41 @@ class Expense(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The expense's exchange rate. """ - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - company: typing.Optional[ExpenseCompany] = pydantic.Field() + company: typing.Optional[ExpenseCompany] = pydantic.Field(default=None) """ The company the expense belongs to. """ - memo: typing.Optional[str] = pydantic.Field() + memo: typing.Optional[str] = pydantic.Field(default=None) """ The expense's private note. """ - lines: typing.Optional[typing.List[ExpenseLine]] - tracking_categories: typing.Optional[typing.List[typing.Optional[ExpenseTrackingCategoriesItem]]] - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + lines: typing.Optional[typing.List[ExpenseLine]] = None + tracking_categories: typing.Optional[typing.List[typing.Optional[ExpenseTrackingCategoriesItem]]] = 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/). """ - accounting_period: typing.Optional[ExpenseAccountingPeriod] = pydantic.Field() + accounting_period: typing.Optional[ExpenseAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the Expense was generated in. """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/expense_line.py b/src/merge/resources/accounting/types/expense_line.py index f6f2b10f..b0bb7fc7 100644 --- a/src/merge/resources/accounting/types/expense_line.py +++ b/src/merge/resources/accounting/types/expense_line.py @@ -26,46 +26,46 @@ class ExpenseLine(UniversalBaseModel): Fetch from the `GET Expense` endpoint and view the expense's line items. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - item: typing.Optional[ExpenseLineItem] = pydantic.Field() + item: typing.Optional[ExpenseLineItem] = pydantic.Field(default=None) """ The line's item. """ - net_amount: typing.Optional[float] = pydantic.Field() + net_amount: typing.Optional[float] = pydantic.Field(default=None) """ The line's net amount. """ - tracking_category: typing.Optional[ExpenseLineTrackingCategory] + tracking_category: typing.Optional[ExpenseLineTrackingCategory] = None tracking_categories: typing.Optional[typing.List[typing.Optional[ExpenseLineTrackingCategoriesItem]]] = ( - pydantic.Field() + pydantic.Field(default=None) ) """ The expense line item's associated tracking categories. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the line belongs to. """ - currency: typing.Optional[ExpenseLineCurrency] = pydantic.Field() + currency: typing.Optional[ExpenseLineCurrency] = pydantic.Field(default=None) """ The expense line item's currency. @@ -377,32 +377,32 @@ class ExpenseLine(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - account: typing.Optional[ExpenseLineAccount] = pydantic.Field() + account: typing.Optional[ExpenseLineAccount] = pydantic.Field(default=None) """ The expense's payment account. """ - contact: typing.Optional[ExpenseLineContact] = pydantic.Field() + contact: typing.Optional[ExpenseLineContact] = pydantic.Field(default=None) """ The expense's contact. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The description of the item that was purchased by the company. """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The expense line item's exchange rate. """ - tax_rate: typing.Optional[str] = pydantic.Field() + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/accounting/types/expense_line_request.py b/src/merge/resources/accounting/types/expense_line_request.py index fc9b08f9..34e290f6 100644 --- a/src/merge/resources/accounting/types/expense_line_request.py +++ b/src/merge/resources/accounting/types/expense_line_request.py @@ -26,35 +26,35 @@ class ExpenseLineRequest(UniversalBaseModel): Fetch from the `GET Expense` endpoint and view the expense's line items. """ - remote_id: typing.Optional[str] = pydantic.Field() + remote_id: typing.Optional[str] = pydantic.Field(default=None) """ The third-party API ID of the matching object. """ - item: typing.Optional[ExpenseLineRequestItem] = pydantic.Field() + item: typing.Optional[ExpenseLineRequestItem] = pydantic.Field(default=None) """ The line's item. """ - net_amount: typing.Optional[float] = pydantic.Field() + net_amount: typing.Optional[float] = pydantic.Field(default=None) """ The line's net amount. """ - tracking_category: typing.Optional[ExpenseLineRequestTrackingCategory] + tracking_category: typing.Optional[ExpenseLineRequestTrackingCategory] = None tracking_categories: typing.Optional[typing.List[typing.Optional[ExpenseLineRequestTrackingCategoriesItem]]] = ( - pydantic.Field() + pydantic.Field(default=None) ) """ The expense line item's associated tracking categories. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the line belongs to. """ - currency: typing.Optional[ExpenseLineRequestCurrency] = pydantic.Field() + currency: typing.Optional[ExpenseLineRequestCurrency] = pydantic.Field(default=None) """ The expense line item's currency. @@ -366,34 +366,34 @@ class ExpenseLineRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - account: typing.Optional[ExpenseLineRequestAccount] = pydantic.Field() + account: typing.Optional[ExpenseLineRequestAccount] = pydantic.Field(default=None) """ The expense's payment account. """ - contact: typing.Optional[ExpenseLineRequestContact] = pydantic.Field() + contact: typing.Optional[ExpenseLineRequestContact] = pydantic.Field(default=None) """ The expense's contact. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The description of the item that was purchased by the company. """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The expense line item's exchange rate. """ - tax_rate: typing.Optional[str] = pydantic.Field() + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/expense_request.py b/src/merge/resources/accounting/types/expense_request.py index 96e99746..97082c0a 100644 --- a/src/merge/resources/accounting/types/expense_request.py +++ b/src/merge/resources/accounting/types/expense_request.py @@ -30,37 +30,37 @@ class ExpenseRequest(UniversalBaseModel): Fetch from the `GET Expense` endpoint and view a company's expense. """ - transaction_date: typing.Optional[dt.datetime] = pydantic.Field() + transaction_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the transaction occurred. """ - account: typing.Optional[ExpenseRequestAccount] = pydantic.Field() + account: typing.Optional[ExpenseRequestAccount] = pydantic.Field(default=None) """ The expense's payment account. """ - contact: typing.Optional[ExpenseRequestContact] = pydantic.Field() + contact: typing.Optional[ExpenseRequestContact] = pydantic.Field(default=None) """ The expense's contact. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The expense's total amount. """ - sub_total: typing.Optional[float] = pydantic.Field() + sub_total: typing.Optional[float] = pydantic.Field(default=None) """ The expense's total amount before tax. """ - total_tax_amount: typing.Optional[float] = pydantic.Field() + total_tax_amount: typing.Optional[float] = pydantic.Field(default=None) """ The expense's total tax amount. """ - currency: typing.Optional[ExpenseRequestCurrency] = pydantic.Field() + currency: typing.Optional[ExpenseRequestCurrency] = pydantic.Field(default=None) """ The expense's currency. @@ -372,36 +372,36 @@ class ExpenseRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The expense's exchange rate. """ - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - company: typing.Optional[ExpenseRequestCompany] = pydantic.Field() + company: typing.Optional[ExpenseRequestCompany] = pydantic.Field(default=None) """ The company the expense belongs to. """ - memo: typing.Optional[str] = pydantic.Field() + memo: typing.Optional[str] = pydantic.Field(default=None) """ The expense's private note. """ - lines: typing.Optional[typing.List[ExpenseLineRequest]] - tracking_categories: typing.Optional[typing.List[typing.Optional[ExpenseRequestTrackingCategoriesItem]]] - accounting_period: typing.Optional[ExpenseRequestAccountingPeriod] = pydantic.Field() + lines: typing.Optional[typing.List[ExpenseLineRequest]] = None + tracking_categories: typing.Optional[typing.List[typing.Optional[ExpenseRequestTrackingCategoriesItem]]] = None + accounting_period: typing.Optional[ExpenseRequestAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the Expense was generated in. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/expense_response.py b/src/merge/resources/accounting/types/expense_response.py index 2a7eba90..1abc82b2 100644 --- a/src/merge/resources/accounting/types/expense_response.py +++ b/src/merge/resources/accounting/types/expense_response.py @@ -14,7 +14,7 @@ class ExpenseResponse(UniversalBaseModel): model: Expense warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/accounting/types/external_target_field_api.py b/src/merge/resources/accounting/types/external_target_field_api.py index 18988d44..1ed19a99 100644 --- a/src/merge/resources/accounting/types/external_target_field_api.py +++ b/src/merge/resources/accounting/types/external_target_field_api.py @@ -7,9 +7,9 @@ class ExternalTargetFieldApi(UniversalBaseModel): - name: typing.Optional[str] - description: typing.Optional[str] - is_mapped: typing.Optional[str] + 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 diff --git a/src/merge/resources/accounting/types/external_target_field_api_response.py b/src/merge/resources/accounting/types/external_target_field_api_response.py index 55629825..f47e9f0e 100644 --- a/src/merge/resources/accounting/types/external_target_field_api_response.py +++ b/src/merge/resources/accounting/types/external_target_field_api_response.py @@ -8,33 +8,53 @@ class ExternalTargetFieldApiResponse(UniversalBaseModel): - account: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Account") + account: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Account", default=None) accounting_attachment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( - alias="AccountingAttachment" + alias="AccountingAttachment", default=None + ) + balance_sheet: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="BalanceSheet", default=None ) - balance_sheet: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="BalanceSheet") cash_flow_statement: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( - alias="CashFlowStatement" - ) - company_info: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="CompanyInfo") - contact: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Contact") - income_statement: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="IncomeStatement") - credit_note: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="CreditNote") - item: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Item") - purchase_order: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="PurchaseOrder") - tracking_category: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="TrackingCategory") - journal_entry: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="JournalEntry") - tax_rate: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="TaxRate") - invoice: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Invoice") - payment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Payment") - expense: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Expense") - vendor_credit: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="VendorCredit") - transaction: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Transaction") - accounting_period: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="AccountingPeriod") + alias="CashFlowStatement", default=None + ) + company_info: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="CompanyInfo", default=None + ) + contact: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Contact", default=None) + income_statement: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="IncomeStatement", default=None + ) + credit_note: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="CreditNote", default=None) + item: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Item", default=None) + purchase_order: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="PurchaseOrder", default=None + ) + tracking_category: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="TrackingCategory", default=None + ) + journal_entry: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="JournalEntry", default=None + ) + tax_rate: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="TaxRate", default=None) + invoice: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Invoice", default=None) + payment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Payment", default=None) + expense: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Expense", default=None) + vendor_credit: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="VendorCredit", default=None + ) + transaction: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="Transaction", default=None + ) + accounting_period: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="AccountingPeriod", default=None + ) general_ledger_transaction: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( - alias="GeneralLedgerTransaction" + alias="GeneralLedgerTransaction", default=None + ) + bank_feed_account: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="BankFeedAccount", default=None ) - bank_feed_account: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="BankFeedAccount") if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/field_mapping_api_instance.py b/src/merge/resources/accounting/types/field_mapping_api_instance.py index ef4d9c48..1cc2f4a2 100644 --- a/src/merge/resources/accounting/types/field_mapping_api_instance.py +++ b/src/merge/resources/accounting/types/field_mapping_api_instance.py @@ -9,10 +9,10 @@ class FieldMappingApiInstance(UniversalBaseModel): - id: typing.Optional[str] - is_integration_wide: typing.Optional[bool] - target_field: typing.Optional[FieldMappingApiInstanceTargetField] - remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] + id: typing.Optional[str] = None + is_integration_wide: typing.Optional[bool] = None + target_field: typing.Optional[FieldMappingApiInstanceTargetField] = None + remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py b/src/merge/resources/accounting/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py index 14c37c76..9eeb4fbf 100644 --- a/src/merge/resources/accounting/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py +++ b/src/merge/resources/accounting/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py @@ -7,9 +7,9 @@ class FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo(UniversalBaseModel): - method: typing.Optional[str] - url_path: typing.Optional[str] - field_traversal_path: typing.Optional[typing.List[str]] + 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 diff --git a/src/merge/resources/accounting/types/field_mapping_api_instance_response.py b/src/merge/resources/accounting/types/field_mapping_api_instance_response.py index 82266664..f37a9cca 100644 --- a/src/merge/resources/accounting/types/field_mapping_api_instance_response.py +++ b/src/merge/resources/accounting/types/field_mapping_api_instance_response.py @@ -8,33 +8,55 @@ class FieldMappingApiInstanceResponse(UniversalBaseModel): - account: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Account") + account: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Account", default=None) accounting_attachment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( - alias="AccountingAttachment" + alias="AccountingAttachment", default=None + ) + balance_sheet: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="BalanceSheet", default=None ) - balance_sheet: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="BalanceSheet") cash_flow_statement: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( - alias="CashFlowStatement" - ) - company_info: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="CompanyInfo") - contact: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Contact") - income_statement: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="IncomeStatement") - credit_note: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="CreditNote") - item: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Item") - purchase_order: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="PurchaseOrder") - tracking_category: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="TrackingCategory") - journal_entry: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="JournalEntry") - tax_rate: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="TaxRate") - invoice: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Invoice") - payment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Payment") - expense: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Expense") - vendor_credit: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="VendorCredit") - transaction: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Transaction") - accounting_period: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="AccountingPeriod") + alias="CashFlowStatement", default=None + ) + company_info: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="CompanyInfo", default=None + ) + contact: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Contact", default=None) + income_statement: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="IncomeStatement", default=None + ) + credit_note: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="CreditNote", default=None + ) + item: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Item", default=None) + purchase_order: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="PurchaseOrder", default=None + ) + tracking_category: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="TrackingCategory", default=None + ) + journal_entry: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="JournalEntry", default=None + ) + tax_rate: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="TaxRate", default=None) + invoice: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Invoice", default=None) + payment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Payment", default=None) + expense: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Expense", default=None) + vendor_credit: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="VendorCredit", default=None + ) + transaction: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="Transaction", default=None + ) + accounting_period: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="AccountingPeriod", default=None + ) general_ledger_transaction: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( - alias="GeneralLedgerTransaction" + alias="GeneralLedgerTransaction", default=None + ) + bank_feed_account: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="BankFeedAccount", default=None ) - bank_feed_account: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="BankFeedAccount") if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/field_mapping_instance_response.py b/src/merge/resources/accounting/types/field_mapping_instance_response.py index a56aeb93..2123f4d3 100644 --- a/src/merge/resources/accounting/types/field_mapping_instance_response.py +++ b/src/merge/resources/accounting/types/field_mapping_instance_response.py @@ -14,7 +14,7 @@ class FieldMappingInstanceResponse(UniversalBaseModel): model: FieldMappingApiInstance warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/accounting/types/field_permission_deserializer.py b/src/merge/resources/accounting/types/field_permission_deserializer.py index 9670537a..ea7cc235 100644 --- a/src/merge/resources/accounting/types/field_permission_deserializer.py +++ b/src/merge/resources/accounting/types/field_permission_deserializer.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializer(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/accounting/types/field_permission_deserializer_request.py b/src/merge/resources/accounting/types/field_permission_deserializer_request.py index 04e14608..e5617ad6 100644 --- a/src/merge/resources/accounting/types/field_permission_deserializer_request.py +++ b/src/merge/resources/accounting/types/field_permission_deserializer_request.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializerRequest(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/accounting/types/income_statement.py b/src/merge/resources/accounting/types/income_statement.py index 97202a4a..7e25b2f4 100644 --- a/src/merge/resources/accounting/types/income_statement.py +++ b/src/merge/resources/accounting/types/income_statement.py @@ -24,28 +24,28 @@ class IncomeStatement(UniversalBaseModel): Fetch from the `GET IncomeStatement` endpoint and view a company's income statement for a given period. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The income statement's name. """ - currency: typing.Optional[IncomeStatementCurrency] = pydantic.Field() + currency: typing.Optional[IncomeStatementCurrency] = pydantic.Field(default=None) """ The income statement's currency. @@ -357,47 +357,47 @@ class IncomeStatement(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - company: typing.Optional[IncomeStatementCompany] = pydantic.Field() + company: typing.Optional[IncomeStatementCompany] = pydantic.Field(default=None) """ The company the income statement belongs to. """ - start_period: typing.Optional[dt.datetime] = pydantic.Field() + start_period: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The income statement's start period. """ - end_period: typing.Optional[dt.datetime] = pydantic.Field() + end_period: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The income statement's end period. """ - income: typing.Optional[typing.List[ReportItem]] - cost_of_sales: typing.Optional[typing.List[ReportItem]] - gross_profit: typing.Optional[float] = pydantic.Field() + income: typing.Optional[typing.List[ReportItem]] = None + cost_of_sales: typing.Optional[typing.List[ReportItem]] = None + gross_profit: typing.Optional[float] = pydantic.Field(default=None) """ The revenue minus the cost of sale. """ - operating_expenses: typing.Optional[typing.List[ReportItem]] - net_operating_income: typing.Optional[float] = pydantic.Field() + operating_expenses: typing.Optional[typing.List[ReportItem]] = None + net_operating_income: typing.Optional[float] = pydantic.Field(default=None) """ The revenue minus the operating expenses. """ - non_operating_expenses: typing.Optional[typing.List[ReportItem]] - net_income: typing.Optional[float] = pydantic.Field() + non_operating_expenses: typing.Optional[typing.List[ReportItem]] = None + net_income: typing.Optional[float] = pydantic.Field(default=None) """ The gross profit minus the total expenses. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/individual_common_model_scope_deserializer.py b/src/merge/resources/accounting/types/individual_common_model_scope_deserializer.py index 122df11c..70704314 100644 --- a/src/merge/resources/accounting/types/individual_common_model_scope_deserializer.py +++ b/src/merge/resources/accounting/types/individual_common_model_scope_deserializer.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializer(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializer]] - field_permissions: typing.Optional[FieldPermissionDeserializer] + 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 diff --git a/src/merge/resources/accounting/types/individual_common_model_scope_deserializer_request.py b/src/merge/resources/accounting/types/individual_common_model_scope_deserializer_request.py index a1a80902..d42dd53a 100644 --- a/src/merge/resources/accounting/types/individual_common_model_scope_deserializer_request.py +++ b/src/merge/resources/accounting/types/individual_common_model_scope_deserializer_request.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializerRequest(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializerRequest]] - field_permissions: typing.Optional[FieldPermissionDeserializerRequest] + 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 diff --git a/src/merge/resources/accounting/types/invoice.py b/src/merge/resources/accounting/types/invoice.py index 00213e03..098f73a0 100644 --- a/src/merge/resources/accounting/types/invoice.py +++ b/src/merge/resources/accounting/types/invoice.py @@ -35,23 +35,23 @@ class Invoice(UniversalBaseModel): Fetch from the `LIST Invoices` endpoint and view a company's invoices. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - type: typing.Optional[InvoiceType] = pydantic.Field() + type: typing.Optional[InvoiceType] = pydantic.Field(default=None) """ Whether the invoice is an accounts receivable or accounts payable. If `type` is `ACCOUNTS_PAYABLE`, the invoice is a bill. If `type` is `ACCOUNTS_RECEIVABLE`, it is an invoice. @@ -59,42 +59,42 @@ class Invoice(UniversalBaseModel): - `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE """ - contact: typing.Optional[InvoiceContact] = pydantic.Field() + contact: typing.Optional[InvoiceContact] = pydantic.Field(default=None) """ The invoice's contact. """ - number: typing.Optional[str] = pydantic.Field() + number: typing.Optional[str] = pydantic.Field(default=None) """ The invoice's number. """ - issue_date: typing.Optional[dt.datetime] = pydantic.Field() + issue_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The invoice's issue date. """ - due_date: typing.Optional[dt.datetime] = pydantic.Field() + due_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The invoice's due date. """ - paid_on_date: typing.Optional[dt.datetime] = pydantic.Field() + paid_on_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The invoice's paid date. """ - memo: typing.Optional[str] = pydantic.Field() + memo: typing.Optional[str] = pydantic.Field(default=None) """ The invoice's private note. """ - company: typing.Optional[InvoiceCompany] = pydantic.Field() + company: typing.Optional[InvoiceCompany] = pydantic.Field(default=None) """ The company the invoice belongs to. """ - currency: typing.Optional[InvoiceCurrency] = pydantic.Field() + currency: typing.Optional[InvoiceCurrency] = pydantic.Field(default=None) """ The invoice's currency. @@ -406,22 +406,22 @@ class Invoice(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The invoice's exchange rate. """ - total_discount: typing.Optional[float] = pydantic.Field() + total_discount: typing.Optional[float] = pydantic.Field(default=None) """ The total discounts applied to the total cost. """ - sub_total: typing.Optional[float] = pydantic.Field() + sub_total: typing.Optional[float] = pydantic.Field(default=None) """ The total amount being paid before taxes. """ - status: typing.Optional[InvoiceStatus] = pydantic.Field() + status: typing.Optional[InvoiceStatus] = pydantic.Field(default=None) """ The status of the invoice. @@ -433,57 +433,59 @@ class Invoice(UniversalBaseModel): - `VOID` - VOID """ - total_tax_amount: typing.Optional[float] = pydantic.Field() + total_tax_amount: typing.Optional[float] = pydantic.Field(default=None) """ The total amount being paid in taxes. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The invoice's total amount. """ - balance: typing.Optional[float] = pydantic.Field() + balance: typing.Optional[float] = pydantic.Field(default=None) """ The invoice's remaining balance. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's invoice entry was updated. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[InvoiceTrackingCategoriesItem]]] - accounting_period: typing.Optional[InvoiceAccountingPeriod] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[InvoiceTrackingCategoriesItem]]] = None + accounting_period: typing.Optional[InvoiceAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the Invoice was generated in. """ - purchase_orders: typing.Optional[typing.List[typing.Optional[InvoicePurchaseOrdersItem]]] - payments: typing.Optional[typing.List[typing.Optional[InvoicePaymentsItem]]] = pydantic.Field() + purchase_orders: typing.Optional[typing.List[typing.Optional[InvoicePurchaseOrdersItem]]] = None + payments: typing.Optional[typing.List[typing.Optional[InvoicePaymentsItem]]] = pydantic.Field(default=None) """ Array of `Payment` object IDs. """ - applied_payments: typing.Optional[typing.List[typing.Optional[InvoiceAppliedPaymentsItem]]] = pydantic.Field() + applied_payments: typing.Optional[typing.List[typing.Optional[InvoiceAppliedPaymentsItem]]] = pydantic.Field( + default=None + ) """ A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry. """ - line_items: typing.Optional[typing.List[InvoiceLineItem]] - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + line_items: typing.Optional[typing.List[InvoiceLineItem]] = None + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/invoice_line_item.py b/src/merge/resources/accounting/types/invoice_line_item.py index d5ad1019..1cc1a63f 100644 --- a/src/merge/resources/accounting/types/invoice_line_item.py +++ b/src/merge/resources/accounting/types/invoice_line_item.py @@ -26,43 +26,43 @@ class InvoiceLineItem(UniversalBaseModel): Fetch from the `GET Invoice` endpoint and view the invoice's line items. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The line item's description. """ - unit_price: typing.Optional[float] = pydantic.Field() + unit_price: typing.Optional[float] = pydantic.Field(default=None) """ The line item's unit price. """ - quantity: typing.Optional[float] = pydantic.Field() + quantity: typing.Optional[float] = pydantic.Field(default=None) """ The line item's quantity. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The line item's total amount. """ - currency: typing.Optional[InvoiceLineItemCurrency] = pydantic.Field() + currency: typing.Optional[InvoiceLineItemCurrency] = pydantic.Field(default=None) """ The line item's currency. @@ -374,38 +374,38 @@ class InvoiceLineItem(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The line item's exchange rate. """ - item: typing.Optional[InvoiceLineItemItem] - account: typing.Optional[InvoiceLineItemAccount] - tax_rate: typing.Optional[str] = pydantic.Field() + item: typing.Optional[InvoiceLineItemItem] = None + account: typing.Optional[InvoiceLineItemAccount] = None + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - tracking_category: typing.Optional[InvoiceLineItemTrackingCategory] + tracking_category: typing.Optional[InvoiceLineItemTrackingCategory] = None tracking_categories: typing.Optional[typing.List[typing.Optional[InvoiceLineItemTrackingCategoriesItem]]] = ( - pydantic.Field() + pydantic.Field(default=None) ) """ The invoice line item's associated tracking categories. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the line item belongs to. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/invoice_line_item_request.py b/src/merge/resources/accounting/types/invoice_line_item_request.py index 837beaa6..aa6998dc 100644 --- a/src/merge/resources/accounting/types/invoice_line_item_request.py +++ b/src/merge/resources/accounting/types/invoice_line_item_request.py @@ -25,32 +25,32 @@ class InvoiceLineItemRequest(UniversalBaseModel): Fetch from the `GET Invoice` endpoint and view the invoice's line items. """ - remote_id: typing.Optional[str] = pydantic.Field() + remote_id: typing.Optional[str] = pydantic.Field(default=None) """ The third-party API ID of the matching object. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The line item's description. """ - unit_price: typing.Optional[float] = pydantic.Field() + unit_price: typing.Optional[float] = pydantic.Field(default=None) """ The line item's unit price. """ - quantity: typing.Optional[float] = pydantic.Field() + quantity: typing.Optional[float] = pydantic.Field(default=None) """ The line item's quantity. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The line item's total amount. """ - currency: typing.Optional[InvoiceLineItemRequestCurrency] = pydantic.Field() + currency: typing.Optional[InvoiceLineItemRequestCurrency] = pydantic.Field(default=None) """ The line item's currency. @@ -362,34 +362,34 @@ class InvoiceLineItemRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The line item's exchange rate. """ - item: typing.Optional[InvoiceLineItemRequestItem] - account: typing.Optional[InvoiceLineItemRequestAccount] - tax_rate: typing.Optional[str] = pydantic.Field() + item: typing.Optional[InvoiceLineItemRequestItem] = None + account: typing.Optional[InvoiceLineItemRequestAccount] = None + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - tracking_category: typing.Optional[InvoiceLineItemRequestTrackingCategory] + tracking_category: typing.Optional[InvoiceLineItemRequestTrackingCategory] = None tracking_categories: typing.Optional[typing.List[typing.Optional[InvoiceLineItemRequestTrackingCategoriesItem]]] = ( - pydantic.Field() + pydantic.Field(default=None) ) """ The invoice line item's associated tracking categories. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the line item belongs to. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/invoice_request.py b/src/merge/resources/accounting/types/invoice_request.py index 85097b03..f8992d69 100644 --- a/src/merge/resources/accounting/types/invoice_request.py +++ b/src/merge/resources/accounting/types/invoice_request.py @@ -32,7 +32,7 @@ class InvoiceRequest(UniversalBaseModel): Fetch from the `LIST Invoices` endpoint and view a company's invoices. """ - type: typing.Optional[InvoiceRequestType] = pydantic.Field() + type: typing.Optional[InvoiceRequestType] = pydantic.Field(default=None) """ Whether the invoice is an accounts receivable or accounts payable. If `type` is `ACCOUNTS_PAYABLE`, the invoice is a bill. If `type` is `ACCOUNTS_RECEIVABLE`, it is an invoice. @@ -40,37 +40,37 @@ class InvoiceRequest(UniversalBaseModel): - `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE """ - contact: typing.Optional[InvoiceRequestContact] = pydantic.Field() + contact: typing.Optional[InvoiceRequestContact] = pydantic.Field(default=None) """ The invoice's contact. """ - number: typing.Optional[str] = pydantic.Field() + number: typing.Optional[str] = pydantic.Field(default=None) """ The invoice's number. """ - issue_date: typing.Optional[dt.datetime] = pydantic.Field() + issue_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The invoice's issue date. """ - due_date: typing.Optional[dt.datetime] = pydantic.Field() + due_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The invoice's due date. """ - paid_on_date: typing.Optional[dt.datetime] = pydantic.Field() + paid_on_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The invoice's paid date. """ - memo: typing.Optional[str] = pydantic.Field() + memo: typing.Optional[str] = pydantic.Field(default=None) """ The invoice's private note. """ - status: typing.Optional[InvoiceRequestStatus] = pydantic.Field() + status: typing.Optional[InvoiceRequestStatus] = pydantic.Field(default=None) """ The status of the invoice. @@ -82,12 +82,12 @@ class InvoiceRequest(UniversalBaseModel): - `VOID` - VOID """ - company: typing.Optional[InvoiceRequestCompany] = pydantic.Field() + company: typing.Optional[InvoiceRequestCompany] = pydantic.Field(default=None) """ The company the invoice belongs to. """ - currency: typing.Optional[InvoiceRequestCurrency] = pydantic.Field() + currency: typing.Optional[InvoiceRequestCurrency] = pydantic.Field(default=None) """ The invoice's currency. @@ -399,52 +399,52 @@ class InvoiceRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The invoice's exchange rate. """ - total_discount: typing.Optional[float] = pydantic.Field() + total_discount: typing.Optional[float] = pydantic.Field(default=None) """ The total discounts applied to the total cost. """ - sub_total: typing.Optional[float] = pydantic.Field() + sub_total: typing.Optional[float] = pydantic.Field(default=None) """ The total amount being paid before taxes. """ - total_tax_amount: typing.Optional[float] = pydantic.Field() + total_tax_amount: typing.Optional[float] = pydantic.Field(default=None) """ The total amount being paid in taxes. """ - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The invoice's total amount. """ - balance: typing.Optional[float] = pydantic.Field() + balance: typing.Optional[float] = pydantic.Field(default=None) """ The invoice's remaining balance. """ - payments: typing.Optional[typing.List[typing.Optional[InvoiceRequestPaymentsItem]]] = pydantic.Field() + payments: typing.Optional[typing.List[typing.Optional[InvoiceRequestPaymentsItem]]] = pydantic.Field(default=None) """ Array of `Payment` object IDs. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[InvoiceRequestTrackingCategoriesItem]]] - line_items: typing.Optional[typing.List[InvoiceLineItemRequest]] - purchase_orders: typing.Optional[typing.List[typing.Optional[InvoiceRequestPurchaseOrdersItem]]] - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + tracking_categories: typing.Optional[typing.List[typing.Optional[InvoiceRequestTrackingCategoriesItem]]] = None + line_items: typing.Optional[typing.List[InvoiceLineItemRequest]] = None + purchase_orders: typing.Optional[typing.List[typing.Optional[InvoiceRequestPurchaseOrdersItem]]] = None + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/invoice_response.py b/src/merge/resources/accounting/types/invoice_response.py index b2443598..0b2abc80 100644 --- a/src/merge/resources/accounting/types/invoice_response.py +++ b/src/merge/resources/accounting/types/invoice_response.py @@ -14,7 +14,7 @@ class InvoiceResponse(UniversalBaseModel): model: Invoice warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/accounting/types/issue.py b/src/merge/resources/accounting/types/issue.py index 5a584515..7adc1f31 100644 --- a/src/merge/resources/accounting/types/issue.py +++ b/src/merge/resources/accounting/types/issue.py @@ -9,8 +9,8 @@ class Issue(UniversalBaseModel): - id: typing.Optional[str] - status: typing.Optional[IssueStatus] = pydantic.Field() + id: typing.Optional[str] = None + status: typing.Optional[IssueStatus] = pydantic.Field(default=None) """ Status of the issue. Options: ('ONGOING', 'RESOLVED') @@ -19,11 +19,11 @@ class Issue(UniversalBaseModel): """ error_description: str - end_user: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - first_incident_time: typing.Optional[dt.datetime] - last_incident_time: typing.Optional[dt.datetime] - is_muted: typing.Optional[bool] - error_details: typing.Optional[typing.List[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 diff --git a/src/merge/resources/accounting/types/item.py b/src/merge/resources/accounting/types/item.py index 9b25289d..4b23e878 100644 --- a/src/merge/resources/accounting/types/item.py +++ b/src/merge/resources/accounting/types/item.py @@ -27,28 +27,28 @@ class Item(UniversalBaseModel): Fetch from the `LIST Items` endpoint and view a company's items. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The item's name. """ - status: typing.Optional[ItemStatus] = pydantic.Field() + status: typing.Optional[ItemStatus] = pydantic.Field(default=None) """ The item's status. @@ -56,53 +56,53 @@ class Item(UniversalBaseModel): - `ARCHIVED` - ARCHIVED """ - unit_price: typing.Optional[float] = pydantic.Field() + unit_price: typing.Optional[float] = pydantic.Field(default=None) """ The item's unit price. """ - purchase_price: typing.Optional[float] = pydantic.Field() + purchase_price: typing.Optional[float] = pydantic.Field(default=None) """ The price at which the item is purchased from a vendor. """ - purchase_account: typing.Optional[ItemPurchaseAccount] = pydantic.Field() + purchase_account: typing.Optional[ItemPurchaseAccount] = pydantic.Field(default=None) """ References the default account used to record a purchase of the item. """ - sales_account: typing.Optional[ItemSalesAccount] = pydantic.Field() + sales_account: typing.Optional[ItemSalesAccount] = pydantic.Field(default=None) """ References the default account used to record a sale. """ - company: typing.Optional[ItemCompany] = pydantic.Field() + company: typing.Optional[ItemCompany] = pydantic.Field(default=None) """ The company the item belongs to. """ - purchase_tax_rate: typing.Optional[ItemPurchaseTaxRate] = pydantic.Field() + purchase_tax_rate: typing.Optional[ItemPurchaseTaxRate] = pydantic.Field(default=None) """ The default purchase tax rate for this item. """ - sales_tax_rate: typing.Optional[ItemSalesTaxRate] = pydantic.Field() + sales_tax_rate: typing.Optional[ItemSalesTaxRate] = pydantic.Field(default=None) """ The default sales tax rate for this item. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's item note was updated. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/item_schema.py b/src/merge/resources/accounting/types/item_schema.py index cfe24209..7f82ffbb 100644 --- a/src/merge/resources/accounting/types/item_schema.py +++ b/src/merge/resources/accounting/types/item_schema.py @@ -9,9 +9,9 @@ class ItemSchema(UniversalBaseModel): - item_type: typing.Optional[ItemTypeEnum] - item_format: typing.Optional[ItemFormatEnum] - item_choices: typing.Optional[typing.List[str]] + item_type: typing.Optional[ItemTypeEnum] = None + item_format: typing.Optional[ItemFormatEnum] = None + item_choices: 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 diff --git a/src/merge/resources/accounting/types/journal_entry.py b/src/merge/resources/accounting/types/journal_entry.py index 0de4f12f..56b0d930 100644 --- a/src/merge/resources/accounting/types/journal_entry.py +++ b/src/merge/resources/accounting/types/journal_entry.py @@ -34,43 +34,45 @@ class JournalEntry(UniversalBaseModel): Fetch from the `GET JournalEntry` endpoint and view a company's journey entry. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - transaction_date: typing.Optional[dt.datetime] = pydantic.Field() + transaction_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The journal entry's transaction date. """ - payments: typing.Optional[typing.List[typing.Optional[JournalEntryPaymentsItem]]] = pydantic.Field() + payments: typing.Optional[typing.List[typing.Optional[JournalEntryPaymentsItem]]] = pydantic.Field(default=None) """ Array of `Payment` object IDs. """ - applied_payments: typing.Optional[typing.List[typing.Optional[JournalEntryAppliedPaymentsItem]]] = pydantic.Field() + applied_payments: typing.Optional[typing.List[typing.Optional[JournalEntryAppliedPaymentsItem]]] = pydantic.Field( + default=None + ) """ A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry. """ - memo: typing.Optional[str] = pydantic.Field() + memo: typing.Optional[str] = pydantic.Field(default=None) """ The journal entry's private note. """ - currency: typing.Optional[JournalEntryCurrency] = pydantic.Field() + currency: typing.Optional[JournalEntryCurrency] = pydantic.Field(default=None) """ The journal's currency. @@ -382,34 +384,34 @@ class JournalEntry(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The journal entry's exchange rate. """ - company: typing.Optional[JournalEntryCompany] = pydantic.Field() + company: typing.Optional[JournalEntryCompany] = pydantic.Field(default=None) """ The company the journal entry belongs to. """ - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - lines: typing.Optional[typing.List[JournalLine]] - journal_number: typing.Optional[str] = pydantic.Field() + lines: typing.Optional[typing.List[JournalLine]] = None + journal_number: typing.Optional[str] = pydantic.Field(default=None) """ Reference number for identifying journal entries. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[JournalEntryTrackingCategoriesItem]]] - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[JournalEntryTrackingCategoriesItem]]] = 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/). """ - posting_status: typing.Optional[JournalEntryPostingStatus] = pydantic.Field() + posting_status: typing.Optional[JournalEntryPostingStatus] = pydantic.Field(default=None) """ The journal's posting status. @@ -417,24 +419,24 @@ class JournalEntry(UniversalBaseModel): - `POSTED` - POSTED """ - accounting_period: typing.Optional[JournalEntryAccountingPeriod] = pydantic.Field() + accounting_period: typing.Optional[JournalEntryAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the JournalEntry was generated in. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's journal entry was created. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's journal entry was updated. """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/journal_entry_request.py b/src/merge/resources/accounting/types/journal_entry_request.py index 364c9ef1..22088d7e 100644 --- a/src/merge/resources/accounting/types/journal_entry_request.py +++ b/src/merge/resources/accounting/types/journal_entry_request.py @@ -27,22 +27,24 @@ class JournalEntryRequest(UniversalBaseModel): Fetch from the `GET JournalEntry` endpoint and view a company's journey entry. """ - transaction_date: typing.Optional[dt.datetime] = pydantic.Field() + transaction_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The journal entry's transaction date. """ - payments: typing.Optional[typing.List[typing.Optional[JournalEntryRequestPaymentsItem]]] = pydantic.Field() + payments: typing.Optional[typing.List[typing.Optional[JournalEntryRequestPaymentsItem]]] = pydantic.Field( + default=None + ) """ Array of `Payment` object IDs. """ - memo: typing.Optional[str] = pydantic.Field() + memo: typing.Optional[str] = pydantic.Field(default=None) """ The journal entry's private note. """ - currency: typing.Optional[JournalEntryRequestCurrency] = pydantic.Field() + currency: typing.Optional[JournalEntryRequestCurrency] = pydantic.Field(default=None) """ The journal's currency. @@ -354,29 +356,29 @@ class JournalEntryRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The journal entry's exchange rate. """ - company: typing.Optional[JournalEntryRequestCompany] = pydantic.Field() + company: typing.Optional[JournalEntryRequestCompany] = pydantic.Field(default=None) """ The company the journal entry belongs to. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[JournalEntryRequestTrackingCategoriesItem]]] - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[JournalEntryRequestTrackingCategoriesItem]]] = None + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - lines: typing.Optional[typing.List[JournalLineRequest]] - journal_number: typing.Optional[str] = pydantic.Field() + lines: typing.Optional[typing.List[JournalLineRequest]] = None + journal_number: typing.Optional[str] = pydantic.Field(default=None) """ Reference number for identifying journal entries. """ - posting_status: typing.Optional[JournalEntryRequestPostingStatus] = pydantic.Field() + posting_status: typing.Optional[JournalEntryRequestPostingStatus] = pydantic.Field(default=None) """ The journal's posting status. @@ -384,9 +386,9 @@ class JournalEntryRequest(UniversalBaseModel): - `POSTED` - POSTED """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/journal_entry_response.py b/src/merge/resources/accounting/types/journal_entry_response.py index b23209b3..b27eda55 100644 --- a/src/merge/resources/accounting/types/journal_entry_response.py +++ b/src/merge/resources/accounting/types/journal_entry_response.py @@ -14,7 +14,7 @@ class JournalEntryResponse(UniversalBaseModel): model: JournalEntry warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/accounting/types/journal_line.py b/src/merge/resources/accounting/types/journal_line.py index 90d1e01c..2351c55c 100644 --- a/src/merge/resources/accounting/types/journal_line.py +++ b/src/merge/resources/accounting/types/journal_line.py @@ -25,37 +25,37 @@ class JournalLine(UniversalBaseModel): Fetch from the `GET JournalEntry` endpoint and view the journal entry's line items. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - account: typing.Optional[JournalLineAccount] - net_amount: typing.Optional[float] = pydantic.Field() + account: typing.Optional[JournalLineAccount] = None + net_amount: typing.Optional[float] = pydantic.Field(default=None) """ The value of the line item including taxes and other fees. """ - tracking_category: typing.Optional[JournalLineTrackingCategory] + tracking_category: typing.Optional[JournalLineTrackingCategory] = None tracking_categories: typing.Optional[typing.List[typing.Optional[JournalLineTrackingCategoriesItem]]] = ( - pydantic.Field() + pydantic.Field(default=None) ) """ The journal line item's associated tracking categories. """ - currency: typing.Optional[JournalLineCurrency] = pydantic.Field() + currency: typing.Optional[JournalLineCurrency] = pydantic.Field(default=None) """ The journal line item's currency. @@ -367,33 +367,33 @@ class JournalLine(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the journal entry belongs to. """ - contact: typing.Optional[str] - tax_rate: typing.Optional[str] = pydantic.Field() + contact: typing.Optional[str] = None + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The line's description. """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The journal line item's exchange rate. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ - remote_fields: typing.Optional[typing.List[RemoteField]] + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/journal_line_request.py b/src/merge/resources/accounting/types/journal_line_request.py index e6c90dd3..4db21779 100644 --- a/src/merge/resources/accounting/types/journal_line_request.py +++ b/src/merge/resources/accounting/types/journal_line_request.py @@ -24,26 +24,26 @@ class JournalLineRequest(UniversalBaseModel): Fetch from the `GET JournalEntry` endpoint and view the journal entry's line items. """ - remote_id: typing.Optional[str] = pydantic.Field() + remote_id: typing.Optional[str] = pydantic.Field(default=None) """ The third-party API ID of the matching object. """ - account: typing.Optional[JournalLineRequestAccount] - net_amount: typing.Optional[float] = pydantic.Field() + account: typing.Optional[JournalLineRequestAccount] = None + net_amount: typing.Optional[float] = pydantic.Field(default=None) """ The value of the line item including taxes and other fees. """ - tracking_category: typing.Optional[JournalLineRequestTrackingCategory] + tracking_category: typing.Optional[JournalLineRequestTrackingCategory] = None tracking_categories: typing.Optional[typing.List[typing.Optional[JournalLineRequestTrackingCategoriesItem]]] = ( - pydantic.Field() + pydantic.Field(default=None) ) """ The journal line item's associated tracking categories. """ - currency: typing.Optional[JournalLineRequestCurrency] = pydantic.Field() + currency: typing.Optional[JournalLineRequestCurrency] = pydantic.Field(default=None) """ The journal line item's currency. @@ -355,30 +355,30 @@ class JournalLineRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the journal entry belongs to. """ - contact: typing.Optional[str] - tax_rate: typing.Optional[str] = pydantic.Field() + contact: typing.Optional[str] = None + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The line's description. """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The journal line item's exchange rate. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/link_token.py b/src/merge/resources/accounting/types/link_token.py index 1d25dddb..ac916d14 100644 --- a/src/merge/resources/accounting/types/link_token.py +++ b/src/merge/resources/accounting/types/link_token.py @@ -8,8 +8,8 @@ class LinkToken(UniversalBaseModel): link_token: str - integration_name: typing.Optional[str] - magic_link_url: typing.Optional[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 diff --git a/src/merge/resources/accounting/types/meta_response.py b/src/merge/resources/accounting/types/meta_response.py index 44e57fde..272535f0 100644 --- a/src/merge/resources/accounting/types/meta_response.py +++ b/src/merge/resources/accounting/types/meta_response.py @@ -9,8 +9,8 @@ class MetaResponse(UniversalBaseModel): request_schema: typing.Dict[str, typing.Optional[typing.Any]] - remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - status: typing.Optional[LinkedAccountStatus] + remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + status: typing.Optional[LinkedAccountStatus] = None has_conditional_params: bool has_required_linked_account_params: bool diff --git a/src/merge/resources/accounting/types/model_permission_deserializer.py b/src/merge/resources/accounting/types/model_permission_deserializer.py index b6d813e4..96f39e63 100644 --- a/src/merge/resources/accounting/types/model_permission_deserializer.py +++ b/src/merge/resources/accounting/types/model_permission_deserializer.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializer(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/accounting/types/model_permission_deserializer_request.py b/src/merge/resources/accounting/types/model_permission_deserializer_request.py index 5885627b..2619fb6a 100644 --- a/src/merge/resources/accounting/types/model_permission_deserializer_request.py +++ b/src/merge/resources/accounting/types/model_permission_deserializer_request.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializerRequest(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/accounting/types/multipart_form_field_request.py b/src/merge/resources/accounting/types/multipart_form_field_request.py index 80099016..507fa8c6 100644 --- a/src/merge/resources/accounting/types/multipart_form_field_request.py +++ b/src/merge/resources/accounting/types/multipart_form_field_request.py @@ -30,7 +30,7 @@ class MultipartFormFieldRequest(UniversalBaseModel): The data for the form field. """ - encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field() + encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field(default=None) """ The encoding of the value of `data`. Defaults to `RAW` if not defined. @@ -39,12 +39,12 @@ class MultipartFormFieldRequest(UniversalBaseModel): - `GZIP_BASE64` - GZIP_BASE64 """ - file_name: typing.Optional[str] = pydantic.Field() + 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() + content_type: typing.Optional[str] = pydantic.Field(default=None) """ The MIME type of the file, if the field is for a file. """ diff --git a/src/merge/resources/accounting/types/paginated_account_details_and_actions_list.py b/src/merge/resources/accounting/types/paginated_account_details_and_actions_list.py index a9128c76..00ceeda5 100644 --- a/src/merge/resources/accounting/types/paginated_account_details_and_actions_list.py +++ b/src/merge/resources/accounting/types/paginated_account_details_and_actions_list.py @@ -8,9 +8,9 @@ class PaginatedAccountDetailsAndActionsList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AccountDetailsAndActions]] + 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 diff --git a/src/merge/resources/accounting/types/paginated_account_list.py b/src/merge/resources/accounting/types/paginated_account_list.py index b49c8fba..dcabf6cb 100644 --- a/src/merge/resources/accounting/types/paginated_account_list.py +++ b/src/merge/resources/accounting/types/paginated_account_list.py @@ -8,9 +8,9 @@ class PaginatedAccountList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Account]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Account]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_accounting_attachment_list.py b/src/merge/resources/accounting/types/paginated_accounting_attachment_list.py index f021b301..dae1ffea 100644 --- a/src/merge/resources/accounting/types/paginated_accounting_attachment_list.py +++ b/src/merge/resources/accounting/types/paginated_accounting_attachment_list.py @@ -8,9 +8,9 @@ class PaginatedAccountingAttachmentList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AccountingAttachment]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[AccountingAttachment]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_accounting_period_list.py b/src/merge/resources/accounting/types/paginated_accounting_period_list.py index 7bd057fe..33e16a9b 100644 --- a/src/merge/resources/accounting/types/paginated_accounting_period_list.py +++ b/src/merge/resources/accounting/types/paginated_accounting_period_list.py @@ -8,9 +8,9 @@ class PaginatedAccountingPeriodList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AccountingPeriod]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[AccountingPeriod]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_audit_log_event_list.py b/src/merge/resources/accounting/types/paginated_audit_log_event_list.py index a50b7c75..450de68c 100644 --- a/src/merge/resources/accounting/types/paginated_audit_log_event_list.py +++ b/src/merge/resources/accounting/types/paginated_audit_log_event_list.py @@ -8,9 +8,9 @@ class PaginatedAuditLogEventList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AuditLogEvent]] + 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 diff --git a/src/merge/resources/accounting/types/paginated_balance_sheet_list.py b/src/merge/resources/accounting/types/paginated_balance_sheet_list.py index 73be0c60..21e753e2 100644 --- a/src/merge/resources/accounting/types/paginated_balance_sheet_list.py +++ b/src/merge/resources/accounting/types/paginated_balance_sheet_list.py @@ -8,9 +8,9 @@ class PaginatedBalanceSheetList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[BalanceSheet]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[BalanceSheet]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_cash_flow_statement_list.py b/src/merge/resources/accounting/types/paginated_cash_flow_statement_list.py index e8429edf..8ba6e4ca 100644 --- a/src/merge/resources/accounting/types/paginated_cash_flow_statement_list.py +++ b/src/merge/resources/accounting/types/paginated_cash_flow_statement_list.py @@ -8,9 +8,9 @@ class PaginatedCashFlowStatementList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[CashFlowStatement]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[CashFlowStatement]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_company_info_list.py b/src/merge/resources/accounting/types/paginated_company_info_list.py index 85bd7981..bda9c3bf 100644 --- a/src/merge/resources/accounting/types/paginated_company_info_list.py +++ b/src/merge/resources/accounting/types/paginated_company_info_list.py @@ -8,9 +8,9 @@ class PaginatedCompanyInfoList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[CompanyInfo]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[CompanyInfo]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_contact_list.py b/src/merge/resources/accounting/types/paginated_contact_list.py index 07c47744..c711818a 100644 --- a/src/merge/resources/accounting/types/paginated_contact_list.py +++ b/src/merge/resources/accounting/types/paginated_contact_list.py @@ -8,9 +8,9 @@ class PaginatedContactList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Contact]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Contact]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_credit_note_list.py b/src/merge/resources/accounting/types/paginated_credit_note_list.py index 9a766a24..83c169f5 100644 --- a/src/merge/resources/accounting/types/paginated_credit_note_list.py +++ b/src/merge/resources/accounting/types/paginated_credit_note_list.py @@ -8,9 +8,9 @@ class PaginatedCreditNoteList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[CreditNote]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[CreditNote]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_expense_list.py b/src/merge/resources/accounting/types/paginated_expense_list.py index 79e692ea..fd713366 100644 --- a/src/merge/resources/accounting/types/paginated_expense_list.py +++ b/src/merge/resources/accounting/types/paginated_expense_list.py @@ -8,9 +8,9 @@ class PaginatedExpenseList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Expense]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Expense]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_income_statement_list.py b/src/merge/resources/accounting/types/paginated_income_statement_list.py index 4f8695b9..ab51e3fa 100644 --- a/src/merge/resources/accounting/types/paginated_income_statement_list.py +++ b/src/merge/resources/accounting/types/paginated_income_statement_list.py @@ -8,9 +8,9 @@ class PaginatedIncomeStatementList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[IncomeStatement]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[IncomeStatement]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_invoice_list.py b/src/merge/resources/accounting/types/paginated_invoice_list.py index 286cd31b..9ca92a46 100644 --- a/src/merge/resources/accounting/types/paginated_invoice_list.py +++ b/src/merge/resources/accounting/types/paginated_invoice_list.py @@ -8,9 +8,9 @@ class PaginatedInvoiceList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Invoice]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Invoice]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_issue_list.py b/src/merge/resources/accounting/types/paginated_issue_list.py index 12b866d9..758e6dc3 100644 --- a/src/merge/resources/accounting/types/paginated_issue_list.py +++ b/src/merge/resources/accounting/types/paginated_issue_list.py @@ -8,9 +8,9 @@ class PaginatedIssueList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Issue]] + 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 diff --git a/src/merge/resources/accounting/types/paginated_item_list.py b/src/merge/resources/accounting/types/paginated_item_list.py index 2569f862..2196b6bf 100644 --- a/src/merge/resources/accounting/types/paginated_item_list.py +++ b/src/merge/resources/accounting/types/paginated_item_list.py @@ -8,9 +8,9 @@ class PaginatedItemList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Item]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Item]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_journal_entry_list.py b/src/merge/resources/accounting/types/paginated_journal_entry_list.py index 3ec412e7..72f3bcaf 100644 --- a/src/merge/resources/accounting/types/paginated_journal_entry_list.py +++ b/src/merge/resources/accounting/types/paginated_journal_entry_list.py @@ -8,9 +8,9 @@ class PaginatedJournalEntryList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[JournalEntry]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[JournalEntry]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_payment_list.py b/src/merge/resources/accounting/types/paginated_payment_list.py index 75a06fd9..b64286f8 100644 --- a/src/merge/resources/accounting/types/paginated_payment_list.py +++ b/src/merge/resources/accounting/types/paginated_payment_list.py @@ -8,9 +8,9 @@ class PaginatedPaymentList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Payment]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Payment]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_purchase_order_list.py b/src/merge/resources/accounting/types/paginated_purchase_order_list.py index d93d0326..61b3bea7 100644 --- a/src/merge/resources/accounting/types/paginated_purchase_order_list.py +++ b/src/merge/resources/accounting/types/paginated_purchase_order_list.py @@ -8,9 +8,9 @@ class PaginatedPurchaseOrderList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[PurchaseOrder]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[PurchaseOrder]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_remote_field_class_list.py b/src/merge/resources/accounting/types/paginated_remote_field_class_list.py index 1f51ab63..65c907cc 100644 --- a/src/merge/resources/accounting/types/paginated_remote_field_class_list.py +++ b/src/merge/resources/accounting/types/paginated_remote_field_class_list.py @@ -8,9 +8,9 @@ class PaginatedRemoteFieldClassList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[RemoteFieldClass]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[RemoteFieldClass]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_sync_status_list.py b/src/merge/resources/accounting/types/paginated_sync_status_list.py index f59f2c9a..f4f09ed1 100644 --- a/src/merge/resources/accounting/types/paginated_sync_status_list.py +++ b/src/merge/resources/accounting/types/paginated_sync_status_list.py @@ -8,9 +8,9 @@ class PaginatedSyncStatusList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[SyncStatus]] + 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 diff --git a/src/merge/resources/accounting/types/paginated_tax_rate_list.py b/src/merge/resources/accounting/types/paginated_tax_rate_list.py index 11921af9..e08e1f56 100644 --- a/src/merge/resources/accounting/types/paginated_tax_rate_list.py +++ b/src/merge/resources/accounting/types/paginated_tax_rate_list.py @@ -8,9 +8,9 @@ class PaginatedTaxRateList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[TaxRate]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[TaxRate]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_tracking_category_list.py b/src/merge/resources/accounting/types/paginated_tracking_category_list.py index ab1cfdd2..11e6e5fe 100644 --- a/src/merge/resources/accounting/types/paginated_tracking_category_list.py +++ b/src/merge/resources/accounting/types/paginated_tracking_category_list.py @@ -8,9 +8,9 @@ class PaginatedTrackingCategoryList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[TrackingCategory]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[TrackingCategory]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_transaction_list.py b/src/merge/resources/accounting/types/paginated_transaction_list.py index 9ff70ef0..fd313a0f 100644 --- a/src/merge/resources/accounting/types/paginated_transaction_list.py +++ b/src/merge/resources/accounting/types/paginated_transaction_list.py @@ -8,9 +8,9 @@ class PaginatedTransactionList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Transaction]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Transaction]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/paginated_vendor_credit_list.py b/src/merge/resources/accounting/types/paginated_vendor_credit_list.py index 1861dc79..9b2617f7 100644 --- a/src/merge/resources/accounting/types/paginated_vendor_credit_list.py +++ b/src/merge/resources/accounting/types/paginated_vendor_credit_list.py @@ -8,9 +8,9 @@ class PaginatedVendorCreditList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[VendorCredit]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[VendorCredit]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/patched_payment_request.py b/src/merge/resources/accounting/types/patched_payment_request.py index a0867c79..ed491985 100644 --- a/src/merge/resources/accounting/types/patched_payment_request.py +++ b/src/merge/resources/accounting/types/patched_payment_request.py @@ -29,22 +29,22 @@ class PatchedPaymentRequest(UniversalBaseModel): Fetch from the `GET Payment` endpoint and view an invoice's payment. """ - transaction_date: typing.Optional[dt.datetime] = pydantic.Field() + transaction_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The payment's transaction date. """ - contact: typing.Optional[PatchedPaymentRequestContact] = pydantic.Field() + contact: typing.Optional[PatchedPaymentRequestContact] = pydantic.Field(default=None) """ The supplier, or customer involved in the payment. """ - account: typing.Optional[PatchedPaymentRequestAccount] = pydantic.Field() + account: typing.Optional[PatchedPaymentRequestAccount] = pydantic.Field(default=None) """ The supplier’s or customer’s account in which the payment is made. """ - currency: typing.Optional[PatchedPaymentRequestCurrency] = pydantic.Field() + currency: typing.Optional[PatchedPaymentRequestCurrency] = pydantic.Field(default=None) """ The payment's currency. @@ -356,22 +356,22 @@ class PatchedPaymentRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The payment's exchange rate. """ - company: typing.Optional[PatchedPaymentRequestCompany] = pydantic.Field() + company: typing.Optional[PatchedPaymentRequestCompany] = pydantic.Field(default=None) """ The company the payment belongs to. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The total amount of money being paid to the supplier, or customer, after taxes. """ - type: typing.Optional[PatchedPaymentRequestType] = pydantic.Field() + type: typing.Optional[PatchedPaymentRequestType] = pydantic.Field(default=None) """ The type of the invoice. @@ -379,20 +379,24 @@ class PatchedPaymentRequest(UniversalBaseModel): - `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE """ - tracking_categories: typing.Optional[typing.List[typing.Optional[PatchedPaymentRequestTrackingCategoriesItem]]] - accounting_period: typing.Optional[PatchedPaymentRequestAccountingPeriod] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[PatchedPaymentRequestTrackingCategoriesItem]]] = ( + None + ) + accounting_period: typing.Optional[PatchedPaymentRequestAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the Payment was generated in. """ - applied_to_lines: typing.Optional[typing.List[PatchedPaymentRequestAppliedToLinesItem]] = pydantic.Field() + applied_to_lines: typing.Optional[typing.List[PatchedPaymentRequestAppliedToLinesItem]] = pydantic.Field( + default=None + ) """ A list of β€œPayment Applied to Lines” objects. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/payment.py b/src/merge/resources/accounting/types/payment.py index 5881ec73..4df0a6c3 100644 --- a/src/merge/resources/accounting/types/payment.py +++ b/src/merge/resources/accounting/types/payment.py @@ -30,38 +30,38 @@ class Payment(UniversalBaseModel): Fetch from the `GET Payment` endpoint and view an invoice's payment. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - transaction_date: typing.Optional[dt.datetime] = pydantic.Field() + transaction_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The payment's transaction date. """ - contact: typing.Optional[PaymentContact] = pydantic.Field() + contact: typing.Optional[PaymentContact] = pydantic.Field(default=None) """ The supplier, or customer involved in the payment. """ - account: typing.Optional[PaymentAccount] = pydantic.Field() + account: typing.Optional[PaymentAccount] = pydantic.Field(default=None) """ The supplier’s or customer’s account in which the payment is made. """ - currency: typing.Optional[PaymentCurrency] = pydantic.Field() + currency: typing.Optional[PaymentCurrency] = pydantic.Field(default=None) """ The payment's currency. @@ -373,22 +373,22 @@ class Payment(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The payment's exchange rate. """ - company: typing.Optional[PaymentCompany] = pydantic.Field() + company: typing.Optional[PaymentCompany] = pydantic.Field(default=None) """ The company the payment belongs to. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The total amount of money being paid to the supplier, or customer, after taxes. """ - type: typing.Optional[PaymentType] = pydantic.Field() + type: typing.Optional[PaymentType] = pydantic.Field(default=None) """ The type of the invoice. @@ -396,30 +396,30 @@ class Payment(UniversalBaseModel): - `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE """ - tracking_categories: typing.Optional[typing.List[typing.Optional[PaymentTrackingCategoriesItem]]] - accounting_period: typing.Optional[PaymentAccountingPeriod] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[PaymentTrackingCategoriesItem]]] = None + accounting_period: typing.Optional[PaymentAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the Payment was generated in. """ - applied_to_lines: typing.Optional[typing.List[PaymentAppliedToLinesItem]] = pydantic.Field() + applied_to_lines: typing.Optional[typing.List[PaymentAppliedToLinesItem]] = pydantic.Field(default=None) """ A list of β€œPayment Applied to Lines” objects. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's payment entry was updated. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/payment_line_item.py b/src/merge/resources/accounting/types/payment_line_item.py index 33ecd3b6..91653942 100644 --- a/src/merge/resources/accounting/types/payment_line_item.py +++ b/src/merge/resources/accounting/types/payment_line_item.py @@ -20,38 +20,38 @@ class PaymentLineItem(UniversalBaseModel): `Payment` will have a field called `applied-to-lines` which will be an array of `PaymentLineItemInternalMappingSerializer` objects that can either be a `Invoice`, `CreditNote`, or `JournalEntry`. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - applied_amount: typing.Optional[str] = pydantic.Field() + applied_amount: typing.Optional[str] = pydantic.Field(default=None) """ The amount being applied to the transaction. """ - applied_date: typing.Optional[dt.datetime] = pydantic.Field() + applied_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The date the payment portion is applied. """ - related_object_id: typing.Optional[str] = pydantic.Field() + related_object_id: typing.Optional[str] = pydantic.Field(default=None) """ The Merge ID of the transaction the payment portion is being applied to. """ - related_object_type: typing.Optional[str] = pydantic.Field() + related_object_type: typing.Optional[str] = pydantic.Field(default=None) """ The type of transaction the payment portion is being applied to. Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE. """ diff --git a/src/merge/resources/accounting/types/payment_line_item_request.py b/src/merge/resources/accounting/types/payment_line_item_request.py index af308cfd..52b6814d 100644 --- a/src/merge/resources/accounting/types/payment_line_item_request.py +++ b/src/merge/resources/accounting/types/payment_line_item_request.py @@ -21,34 +21,34 @@ class PaymentLineItemRequest(UniversalBaseModel): `Payment` will have a field called `applied-to-lines` which will be an array of `PaymentLineItemInternalMappingSerializer` objects that can either be a `Invoice`, `CreditNote`, or `JournalEntry`. """ - remote_id: typing.Optional[str] = pydantic.Field() + remote_id: typing.Optional[str] = pydantic.Field(default=None) """ The third-party API ID of the matching object. """ - applied_amount: typing.Optional[str] = pydantic.Field() + applied_amount: typing.Optional[str] = pydantic.Field(default=None) """ The amount being applied to the transaction. """ - applied_date: typing.Optional[dt.datetime] = pydantic.Field() + applied_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The date the payment portion is applied. """ - related_object_id: typing.Optional[str] = pydantic.Field() + related_object_id: typing.Optional[str] = pydantic.Field(default=None) """ The Merge ID of the transaction the payment portion is being applied to. """ - related_object_type: typing.Optional[str] = pydantic.Field() + related_object_type: typing.Optional[str] = pydantic.Field(default=None) """ The type of transaction the payment portion is being applied to. Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/payment_request.py b/src/merge/resources/accounting/types/payment_request.py index 899844db..59ef323c 100644 --- a/src/merge/resources/accounting/types/payment_request.py +++ b/src/merge/resources/accounting/types/payment_request.py @@ -29,22 +29,22 @@ class PaymentRequest(UniversalBaseModel): Fetch from the `GET Payment` endpoint and view an invoice's payment. """ - transaction_date: typing.Optional[dt.datetime] = pydantic.Field() + transaction_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The payment's transaction date. """ - contact: typing.Optional[PaymentRequestContact] = pydantic.Field() + contact: typing.Optional[PaymentRequestContact] = pydantic.Field(default=None) """ The supplier, or customer involved in the payment. """ - account: typing.Optional[PaymentRequestAccount] = pydantic.Field() + account: typing.Optional[PaymentRequestAccount] = pydantic.Field(default=None) """ The supplier’s or customer’s account in which the payment is made. """ - currency: typing.Optional[PaymentRequestCurrency] = pydantic.Field() + currency: typing.Optional[PaymentRequestCurrency] = pydantic.Field(default=None) """ The payment's currency. @@ -356,22 +356,22 @@ class PaymentRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The payment's exchange rate. """ - company: typing.Optional[PaymentRequestCompany] = pydantic.Field() + company: typing.Optional[PaymentRequestCompany] = pydantic.Field(default=None) """ The company the payment belongs to. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The total amount of money being paid to the supplier, or customer, after taxes. """ - type: typing.Optional[PaymentRequestType] = pydantic.Field() + type: typing.Optional[PaymentRequestType] = pydantic.Field(default=None) """ The type of the invoice. @@ -379,20 +379,20 @@ class PaymentRequest(UniversalBaseModel): - `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE """ - tracking_categories: typing.Optional[typing.List[typing.Optional[PaymentRequestTrackingCategoriesItem]]] - accounting_period: typing.Optional[PaymentRequestAccountingPeriod] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[PaymentRequestTrackingCategoriesItem]]] = None + accounting_period: typing.Optional[PaymentRequestAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the Payment was generated in. """ - applied_to_lines: typing.Optional[typing.List[PaymentRequestAppliedToLinesItem]] = pydantic.Field() + applied_to_lines: typing.Optional[typing.List[PaymentRequestAppliedToLinesItem]] = pydantic.Field(default=None) """ A list of β€œPayment Applied to Lines” objects. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/payment_response.py b/src/merge/resources/accounting/types/payment_response.py index 9eab5dc5..64b01d35 100644 --- a/src/merge/resources/accounting/types/payment_response.py +++ b/src/merge/resources/accounting/types/payment_response.py @@ -14,7 +14,7 @@ class PaymentResponse(UniversalBaseModel): model: Payment warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/accounting/types/purchase_order.py b/src/merge/resources/accounting/types/purchase_order.py index 644a7af7..576593be 100644 --- a/src/merge/resources/accounting/types/purchase_order.py +++ b/src/merge/resources/accounting/types/purchase_order.py @@ -32,23 +32,23 @@ class PurchaseOrder(UniversalBaseModel): Fetch from the `LIST PurchaseOrders` endpoint and view a company's purchase orders. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - status: typing.Optional[PurchaseOrderStatus] = pydantic.Field() + status: typing.Optional[PurchaseOrderStatus] = pydantic.Field(default=None) """ The purchase order's status. @@ -59,52 +59,52 @@ class PurchaseOrder(UniversalBaseModel): - `DELETED` - DELETED """ - issue_date: typing.Optional[dt.datetime] = pydantic.Field() + issue_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The purchase order's issue date. """ - purchase_order_number: typing.Optional[str] = pydantic.Field() + purchase_order_number: typing.Optional[str] = pydantic.Field(default=None) """ The human-readable number of the purchase order. """ - delivery_date: typing.Optional[dt.datetime] = pydantic.Field() + delivery_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The purchase order's delivery date. """ - delivery_address: typing.Optional[PurchaseOrderDeliveryAddress] = pydantic.Field() + delivery_address: typing.Optional[PurchaseOrderDeliveryAddress] = pydantic.Field(default=None) """ The purchase order's delivery address. """ - customer: typing.Optional[str] = pydantic.Field() + customer: typing.Optional[str] = pydantic.Field(default=None) """ The contact making the purchase order. """ - vendor: typing.Optional[PurchaseOrderVendor] = pydantic.Field() + vendor: typing.Optional[PurchaseOrderVendor] = pydantic.Field(default=None) """ The party fulfilling the purchase order. """ - memo: typing.Optional[str] = pydantic.Field() + memo: typing.Optional[str] = pydantic.Field(default=None) """ A memo attached to the purchase order. """ - company: typing.Optional[PurchaseOrderCompany] = pydantic.Field() + company: typing.Optional[PurchaseOrderCompany] = pydantic.Field(default=None) """ The company the purchase order belongs to. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The purchase order's total amount. """ - currency: typing.Optional[PurchaseOrderCurrency] = pydantic.Field() + currency: typing.Optional[PurchaseOrderCurrency] = pydantic.Field(default=None) """ The purchase order's currency. @@ -416,41 +416,41 @@ class PurchaseOrder(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order's exchange rate. """ - line_items: typing.Optional[typing.List[PurchaseOrderLineItem]] - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + line_items: typing.Optional[typing.List[PurchaseOrderLineItem]] = None + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[PurchaseOrderTrackingCategoriesItem]]] - accounting_period: typing.Optional[PurchaseOrderAccountingPeriod] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[PurchaseOrderTrackingCategoriesItem]]] = None + accounting_period: typing.Optional[PurchaseOrderAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the PurchaseOrder was generated in. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's purchase order note was created. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's purchase order note was updated. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/purchase_order_line_item.py b/src/merge/resources/accounting/types/purchase_order_line_item.py index 1ecedbf7..2933b6b7 100644 --- a/src/merge/resources/accounting/types/purchase_order_line_item.py +++ b/src/merge/resources/accounting/types/purchase_order_line_item.py @@ -23,64 +23,64 @@ class PurchaseOrderLineItem(UniversalBaseModel): Fetch from the `GET PurchaseOrder` endpoint and view a company's purchase orders. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ A description of the good being purchased. """ - unit_price: typing.Optional[float] = pydantic.Field() + unit_price: typing.Optional[float] = pydantic.Field(default=None) """ The line item's unit price. """ - quantity: typing.Optional[float] = pydantic.Field() + quantity: typing.Optional[float] = pydantic.Field(default=None) """ The line item's quantity. """ - item: typing.Optional[PurchaseOrderLineItemItem] - account: typing.Optional[str] = pydantic.Field() + item: typing.Optional[PurchaseOrderLineItemItem] = None + account: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order line item's account. """ - tracking_category: typing.Optional[str] = pydantic.Field() + tracking_category: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order line item's associated tracking category. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The purchase order line item's associated tracking categories. """ - tax_amount: typing.Optional[str] = pydantic.Field() + tax_amount: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order line item's tax amount. """ - total_line_amount: typing.Optional[str] = pydantic.Field() + total_line_amount: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order line item's total amount. """ - currency: typing.Optional[PurchaseOrderLineItemCurrency] = pydantic.Field() + currency: typing.Optional[PurchaseOrderLineItemCurrency] = pydantic.Field(default=None) """ The purchase order line item's currency. @@ -392,27 +392,27 @@ class PurchaseOrderLineItem(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - tax_rate: typing.Optional[str] = pydantic.Field() + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order line item's exchange rate. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the purchase order line item belongs to. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ - remote_fields: typing.Optional[typing.List[RemoteField]] + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/purchase_order_line_item_request.py b/src/merge/resources/accounting/types/purchase_order_line_item_request.py index b9e4fb5f..05e3d6e5 100644 --- a/src/merge/resources/accounting/types/purchase_order_line_item_request.py +++ b/src/merge/resources/accounting/types/purchase_order_line_item_request.py @@ -22,53 +22,53 @@ class PurchaseOrderLineItemRequest(UniversalBaseModel): Fetch from the `GET PurchaseOrder` endpoint and view a company's purchase orders. """ - remote_id: typing.Optional[str] = pydantic.Field() + remote_id: typing.Optional[str] = pydantic.Field(default=None) """ The third-party API ID of the matching object. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ A description of the good being purchased. """ - unit_price: typing.Optional[float] = pydantic.Field() + unit_price: typing.Optional[float] = pydantic.Field(default=None) """ The line item's unit price. """ - quantity: typing.Optional[float] = pydantic.Field() + quantity: typing.Optional[float] = pydantic.Field(default=None) """ The line item's quantity. """ - item: typing.Optional[PurchaseOrderLineItemRequestItem] - account: typing.Optional[str] = pydantic.Field() + item: typing.Optional[PurchaseOrderLineItemRequestItem] = None + account: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order line item's account. """ - tracking_category: typing.Optional[str] = pydantic.Field() + tracking_category: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order line item's associated tracking category. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The purchase order line item's associated tracking categories. """ - tax_amount: typing.Optional[str] = pydantic.Field() + tax_amount: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order line item's tax amount. """ - total_line_amount: typing.Optional[str] = pydantic.Field() + total_line_amount: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order line item's total amount. """ - currency: typing.Optional[PurchaseOrderLineItemRequestCurrency] = pydantic.Field() + currency: typing.Optional[PurchaseOrderLineItemRequestCurrency] = pydantic.Field(default=None) """ The purchase order line item's currency. @@ -380,24 +380,24 @@ class PurchaseOrderLineItemRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - tax_rate: typing.Optional[str] = pydantic.Field() + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order line item's exchange rate. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the purchase order line item belongs to. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/purchase_order_request.py b/src/merge/resources/accounting/types/purchase_order_request.py index ea000418..a73d7e65 100644 --- a/src/merge/resources/accounting/types/purchase_order_request.py +++ b/src/merge/resources/accounting/types/purchase_order_request.py @@ -28,7 +28,7 @@ class PurchaseOrderRequest(UniversalBaseModel): Fetch from the `LIST PurchaseOrders` endpoint and view a company's purchase orders. """ - status: typing.Optional[PurchaseOrderRequestStatus] = pydantic.Field() + status: typing.Optional[PurchaseOrderRequestStatus] = pydantic.Field(default=None) """ The purchase order's status. @@ -39,47 +39,47 @@ class PurchaseOrderRequest(UniversalBaseModel): - `DELETED` - DELETED """ - issue_date: typing.Optional[dt.datetime] = pydantic.Field() + issue_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The purchase order's issue date. """ - delivery_date: typing.Optional[dt.datetime] = pydantic.Field() + delivery_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The purchase order's delivery date. """ - delivery_address: typing.Optional[PurchaseOrderRequestDeliveryAddress] = pydantic.Field() + delivery_address: typing.Optional[PurchaseOrderRequestDeliveryAddress] = pydantic.Field(default=None) """ The purchase order's delivery address. """ - customer: typing.Optional[str] = pydantic.Field() + customer: typing.Optional[str] = pydantic.Field(default=None) """ The contact making the purchase order. """ - vendor: typing.Optional[PurchaseOrderRequestVendor] = pydantic.Field() + vendor: typing.Optional[PurchaseOrderRequestVendor] = pydantic.Field(default=None) """ The party fulfilling the purchase order. """ - memo: typing.Optional[str] = pydantic.Field() + memo: typing.Optional[str] = pydantic.Field(default=None) """ A memo attached to the purchase order. """ - company: typing.Optional[PurchaseOrderRequestCompany] = pydantic.Field() + company: typing.Optional[PurchaseOrderRequestCompany] = pydantic.Field(default=None) """ The company the purchase order belongs to. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The purchase order's total amount. """ - currency: typing.Optional[PurchaseOrderRequestCurrency] = pydantic.Field() + currency: typing.Optional[PurchaseOrderRequestCurrency] = pydantic.Field(default=None) """ The purchase order's currency. @@ -391,21 +391,23 @@ class PurchaseOrderRequest(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The purchase order's exchange rate. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[PurchaseOrderRequestTrackingCategoriesItem]]] - line_items: typing.Optional[typing.List[PurchaseOrderLineItemRequest]] - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + tracking_categories: typing.Optional[typing.List[typing.Optional[PurchaseOrderRequestTrackingCategoriesItem]]] = ( + None + ) + line_items: typing.Optional[typing.List[PurchaseOrderLineItemRequest]] = None + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/purchase_order_response.py b/src/merge/resources/accounting/types/purchase_order_response.py index 113388ac..797f92d0 100644 --- a/src/merge/resources/accounting/types/purchase_order_response.py +++ b/src/merge/resources/accounting/types/purchase_order_response.py @@ -14,7 +14,7 @@ class PurchaseOrderResponse(UniversalBaseModel): model: PurchaseOrder warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/accounting/types/remote_data.py b/src/merge/resources/accounting/types/remote_data.py index 27c2a5f2..09a6b50b 100644 --- a/src/merge/resources/accounting/types/remote_data.py +++ b/src/merge/resources/accounting/types/remote_data.py @@ -8,7 +8,7 @@ class RemoteData(UniversalBaseModel): path: str - data: typing.Optional[typing.Optional[typing.Any]] + data: typing.Optional[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 diff --git a/src/merge/resources/accounting/types/remote_field.py b/src/merge/resources/accounting/types/remote_field.py index 0bd420e0..8b0331fa 100644 --- a/src/merge/resources/accounting/types/remote_field.py +++ b/src/merge/resources/accounting/types/remote_field.py @@ -9,7 +9,7 @@ class RemoteField(UniversalBaseModel): remote_field_class: RemoteFieldClass - value: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + value: 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 diff --git a/src/merge/resources/accounting/types/remote_field_api.py b/src/merge/resources/accounting/types/remote_field_api.py index 18f2421d..82495d75 100644 --- a/src/merge/resources/accounting/types/remote_field_api.py +++ b/src/merge/resources/accounting/types/remote_field_api.py @@ -13,9 +13,9 @@ class RemoteFieldApi(UniversalBaseModel): 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]]] - advanced_metadata: typing.Optional[AdvancedMetadata] - coverage: typing.Optional[RemoteFieldApiCoverage] + example_values: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + advanced_metadata: typing.Optional[AdvancedMetadata] = 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 diff --git a/src/merge/resources/accounting/types/remote_field_api_response.py b/src/merge/resources/accounting/types/remote_field_api_response.py index ab6c2594..8a24ba3d 100644 --- a/src/merge/resources/accounting/types/remote_field_api_response.py +++ b/src/merge/resources/accounting/types/remote_field_api_response.py @@ -8,29 +8,41 @@ class RemoteFieldApiResponse(UniversalBaseModel): - account: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Account") - accounting_attachment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="AccountingAttachment") - balance_sheet: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="BalanceSheet") - cash_flow_statement: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="CashFlowStatement") - company_info: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="CompanyInfo") - contact: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Contact") - income_statement: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="IncomeStatement") - credit_note: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="CreditNote") - item: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Item") - purchase_order: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="PurchaseOrder") - tracking_category: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="TrackingCategory") - journal_entry: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="JournalEntry") - tax_rate: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="TaxRate") - invoice: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Invoice") - payment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Payment") - expense: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Expense") - vendor_credit: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="VendorCredit") - transaction: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Transaction") - accounting_period: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="AccountingPeriod") + account: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Account", default=None) + accounting_attachment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="AccountingAttachment", default=None + ) + balance_sheet: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="BalanceSheet", default=None) + cash_flow_statement: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="CashFlowStatement", default=None + ) + company_info: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="CompanyInfo", default=None) + contact: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Contact", default=None) + income_statement: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="IncomeStatement", default=None + ) + credit_note: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="CreditNote", default=None) + item: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Item", default=None) + purchase_order: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="PurchaseOrder", default=None) + tracking_category: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="TrackingCategory", default=None + ) + journal_entry: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="JournalEntry", default=None) + tax_rate: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="TaxRate", default=None) + invoice: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Invoice", default=None) + payment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Payment", default=None) + expense: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Expense", default=None) + vendor_credit: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="VendorCredit", default=None) + transaction: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Transaction", default=None) + accounting_period: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="AccountingPeriod", default=None + ) general_ledger_transaction: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( - alias="GeneralLedgerTransaction" + alias="GeneralLedgerTransaction", default=None + ) + bank_feed_account: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="BankFeedAccount", default=None ) - bank_feed_account: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="BankFeedAccount") if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/remote_field_class.py b/src/merge/resources/accounting/types/remote_field_class.py index c58fe23f..ea88f502 100644 --- a/src/merge/resources/accounting/types/remote_field_class.py +++ b/src/merge/resources/accounting/types/remote_field_class.py @@ -10,16 +10,16 @@ class RemoteFieldClass(UniversalBaseModel): - id: typing.Optional[str] - display_name: typing.Optional[str] - remote_key_name: typing.Optional[str] - description: typing.Optional[str] - is_custom: typing.Optional[bool] - is_required: typing.Optional[bool] - field_type: typing.Optional[FieldTypeEnum] - field_format: typing.Optional[FieldFormatEnum] - field_choices: typing.Optional[typing.List[str]] - item_schema: typing.Optional[ItemSchema] + id: typing.Optional[str] = None + display_name: typing.Optional[str] = None + remote_key_name: typing.Optional[str] = None + description: typing.Optional[str] = None + is_custom: typing.Optional[bool] = None + is_required: typing.Optional[bool] = None + field_type: typing.Optional[FieldTypeEnum] = None + field_format: typing.Optional[FieldFormatEnum] = None + field_choices: typing.Optional[typing.List[str]] = None + item_schema: typing.Optional[ItemSchema] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/accounting/types/remote_field_request.py b/src/merge/resources/accounting/types/remote_field_request.py index bf5b7ce4..7e4d9f40 100644 --- a/src/merge/resources/accounting/types/remote_field_request.py +++ b/src/merge/resources/accounting/types/remote_field_request.py @@ -9,7 +9,7 @@ class RemoteFieldRequest(UniversalBaseModel): remote_field_class: RemoteFieldRequestRemoteFieldClass - value: typing.Optional[typing.Optional[typing.Any]] + value: typing.Optional[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 diff --git a/src/merge/resources/accounting/types/remote_response.py b/src/merge/resources/accounting/types/remote_response.py index e2d1620d..49988647 100644 --- a/src/merge/resources/accounting/types/remote_response.py +++ b/src/merge/resources/accounting/types/remote_response.py @@ -23,10 +23,10 @@ class RemoteResponse(UniversalBaseModel): method: str path: str status: int - response: typing.Optional[typing.Any] - response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - response_type: typing.Optional[ResponseTypeEnum] - headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + response: typing.Optional[typing.Any] = None + response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + response_type: typing.Optional[ResponseTypeEnum] = 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 diff --git a/src/merge/resources/accounting/types/report_item.py b/src/merge/resources/accounting/types/report_item.py index 32677d03..828f25d3 100644 --- a/src/merge/resources/accounting/types/report_item.py +++ b/src/merge/resources/accounting/types/report_item.py @@ -20,38 +20,38 @@ class ReportItem(UniversalBaseModel): Fetch from the `GET BalanceSheet` endpoint and view the balance sheet's report items. """ - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The report item's name. """ - value: typing.Optional[float] = pydantic.Field() + value: typing.Optional[float] = pydantic.Field(default=None) """ The report item's value. """ - sub_items: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] - company: typing.Optional[str] = pydantic.Field() + sub_items: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the report item belongs to. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/accounting/types/sync_status.py b/src/merge/resources/accounting/types/sync_status.py index f9a62229..c1a01c18 100644 --- a/src/merge/resources/accounting/types/sync_status.py +++ b/src/merge/resources/accounting/types/sync_status.py @@ -24,11 +24,11 @@ class SyncStatus(UniversalBaseModel): model_name: str model_id: str - last_sync_start: typing.Optional[dt.datetime] - next_sync_start: typing.Optional[dt.datetime] + last_sync_start: typing.Optional[dt.datetime] = None + next_sync_start: typing.Optional[dt.datetime] = None status: SyncStatusStatusEnum is_initial_sync: bool - selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] + 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 diff --git a/src/merge/resources/accounting/types/tax_component.py b/src/merge/resources/accounting/types/tax_component.py index ff4824c4..4b96b5a1 100644 --- a/src/merge/resources/accounting/types/tax_component.py +++ b/src/merge/resources/accounting/types/tax_component.py @@ -21,38 +21,38 @@ class TaxComponent(UniversalBaseModel): Fetch from the `LIST TaxRates` endpoint and view tax components relevant to a tax rate. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate’s name. """ - rate: typing.Optional[str] = pydantic.Field() + rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax component’s rate. """ - is_compound: typing.Optional[bool] = pydantic.Field() + is_compound: typing.Optional[bool] = pydantic.Field(default=None) """ Returns True if the tax component is compound, False if not. """ - component_type: typing.Optional[TaxComponentComponentType] = pydantic.Field() + component_type: typing.Optional[TaxComponentComponentType] = pydantic.Field(default=None) """ Returns PURCHASE if the tax component corresponds to a purchase tax or SALES if the tax component corresponds to a sales tax. @@ -60,7 +60,7 @@ class TaxComponent(UniversalBaseModel): - `PURCHASE` - PURCHASE """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/accounting/types/tax_rate.py b/src/merge/resources/accounting/types/tax_rate.py index 71093e28..b4ad3427 100644 --- a/src/merge/resources/accounting/types/tax_rate.py +++ b/src/merge/resources/accounting/types/tax_rate.py @@ -24,43 +24,43 @@ class TaxRate(UniversalBaseModel): Fetch from the `LIST TaxRates` endpoint and view tax rates relevant to a company. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - company: typing.Optional[TaxRateCompany] = pydantic.Field() + company: typing.Optional[TaxRateCompany] = pydantic.Field(default=None) """ The subsidiary that the tax rate belongs to (in the case of multi-entity systems). """ - code: typing.Optional[str] = pydantic.Field() + code: typing.Optional[str] = pydantic.Field(default=None) """ The tax code associated with this tax rate or group of tax rates from the third-party platform. """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate’s name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate's description. """ - status: typing.Optional[TaxRateStatus] = pydantic.Field() + status: typing.Optional[TaxRateStatus] = pydantic.Field(default=None) """ The tax rate’s status - `ACTIVE` if an active tax rate, `ARCHIVED` if not active. @@ -68,33 +68,33 @@ class TaxRate(UniversalBaseModel): - `ARCHIVED` - ARCHIVED """ - country: typing.Optional[str] = pydantic.Field() + country: typing.Optional[str] = pydantic.Field(default=None) """ The country the tax rate is associated with. """ - total_tax_rate: typing.Optional[float] = pydantic.Field() + total_tax_rate: typing.Optional[float] = pydantic.Field(default=None) """ The tax’s total tax rate - sum of the tax components (not compounded). """ - effective_tax_rate: typing.Optional[float] = pydantic.Field() + effective_tax_rate: typing.Optional[float] = pydantic.Field(default=None) """ The tax rate’s effective tax rate - total amount of tax with compounding. """ - tax_components: typing.Optional[typing.List[TaxRateTaxComponentsItem]] = pydantic.Field() + tax_components: typing.Optional[typing.List[TaxRateTaxComponentsItem]] = pydantic.Field(default=None) """ The related tax components of the tax rate. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/tracking_category.py b/src/merge/resources/accounting/types/tracking_category.py index fbd1274b..6a081c18 100644 --- a/src/merge/resources/accounting/types/tracking_category.py +++ b/src/merge/resources/accounting/types/tracking_category.py @@ -24,28 +24,28 @@ class TrackingCategory(UniversalBaseModel): Fetch from the `GET TrackingCategory` endpoint and view a company's tracking category. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The tracking category's name. """ - status: typing.Optional[TrackingCategoryStatus] = pydantic.Field() + status: typing.Optional[TrackingCategoryStatus] = pydantic.Field(default=None) """ The tracking category's status. @@ -53,7 +53,7 @@ class TrackingCategory(UniversalBaseModel): - `ARCHIVED` - ARCHIVED """ - category_type: typing.Optional[TrackingCategoryCategoryType] = pydantic.Field() + category_type: typing.Optional[TrackingCategoryCategoryType] = pydantic.Field(default=None) """ The tracking category’s type. @@ -61,23 +61,23 @@ class TrackingCategory(UniversalBaseModel): - `DEPARTMENT` - DEPARTMENT """ - parent_category: typing.Optional[str] = pydantic.Field() + parent_category: typing.Optional[str] = pydantic.Field(default=None) """ ID of the parent tracking category. """ - company: typing.Optional[TrackingCategoryCompany] = pydantic.Field() + company: typing.Optional[TrackingCategoryCompany] = pydantic.Field(default=None) """ The company the tracking category belongs to. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/transaction.py b/src/merge/resources/accounting/types/transaction.py index a0a1dd51..a2057574 100644 --- a/src/merge/resources/accounting/types/transaction.py +++ b/src/merge/resources/accounting/types/transaction.py @@ -35,58 +35,58 @@ class Transaction(UniversalBaseModel): Fetch from the `GET Transaction` endpoint and view a company's transactions. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - transaction_type: typing.Optional[str] = pydantic.Field() + transaction_type: typing.Optional[str] = pydantic.Field(default=None) """ The type of transaction, which can by any transaction object not already included in Merge’s common model. """ - number: typing.Optional[str] = pydantic.Field() + number: typing.Optional[str] = pydantic.Field(default=None) """ The transaction's number used for identifying purposes. """ - transaction_date: typing.Optional[dt.datetime] = pydantic.Field() + transaction_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The date upon which the transaction occurred. """ - account: typing.Optional[TransactionAccount] = pydantic.Field() + account: typing.Optional[TransactionAccount] = pydantic.Field(default=None) """ The transaction's account. """ - contact: typing.Optional[TransactionContact] = pydantic.Field() + contact: typing.Optional[TransactionContact] = pydantic.Field(default=None) """ The contact to whom the transaction relates to. """ - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - total_amount: typing.Optional[str] = pydantic.Field() + total_amount: typing.Optional[str] = pydantic.Field(default=None) """ The total amount being paid after taxes. """ - currency: typing.Optional[TransactionCurrency] = pydantic.Field() + currency: typing.Optional[TransactionCurrency] = pydantic.Field(default=None) """ The transaction's currency. @@ -398,30 +398,30 @@ class Transaction(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The transaction's exchange rate. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the transaction belongs to. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[TransactionTrackingCategoriesItem]]] - line_items: typing.Optional[typing.List[TransactionLineItem]] - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[TransactionTrackingCategoriesItem]]] = None + line_items: typing.Optional[typing.List[TransactionLineItem]] = 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/). """ - accounting_period: typing.Optional[TransactionAccountingPeriod] = pydantic.Field() + accounting_period: typing.Optional[TransactionAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the Transaction was generated in. """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/transaction_line_item.py b/src/merge/resources/accounting/types/transaction_line_item.py index a0833561..ed0ef93b 100644 --- a/src/merge/resources/accounting/types/transaction_line_item.py +++ b/src/merge/resources/accounting/types/transaction_line_item.py @@ -22,64 +22,64 @@ class TransactionLineItem(UniversalBaseModel): Fetch from the `GET TransactionLineItem` endpoint and view the transaction's line items. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - memo: typing.Optional[str] = pydantic.Field() + memo: typing.Optional[str] = pydantic.Field(default=None) """ An internal note used by the business to clarify purpose of the transaction. """ - unit_price: typing.Optional[str] = pydantic.Field() + unit_price: typing.Optional[str] = pydantic.Field(default=None) """ The line item's unit price. """ - quantity: typing.Optional[str] = pydantic.Field() + quantity: typing.Optional[str] = pydantic.Field(default=None) """ The line item's quantity. """ - item: typing.Optional[TransactionLineItemItem] - account: typing.Optional[str] = pydantic.Field() + item: typing.Optional[TransactionLineItemItem] = None + account: typing.Optional[str] = pydantic.Field(default=None) """ The line item's account. """ - tracking_category: typing.Optional[str] = pydantic.Field() + tracking_category: typing.Optional[str] = pydantic.Field(default=None) """ The line's associated tracking category. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The transaction line item's associated tracking categories. """ - total_line_amount: typing.Optional[str] = pydantic.Field() + total_line_amount: typing.Optional[str] = pydantic.Field(default=None) """ The line item's total. """ - tax_rate: typing.Optional[str] = pydantic.Field() + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - currency: typing.Optional[TransactionLineItemCurrency] = pydantic.Field() + currency: typing.Optional[TransactionLineItemCurrency] = pydantic.Field(default=None) """ The line item's currency. @@ -391,17 +391,17 @@ class TransactionLineItem(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The line item's exchange rate. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the line belongs to. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/accounting/types/vendor_credit.py b/src/merge/resources/accounting/types/vendor_credit.py index b630ba79..1135beaa 100644 --- a/src/merge/resources/accounting/types/vendor_credit.py +++ b/src/merge/resources/accounting/types/vendor_credit.py @@ -27,43 +27,43 @@ class VendorCredit(UniversalBaseModel): Fetch from the `GET VendorCredit` endpoint and view a company's vendor credits. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - number: typing.Optional[str] = pydantic.Field() + number: typing.Optional[str] = pydantic.Field(default=None) """ The vendor credit's number. """ - transaction_date: typing.Optional[dt.datetime] = pydantic.Field() + transaction_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The vendor credit's transaction date. """ - vendor: typing.Optional[VendorCreditVendor] = pydantic.Field() + vendor: typing.Optional[VendorCreditVendor] = pydantic.Field(default=None) """ The vendor that owes the gift or refund. """ - total_amount: typing.Optional[float] = pydantic.Field() + total_amount: typing.Optional[float] = pydantic.Field(default=None) """ The vendor credit's total amount. """ - currency: typing.Optional[VendorCreditCurrency] = pydantic.Field() + currency: typing.Optional[VendorCreditCurrency] = pydantic.Field(default=None) """ The vendor credit's currency. @@ -375,35 +375,35 @@ class VendorCredit(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The vendor credit's exchange rate. """ - inclusive_of_tax: typing.Optional[bool] = pydantic.Field() + inclusive_of_tax: typing.Optional[bool] = pydantic.Field(default=None) """ If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive. """ - company: typing.Optional[VendorCreditCompany] = pydantic.Field() + company: typing.Optional[VendorCreditCompany] = pydantic.Field(default=None) """ The company the vendor credit belongs to. """ - lines: typing.Optional[typing.List[VendorCreditLine]] - tracking_categories: typing.Optional[typing.List[typing.Optional[VendorCreditTrackingCategoriesItem]]] - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + lines: typing.Optional[typing.List[VendorCreditLine]] = None + tracking_categories: typing.Optional[typing.List[typing.Optional[VendorCreditTrackingCategoriesItem]]] = 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/). """ - accounting_period: typing.Optional[VendorCreditAccountingPeriod] = pydantic.Field() + accounting_period: typing.Optional[VendorCreditAccountingPeriod] = pydantic.Field(default=None) """ The accounting period that the VendorCredit was generated in. """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/accounting/types/vendor_credit_line.py b/src/merge/resources/accounting/types/vendor_credit_line.py index 86b5be9f..53a1a8cc 100644 --- a/src/merge/resources/accounting/types/vendor_credit_line.py +++ b/src/merge/resources/accounting/types/vendor_credit_line.py @@ -21,63 +21,63 @@ class VendorCreditLine(UniversalBaseModel): Fetch from the `GET VendorCredit` endpoint and view the vendor credit's line items. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - net_amount: typing.Optional[float] = pydantic.Field() + net_amount: typing.Optional[float] = pydantic.Field(default=None) """ The full value of the credit. """ - tracking_category: typing.Optional[str] = pydantic.Field() + tracking_category: typing.Optional[str] = pydantic.Field(default=None) """ The line's associated tracking category. """ - tracking_categories: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + tracking_categories: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The vendor credit line item's associated tracking categories. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The line's description. """ - account: typing.Optional[VendorCreditLineAccount] = pydantic.Field() + account: typing.Optional[VendorCreditLineAccount] = pydantic.Field(default=None) """ The line's account. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The company the line belongs to. """ - tax_rate: typing.Optional[str] = pydantic.Field() + tax_rate: typing.Optional[str] = pydantic.Field(default=None) """ The tax rate that applies to this line item. """ - exchange_rate: typing.Optional[str] = pydantic.Field() + exchange_rate: typing.Optional[str] = pydantic.Field(default=None) """ The vendor credit line item's exchange rate. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/accounting/types/warning_validation_problem.py b/src/merge/resources/accounting/types/warning_validation_problem.py index d508bb6d..140199ca 100644 --- a/src/merge/resources/accounting/types/warning_validation_problem.py +++ b/src/merge/resources/accounting/types/warning_validation_problem.py @@ -8,7 +8,7 @@ class WarningValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/accounting/types/webhook_receiver.py b/src/merge/resources/accounting/types/webhook_receiver.py index e8cd17aa..ac8573be 100644 --- a/src/merge/resources/accounting/types/webhook_receiver.py +++ b/src/merge/resources/accounting/types/webhook_receiver.py @@ -9,7 +9,7 @@ class WebhookReceiver(UniversalBaseModel): event: str is_active: bool - key: typing.Optional[str] + 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 diff --git a/src/merge/resources/ats/types/account_details.py b/src/merge/resources/ats/types/account_details.py index dc91a6f3..aaf3c5e4 100644 --- a/src/merge/resources/ats/types/account_details.py +++ b/src/merge/resources/ats/types/account_details.py @@ -9,22 +9,22 @@ class AccountDetails(UniversalBaseModel): - id: typing.Optional[str] - integration: typing.Optional[str] - integration_slug: typing.Optional[str] - category: typing.Optional[CategoryEnum] - end_user_origin_id: typing.Optional[str] - end_user_organization_name: typing.Optional[str] - end_user_email_address: typing.Optional[str] - status: typing.Optional[str] - webhook_listener_url: typing.Optional[str] - is_duplicate: typing.Optional[bool] = pydantic.Field() + id: typing.Optional[str] = None + integration: typing.Optional[str] = None + integration_slug: typing.Optional[str] = None + category: typing.Optional[CategoryEnum] = None + end_user_origin_id: typing.Optional[str] = None + end_user_organization_name: typing.Optional[str] = None + end_user_email_address: typing.Optional[str] = None + status: typing.Optional[str] = None + webhook_listener_url: typing.Optional[str] = None + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - account_type: typing.Optional[str] - completed_at: typing.Optional[dt.datetime] = pydantic.Field() + account_type: typing.Optional[str] = None + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which account completes the linking flow. """ diff --git a/src/merge/resources/ats/types/account_details_and_actions.py b/src/merge/resources/ats/types/account_details_and_actions.py index 30e78b61..4c96905f 100644 --- a/src/merge/resources/ats/types/account_details_and_actions.py +++ b/src/merge/resources/ats/types/account_details_and_actions.py @@ -24,24 +24,24 @@ class AccountDetailsAndActions(UniversalBaseModel): """ id: str - category: typing.Optional[CategoryEnum] + category: typing.Optional[CategoryEnum] = None status: AccountDetailsAndActionsStatusEnum - status_detail: typing.Optional[str] - end_user_origin_id: typing.Optional[str] + status_detail: typing.Optional[str] = None + end_user_origin_id: typing.Optional[str] = None end_user_organization_name: str end_user_email_address: str - subdomain: typing.Optional[str] = pydantic.Field() + subdomain: typing.Optional[str] = pydantic.Field(default=None) """ The tenant or domain the customer has provided access to. """ webhook_listener_url: str - is_duplicate: typing.Optional[bool] = pydantic.Field() + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - integration: typing.Optional[AccountDetailsAndActionsIntegration] + integration: typing.Optional[AccountDetailsAndActionsIntegration] = None account_type: str completed_at: dt.datetime diff --git a/src/merge/resources/ats/types/account_details_and_actions_integration.py b/src/merge/resources/ats/types/account_details_and_actions_integration.py index 5779ac5b..8e47dbc4 100644 --- a/src/merge/resources/ats/types/account_details_and_actions_integration.py +++ b/src/merge/resources/ats/types/account_details_and_actions_integration.py @@ -11,12 +11,12 @@ class AccountDetailsAndActionsIntegration(UniversalBaseModel): name: str categories: typing.List[CategoriesEnum] - image: typing.Optional[str] - square_image: typing.Optional[str] + image: typing.Optional[str] = None + square_image: typing.Optional[str] = None color: str slug: str passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/ats/types/account_integration.py b/src/merge/resources/ats/types/account_integration.py index 2d18dedb..1dad1594 100644 --- a/src/merge/resources/ats/types/account_integration.py +++ b/src/merge/resources/ats/types/account_integration.py @@ -13,45 +13,45 @@ class AccountIntegration(UniversalBaseModel): Company name. """ - abbreviated_name: typing.Optional[str] = pydantic.Field() + abbreviated_name: typing.Optional[str] = pydantic.Field(default=None) """ Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).

Example: Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors) """ - categories: typing.Optional[typing.List[CategoriesEnum]] = pydantic.Field() + 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() + image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in rectangular shape. """ - square_image: typing.Optional[str] = pydantic.Field() + square_image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in square shape. """ - color: typing.Optional[str] = pydantic.Field() + 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] + slug: typing.Optional[str] = None api_endpoints_to_documentation_urls: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = ( - pydantic.Field() + 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() + 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() + 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. """ diff --git a/src/merge/resources/ats/types/activity.py b/src/merge/resources/ats/types/activity.py index 631b5395..7f653b6f 100644 --- a/src/merge/resources/ats/types/activity.py +++ b/src/merge/resources/ats/types/activity.py @@ -24,33 +24,33 @@ class Activity(UniversalBaseModel): Fetch from the `LIST Activities` endpoint and filter by `ID` to show all activities. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - user: typing.Optional[ActivityUser] = pydantic.Field() + user: typing.Optional[ActivityUser] = pydantic.Field(default=None) """ The user that performed the action. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's activity was created. """ - activity_type: typing.Optional[ActivityActivityType] = pydantic.Field() + activity_type: typing.Optional[ActivityActivityType] = pydantic.Field(default=None) """ The activity's type. @@ -59,17 +59,17 @@ class Activity(UniversalBaseModel): - `OTHER` - OTHER """ - subject: typing.Optional[str] = pydantic.Field() + subject: typing.Optional[str] = pydantic.Field(default=None) """ The activity's subject. """ - body: typing.Optional[str] = pydantic.Field() + body: typing.Optional[str] = pydantic.Field(default=None) """ The activity's body. """ - visibility: typing.Optional[ActivityVisibility] = pydantic.Field() + visibility: typing.Optional[ActivityVisibility] = pydantic.Field(default=None) """ The activity's visibility. @@ -78,14 +78,14 @@ class Activity(UniversalBaseModel): - `PRIVATE` - PRIVATE """ - candidate: typing.Optional[str] - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + candidate: 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/activity_request.py b/src/merge/resources/ats/types/activity_request.py index 12a644e0..9caad837 100644 --- a/src/merge/resources/ats/types/activity_request.py +++ b/src/merge/resources/ats/types/activity_request.py @@ -22,12 +22,12 @@ class ActivityRequest(UniversalBaseModel): Fetch from the `LIST Activities` endpoint and filter by `ID` to show all activities. """ - user: typing.Optional[ActivityRequestUser] = pydantic.Field() + user: typing.Optional[ActivityRequestUser] = pydantic.Field(default=None) """ The user that performed the action. """ - activity_type: typing.Optional[ActivityRequestActivityType] = pydantic.Field() + activity_type: typing.Optional[ActivityRequestActivityType] = pydantic.Field(default=None) """ The activity's type. @@ -36,17 +36,17 @@ class ActivityRequest(UniversalBaseModel): - `OTHER` - OTHER """ - subject: typing.Optional[str] = pydantic.Field() + subject: typing.Optional[str] = pydantic.Field(default=None) """ The activity's subject. """ - body: typing.Optional[str] = pydantic.Field() + body: typing.Optional[str] = pydantic.Field(default=None) """ The activity's body. """ - visibility: typing.Optional[ActivityRequestVisibility] = pydantic.Field() + visibility: typing.Optional[ActivityRequestVisibility] = pydantic.Field(default=None) """ The activity's visibility. @@ -55,9 +55,9 @@ class ActivityRequest(UniversalBaseModel): - `PRIVATE` - PRIVATE """ - candidate: typing.Optional[str] - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + candidate: typing.Optional[str] = None + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ats/types/activity_response.py b/src/merge/resources/ats/types/activity_response.py index 29d5951c..c4be2646 100644 --- a/src/merge/resources/ats/types/activity_response.py +++ b/src/merge/resources/ats/types/activity_response.py @@ -14,7 +14,7 @@ class ActivityResponse(UniversalBaseModel): model: Activity warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ats/types/advanced_metadata.py b/src/merge/resources/ats/types/advanced_metadata.py index 6287a842..e570d69f 100644 --- a/src/merge/resources/ats/types/advanced_metadata.py +++ b/src/merge/resources/ats/types/advanced_metadata.py @@ -8,11 +8,11 @@ class AdvancedMetadata(UniversalBaseModel): id: str - display_name: typing.Optional[str] - description: typing.Optional[str] - is_required: typing.Optional[bool] - is_custom: typing.Optional[bool] - field_choices: typing.Optional[typing.List[typing.Optional[typing.Any]]] + 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 diff --git a/src/merge/resources/ats/types/application.py b/src/merge/resources/ats/types/application.py index 4be338e0..3f9703c3 100644 --- a/src/merge/resources/ats/types/application.py +++ b/src/merge/resources/ats/types/application.py @@ -28,71 +28,71 @@ class Application(UniversalBaseModel): Fetch from the `LIST Applications` endpoint and filter by `ID` to show all applications. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - candidate: typing.Optional["ApplicationCandidate"] = pydantic.Field() + candidate: typing.Optional["ApplicationCandidate"] = pydantic.Field(default=None) """ The candidate applying. """ - job: typing.Optional[ApplicationJob] = pydantic.Field() + job: typing.Optional[ApplicationJob] = pydantic.Field(default=None) """ The job being applied for. """ - applied_at: typing.Optional[dt.datetime] = pydantic.Field() + applied_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the application was submitted. """ - rejected_at: typing.Optional[dt.datetime] = pydantic.Field() + rejected_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the application was rejected. """ - offers: typing.Optional[typing.List[typing.Optional["ApplicationOffersItem"]]] - source: typing.Optional[str] = pydantic.Field() + offers: typing.Optional[typing.List[typing.Optional["ApplicationOffersItem"]]] = None + source: typing.Optional[str] = pydantic.Field(default=None) """ The application's source. """ - credited_to: typing.Optional[ApplicationCreditedTo] = pydantic.Field() + credited_to: typing.Optional[ApplicationCreditedTo] = pydantic.Field(default=None) """ The user credited for this application. """ - screening_question_answers: typing.Optional[typing.List[ApplicationScreeningQuestionAnswersItem]] - current_stage: typing.Optional[ApplicationCurrentStage] = pydantic.Field() + screening_question_answers: typing.Optional[typing.List[ApplicationScreeningQuestionAnswersItem]] = None + current_stage: typing.Optional[ApplicationCurrentStage] = pydantic.Field(default=None) """ The application's current stage. """ - reject_reason: typing.Optional[ApplicationRejectReason] = pydantic.Field() + reject_reason: typing.Optional[ApplicationRejectReason] = pydantic.Field(default=None) """ The application's reason for rejection. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/application_request.py b/src/merge/resources/ats/types/application_request.py index e9b8a39a..1f131263 100644 --- a/src/merge/resources/ats/types/application_request.py +++ b/src/merge/resources/ats/types/application_request.py @@ -32,51 +32,51 @@ class ApplicationRequest(UniversalBaseModel): Fetch from the `LIST Applications` endpoint and filter by `ID` to show all applications. """ - candidate: typing.Optional[ApplicationRequestCandidate] = pydantic.Field() + candidate: typing.Optional[ApplicationRequestCandidate] = pydantic.Field(default=None) """ The candidate applying. """ - job: typing.Optional[ApplicationRequestJob] = pydantic.Field() + job: typing.Optional[ApplicationRequestJob] = pydantic.Field(default=None) """ The job being applied for. """ - applied_at: typing.Optional[dt.datetime] = pydantic.Field() + applied_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the application was submitted. """ - rejected_at: typing.Optional[dt.datetime] = pydantic.Field() + rejected_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the application was rejected. """ - offers: typing.Optional[typing.List[typing.Optional[ApplicationRequestOffersItem]]] - source: typing.Optional[str] = pydantic.Field() + offers: typing.Optional[typing.List[typing.Optional[ApplicationRequestOffersItem]]] = None + source: typing.Optional[str] = pydantic.Field(default=None) """ The application's source. """ - credited_to: typing.Optional[ApplicationRequestCreditedTo] = pydantic.Field() + credited_to: typing.Optional[ApplicationRequestCreditedTo] = pydantic.Field(default=None) """ The user credited for this application. """ - screening_question_answers: typing.Optional[typing.List[ApplicationRequestScreeningQuestionAnswersItem]] - current_stage: typing.Optional[ApplicationRequestCurrentStage] = pydantic.Field() + screening_question_answers: typing.Optional[typing.List[ApplicationRequestScreeningQuestionAnswersItem]] = None + current_stage: typing.Optional[ApplicationRequestCurrentStage] = pydantic.Field(default=None) """ The application's current stage. """ - reject_reason: typing.Optional[ApplicationRequestRejectReason] = pydantic.Field() + reject_reason: typing.Optional[ApplicationRequestRejectReason] = pydantic.Field(default=None) """ The application's reason for rejection. """ - remote_template_id: typing.Optional[str] - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + remote_template_id: typing.Optional[str] = None + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ats/types/application_response.py b/src/merge/resources/ats/types/application_response.py index 7e8cb1fd..76c13619 100644 --- a/src/merge/resources/ats/types/application_response.py +++ b/src/merge/resources/ats/types/application_response.py @@ -18,7 +18,7 @@ class ApplicationResponse(UniversalBaseModel): model: Application warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ats/types/attachment.py b/src/merge/resources/ats/types/attachment.py index 1d52387e..04331f83 100644 --- a/src/merge/resources/ats/types/attachment.py +++ b/src/merge/resources/ats/types/attachment.py @@ -22,38 +22,38 @@ class Attachment(UniversalBaseModel): Fetch from the `LIST Attachments` endpoint and view attachments accessible by a company. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - file_name: typing.Optional[str] = pydantic.Field() + file_name: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's name. """ - file_url: typing.Optional[str] = pydantic.Field() + file_url: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's url. """ - candidate: typing.Optional[str] = pydantic.Field() + candidate: typing.Optional[str] = pydantic.Field(default=None) """ """ - attachment_type: typing.Optional[AttachmentAttachmentType] = pydantic.Field() + attachment_type: typing.Optional[AttachmentAttachmentType] = pydantic.Field(default=None) """ The attachment's type. @@ -63,13 +63,13 @@ class Attachment(UniversalBaseModel): - `OTHER` - OTHER """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/attachment_request.py b/src/merge/resources/ats/types/attachment_request.py index ecddf9f3..19de412c 100644 --- a/src/merge/resources/ats/types/attachment_request.py +++ b/src/merge/resources/ats/types/attachment_request.py @@ -20,22 +20,22 @@ class AttachmentRequest(UniversalBaseModel): Fetch from the `LIST Attachments` endpoint and view attachments accessible by a company. """ - file_name: typing.Optional[str] = pydantic.Field() + file_name: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's name. """ - file_url: typing.Optional[str] = pydantic.Field() + file_url: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's url. """ - candidate: typing.Optional[str] = pydantic.Field() + candidate: typing.Optional[str] = pydantic.Field(default=None) """ """ - attachment_type: typing.Optional[AttachmentRequestAttachmentType] = pydantic.Field() + attachment_type: typing.Optional[AttachmentRequestAttachmentType] = pydantic.Field(default=None) """ The attachment's type. @@ -45,8 +45,8 @@ class AttachmentRequest(UniversalBaseModel): - `OTHER` - OTHER """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ats/types/attachment_response.py b/src/merge/resources/ats/types/attachment_response.py index 608efe36..1c75d95c 100644 --- a/src/merge/resources/ats/types/attachment_response.py +++ b/src/merge/resources/ats/types/attachment_response.py @@ -14,7 +14,7 @@ class AttachmentResponse(UniversalBaseModel): model: Attachment warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ats/types/audit_log_event.py b/src/merge/resources/ats/types/audit_log_event.py index b57101fc..1c32586b 100644 --- a/src/merge/resources/ats/types/audit_log_event.py +++ b/src/merge/resources/ats/types/audit_log_event.py @@ -10,13 +10,13 @@ class AuditLogEvent(UniversalBaseModel): - id: typing.Optional[str] - user_name: typing.Optional[str] = pydantic.Field() + 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() + user_email: typing.Optional[str] = pydantic.Field(default=None) """ The User's email at the time of this Event occurring. """ @@ -79,7 +79,7 @@ class AuditLogEvent(UniversalBaseModel): """ event_description: str - created_at: typing.Optional[dt.datetime] + 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 diff --git a/src/merge/resources/ats/types/available_actions.py b/src/merge/resources/ats/types/available_actions.py index 5f164db6..57cee06d 100644 --- a/src/merge/resources/ats/types/available_actions.py +++ b/src/merge/resources/ats/types/available_actions.py @@ -23,7 +23,7 @@ class AvailableActions(UniversalBaseModel): integration: AccountIntegration passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/ats/types/candidate.py b/src/merge/resources/ats/types/candidate.py index 809fe6aa..6f679303 100644 --- a/src/merge/resources/ats/types/candidate.py +++ b/src/merge/resources/ats/types/candidate.py @@ -27,97 +27,99 @@ class Candidate(UniversalBaseModel): Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all candidates. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's last name. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's current company. """ - title: typing.Optional[str] = pydantic.Field() + title: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's current title. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's candidate was created. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's candidate was updated. """ - last_interaction_at: typing.Optional[dt.datetime] = pydantic.Field() + last_interaction_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the most recent interaction with the candidate occurred. """ - is_private: typing.Optional[bool] = pydantic.Field() + is_private: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the candidate is private. """ - can_email: typing.Optional[bool] = pydantic.Field() + can_email: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the candidate can be emailed. """ - locations: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + locations: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The candidate's locations. """ - phone_numbers: typing.Optional[typing.List[PhoneNumber]] - email_addresses: typing.Optional[typing.List[EmailAddress]] - urls: typing.Optional[typing.List[Url]] - tags: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + phone_numbers: typing.Optional[typing.List[PhoneNumber]] = None + email_addresses: typing.Optional[typing.List[EmailAddress]] = None + urls: typing.Optional[typing.List[Url]] = None + tags: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ Array of `Tag` names as strings. """ - applications: typing.Optional[typing.List[typing.Optional["CandidateApplicationsItem"]]] = pydantic.Field() + applications: typing.Optional[typing.List[typing.Optional["CandidateApplicationsItem"]]] = pydantic.Field( + default=None + ) """ Array of `Application` object IDs. """ - attachments: typing.Optional[typing.List[typing.Optional[CandidateAttachmentsItem]]] = pydantic.Field() + attachments: typing.Optional[typing.List[typing.Optional[CandidateAttachmentsItem]]] = pydantic.Field(default=None) """ Array of `Attachment` object IDs. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/candidate_request.py b/src/merge/resources/ats/types/candidate_request.py index 597627ef..3474e9a3 100644 --- a/src/merge/resources/ats/types/candidate_request.py +++ b/src/merge/resources/ats/types/candidate_request.py @@ -30,67 +30,71 @@ class CandidateRequest(UniversalBaseModel): Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all candidates. """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's last name. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's current company. """ - title: typing.Optional[str] = pydantic.Field() + title: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's current title. """ - last_interaction_at: typing.Optional[dt.datetime] = pydantic.Field() + last_interaction_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the most recent interaction with the candidate occurred. """ - is_private: typing.Optional[bool] = pydantic.Field() + is_private: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the candidate is private. """ - can_email: typing.Optional[bool] = pydantic.Field() + can_email: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the candidate can be emailed. """ - locations: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + locations: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The candidate's locations. """ - phone_numbers: typing.Optional[typing.List[PhoneNumberRequest]] - email_addresses: typing.Optional[typing.List[EmailAddressRequest]] - urls: typing.Optional[typing.List[UrlRequest]] - tags: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + phone_numbers: typing.Optional[typing.List[PhoneNumberRequest]] = None + email_addresses: typing.Optional[typing.List[EmailAddressRequest]] = None + urls: typing.Optional[typing.List[UrlRequest]] = None + tags: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ Array of `Tag` names as strings. """ - applications: typing.Optional[typing.List[typing.Optional[CandidateRequestApplicationsItem]]] = pydantic.Field() + applications: typing.Optional[typing.List[typing.Optional[CandidateRequestApplicationsItem]]] = pydantic.Field( + default=None + ) """ Array of `Application` object IDs. """ - attachments: typing.Optional[typing.List[typing.Optional[CandidateRequestAttachmentsItem]]] = pydantic.Field() + attachments: typing.Optional[typing.List[typing.Optional[CandidateRequestAttachmentsItem]]] = pydantic.Field( + default=None + ) """ Array of `Attachment` object IDs. """ - remote_template_id: typing.Optional[str] - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + remote_template_id: typing.Optional[str] = None + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ats/types/candidate_response.py b/src/merge/resources/ats/types/candidate_response.py index 17fb6652..2565f7a8 100644 --- a/src/merge/resources/ats/types/candidate_response.py +++ b/src/merge/resources/ats/types/candidate_response.py @@ -18,7 +18,7 @@ class CandidateResponse(UniversalBaseModel): model: Candidate warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ats/types/data_passthrough_request.py b/src/merge/resources/ats/types/data_passthrough_request.py index f2718105..2b0595cf 100644 --- a/src/merge/resources/ats/types/data_passthrough_request.py +++ b/src/merge/resources/ats/types/data_passthrough_request.py @@ -28,28 +28,28 @@ class DataPassthroughRequest(UniversalBaseModel): The path of the request in the third party's platform. """ - base_url_override: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + 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[RequestFormatEnum] - normalize_response: typing.Optional[bool] = pydantic.Field() + request_format: typing.Optional[RequestFormatEnum] = 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`. """ diff --git a/src/merge/resources/ats/types/department.py b/src/merge/resources/ats/types/department.py index 62ded6f2..60535e8e 100644 --- a/src/merge/resources/ats/types/department.py +++ b/src/merge/resources/ats/types/department.py @@ -21,34 +21,34 @@ class Department(UniversalBaseModel): Fetch from the `LIST Departments` endpoint and view the departments within a company. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The department's name. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/eeoc.py b/src/merge/resources/ats/types/eeoc.py index 7b38f392..77412aab 100644 --- a/src/merge/resources/ats/types/eeoc.py +++ b/src/merge/resources/ats/types/eeoc.py @@ -31,33 +31,33 @@ class Eeoc(UniversalBaseModel): Fetch from the `LIST EEOCs` endpoint and filter by `candidate` to show all EEOC information for a candidate. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - candidate: typing.Optional[EeocCandidate] = pydantic.Field() + candidate: typing.Optional[EeocCandidate] = pydantic.Field(default=None) """ The candidate being represented. """ - submitted_at: typing.Optional[dt.datetime] = pydantic.Field() + submitted_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the information was submitted. """ - race: typing.Optional[EeocRace] = pydantic.Field() + race: typing.Optional[EeocRace] = pydantic.Field(default=None) """ The candidate's race. @@ -71,7 +71,7 @@ class Eeoc(UniversalBaseModel): - `DECLINE_TO_SELF_IDENTIFY` - DECLINE_TO_SELF_IDENTIFY """ - gender: typing.Optional[EeocGender] = pydantic.Field() + gender: typing.Optional[EeocGender] = pydantic.Field(default=None) """ The candidate's gender. @@ -82,7 +82,7 @@ class Eeoc(UniversalBaseModel): - `DECLINE_TO_SELF_IDENTIFY` - DECLINE_TO_SELF_IDENTIFY """ - veteran_status: typing.Optional[EeocVeteranStatus] = pydantic.Field() + veteran_status: typing.Optional[EeocVeteranStatus] = pydantic.Field(default=None) """ The candidate's veteran status. @@ -91,7 +91,7 @@ class Eeoc(UniversalBaseModel): - `I_DONT_WISH_TO_ANSWER` - I_DONT_WISH_TO_ANSWER """ - disability_status: typing.Optional[EeocDisabilityStatus] = pydantic.Field() + disability_status: typing.Optional[EeocDisabilityStatus] = pydantic.Field(default=None) """ The candidate's disability status. @@ -100,13 +100,13 @@ class Eeoc(UniversalBaseModel): - `I_DONT_WISH_TO_ANSWER` - I_DONT_WISH_TO_ANSWER """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/email_address.py b/src/merge/resources/ats/types/email_address.py index 2c1b15d0..a3e6e0a0 100644 --- a/src/merge/resources/ats/types/email_address.py +++ b/src/merge/resources/ats/types/email_address.py @@ -21,22 +21,22 @@ class EmailAddress(UniversalBaseModel): Fetch from the `GET Candidate` endpoint and view their email addresses. """ - created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - value: typing.Optional[str] = pydantic.Field() + value: typing.Optional[str] = pydantic.Field(default=None) """ The email address. """ - email_address_type: typing.Optional[EmailAddressEmailAddressType] = pydantic.Field() + email_address_type: typing.Optional[EmailAddressEmailAddressType] = pydantic.Field(default=None) """ The type of email address. @@ -45,7 +45,7 @@ class EmailAddress(UniversalBaseModel): - `OTHER` - OTHER """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/ats/types/email_address_request.py b/src/merge/resources/ats/types/email_address_request.py index 8c055a68..c7dec9c2 100644 --- a/src/merge/resources/ats/types/email_address_request.py +++ b/src/merge/resources/ats/types/email_address_request.py @@ -20,12 +20,12 @@ class EmailAddressRequest(UniversalBaseModel): Fetch from the `GET Candidate` endpoint and view their email addresses. """ - value: typing.Optional[str] = pydantic.Field() + value: typing.Optional[str] = pydantic.Field(default=None) """ The email address. """ - email_address_type: typing.Optional[EmailAddressRequestEmailAddressType] = pydantic.Field() + email_address_type: typing.Optional[EmailAddressRequestEmailAddressType] = pydantic.Field(default=None) """ The type of email address. @@ -34,8 +34,8 @@ class EmailAddressRequest(UniversalBaseModel): - `OTHER` - OTHER """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ats/types/error_validation_problem.py b/src/merge/resources/ats/types/error_validation_problem.py index 58ea87e6..91565918 100644 --- a/src/merge/resources/ats/types/error_validation_problem.py +++ b/src/merge/resources/ats/types/error_validation_problem.py @@ -8,7 +8,7 @@ class ErrorValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/ats/types/external_target_field_api.py b/src/merge/resources/ats/types/external_target_field_api.py index 18988d44..1ed19a99 100644 --- a/src/merge/resources/ats/types/external_target_field_api.py +++ b/src/merge/resources/ats/types/external_target_field_api.py @@ -7,9 +7,9 @@ class ExternalTargetFieldApi(UniversalBaseModel): - name: typing.Optional[str] - description: typing.Optional[str] - is_mapped: typing.Optional[str] + 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 diff --git a/src/merge/resources/ats/types/external_target_field_api_response.py b/src/merge/resources/ats/types/external_target_field_api_response.py index 9f9f2606..535d7d69 100644 --- a/src/merge/resources/ats/types/external_target_field_api_response.py +++ b/src/merge/resources/ats/types/external_target_field_api_response.py @@ -8,26 +8,30 @@ class ExternalTargetFieldApiResponse(UniversalBaseModel): - activity: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Activity") - application: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Application") - attachment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Attachment") - candidate: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Candidate") - department: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Department") - eeoc: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="EEOC") + activity: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Activity", default=None) + application: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="Application", default=None + ) + attachment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Attachment", default=None) + candidate: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Candidate", default=None) + department: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Department", default=None) + eeoc: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="EEOC", default=None) scheduled_interview: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( - alias="ScheduledInterview" + alias="ScheduledInterview", default=None ) - job: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Job") - job_posting: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="JobPosting") + job: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Job", default=None) + job_posting: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="JobPosting", default=None) job_interview_stage: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( - alias="JobInterviewStage" + alias="JobInterviewStage", default=None + ) + offer: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Offer", default=None) + office: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Office", default=None) + reject_reason: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="RejectReason", default=None ) - offer: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Offer") - office: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Office") - reject_reason: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="RejectReason") - scorecard: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Scorecard") - tag: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Tag") - remote_user: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="RemoteUser") + scorecard: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Scorecard", default=None) + tag: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Tag", default=None) + remote_user: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="RemoteUser", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/field_mapping_api_instance.py b/src/merge/resources/ats/types/field_mapping_api_instance.py index ef4d9c48..1cc2f4a2 100644 --- a/src/merge/resources/ats/types/field_mapping_api_instance.py +++ b/src/merge/resources/ats/types/field_mapping_api_instance.py @@ -9,10 +9,10 @@ class FieldMappingApiInstance(UniversalBaseModel): - id: typing.Optional[str] - is_integration_wide: typing.Optional[bool] - target_field: typing.Optional[FieldMappingApiInstanceTargetField] - remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] + id: typing.Optional[str] = None + is_integration_wide: typing.Optional[bool] = None + target_field: typing.Optional[FieldMappingApiInstanceTargetField] = None + remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py b/src/merge/resources/ats/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py index 14c37c76..9eeb4fbf 100644 --- a/src/merge/resources/ats/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py +++ b/src/merge/resources/ats/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py @@ -7,9 +7,9 @@ class FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo(UniversalBaseModel): - method: typing.Optional[str] - url_path: typing.Optional[str] - field_traversal_path: typing.Optional[typing.List[str]] + 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 diff --git a/src/merge/resources/ats/types/field_mapping_api_instance_response.py b/src/merge/resources/ats/types/field_mapping_api_instance_response.py index 4fabbc20..076d7424 100644 --- a/src/merge/resources/ats/types/field_mapping_api_instance_response.py +++ b/src/merge/resources/ats/types/field_mapping_api_instance_response.py @@ -8,26 +8,34 @@ class FieldMappingApiInstanceResponse(UniversalBaseModel): - activity: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Activity") - application: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Application") - attachment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Attachment") - candidate: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Candidate") - department: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Department") - eeoc: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="EEOC") + activity: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Activity", default=None) + application: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="Application", default=None + ) + attachment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Attachment", default=None) + candidate: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Candidate", default=None) + department: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Department", default=None) + eeoc: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="EEOC", default=None) scheduled_interview: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( - alias="ScheduledInterview" + alias="ScheduledInterview", default=None + ) + job: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Job", default=None) + job_posting: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="JobPosting", default=None ) - job: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Job") - job_posting: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="JobPosting") job_interview_stage: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( - alias="JobInterviewStage" + alias="JobInterviewStage", default=None + ) + offer: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Offer", default=None) + office: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Office", default=None) + reject_reason: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="RejectReason", default=None + ) + scorecard: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Scorecard", default=None) + tag: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Tag", default=None) + remote_user: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="RemoteUser", default=None ) - offer: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Offer") - office: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Office") - reject_reason: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="RejectReason") - scorecard: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Scorecard") - tag: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Tag") - remote_user: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="RemoteUser") if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/field_mapping_instance_response.py b/src/merge/resources/ats/types/field_mapping_instance_response.py index a56aeb93..2123f4d3 100644 --- a/src/merge/resources/ats/types/field_mapping_instance_response.py +++ b/src/merge/resources/ats/types/field_mapping_instance_response.py @@ -14,7 +14,7 @@ class FieldMappingInstanceResponse(UniversalBaseModel): model: FieldMappingApiInstance warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ats/types/field_permission_deserializer.py b/src/merge/resources/ats/types/field_permission_deserializer.py index 9670537a..ea7cc235 100644 --- a/src/merge/resources/ats/types/field_permission_deserializer.py +++ b/src/merge/resources/ats/types/field_permission_deserializer.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializer(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/ats/types/field_permission_deserializer_request.py b/src/merge/resources/ats/types/field_permission_deserializer_request.py index 04e14608..e5617ad6 100644 --- a/src/merge/resources/ats/types/field_permission_deserializer_request.py +++ b/src/merge/resources/ats/types/field_permission_deserializer_request.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializerRequest(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/ats/types/individual_common_model_scope_deserializer.py b/src/merge/resources/ats/types/individual_common_model_scope_deserializer.py index 122df11c..70704314 100644 --- a/src/merge/resources/ats/types/individual_common_model_scope_deserializer.py +++ b/src/merge/resources/ats/types/individual_common_model_scope_deserializer.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializer(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializer]] - field_permissions: typing.Optional[FieldPermissionDeserializer] + 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 diff --git a/src/merge/resources/ats/types/individual_common_model_scope_deserializer_request.py b/src/merge/resources/ats/types/individual_common_model_scope_deserializer_request.py index a1a80902..d42dd53a 100644 --- a/src/merge/resources/ats/types/individual_common_model_scope_deserializer_request.py +++ b/src/merge/resources/ats/types/individual_common_model_scope_deserializer_request.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializerRequest(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializerRequest]] - field_permissions: typing.Optional[FieldPermissionDeserializerRequest] + 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 diff --git a/src/merge/resources/ats/types/issue.py b/src/merge/resources/ats/types/issue.py index 5a584515..7adc1f31 100644 --- a/src/merge/resources/ats/types/issue.py +++ b/src/merge/resources/ats/types/issue.py @@ -9,8 +9,8 @@ class Issue(UniversalBaseModel): - id: typing.Optional[str] - status: typing.Optional[IssueStatus] = pydantic.Field() + id: typing.Optional[str] = None + status: typing.Optional[IssueStatus] = pydantic.Field(default=None) """ Status of the issue. Options: ('ONGOING', 'RESOLVED') @@ -19,11 +19,11 @@ class Issue(UniversalBaseModel): """ error_description: str - end_user: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - first_incident_time: typing.Optional[dt.datetime] - last_incident_time: typing.Optional[dt.datetime] - is_muted: typing.Optional[bool] - error_details: typing.Optional[typing.List[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 diff --git a/src/merge/resources/ats/types/job.py b/src/merge/resources/ats/types/job.py index c3de5648..999549dd 100644 --- a/src/merge/resources/ats/types/job.py +++ b/src/merge/resources/ats/types/job.py @@ -28,38 +28,38 @@ class Job(UniversalBaseModel): Fetch from the `LIST Jobs` endpoint to show all job postings. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The job's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The job's description. """ - code: typing.Optional[str] = pydantic.Field() + code: typing.Optional[str] = pydantic.Field(default=None) """ The job's code. Typically an additional identifier used to reference the particular job that is displayed on the ATS. """ - status: typing.Optional[JobStatus] = pydantic.Field() + status: typing.Optional[JobStatus] = pydantic.Field(default=None) """ The job's status. @@ -70,7 +70,7 @@ class Job(UniversalBaseModel): - `PENDING` - PENDING """ - type: typing.Optional[JobTypeEnum] = pydantic.Field() + type: typing.Optional[JobTypeEnum] = pydantic.Field(default=None) """ The job's type. @@ -79,54 +79,54 @@ class Job(UniversalBaseModel): - `PROFILE` - PROFILE """ - job_postings: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + job_postings: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ IDs of `JobPosting` objects that serve as job postings for this `Job`. """ - job_posting_urls: typing.Optional[typing.List[Url]] - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + job_posting_urls: typing.Optional[typing.List[Url]] = None + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's job was created. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's job was updated. """ - confidential: typing.Optional[bool] = pydantic.Field() + confidential: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the job is confidential. """ - departments: typing.Optional[typing.List[typing.Optional[JobDepartmentsItem]]] = pydantic.Field() + departments: typing.Optional[typing.List[typing.Optional[JobDepartmentsItem]]] = pydantic.Field(default=None) """ IDs of `Department` objects for this `Job`. """ - offices: typing.Optional[typing.List[typing.Optional[JobOfficesItem]]] = pydantic.Field() + offices: typing.Optional[typing.List[typing.Optional[JobOfficesItem]]] = pydantic.Field(default=None) """ IDs of `Office` objects for this `Job`. """ - hiring_managers: typing.Optional[typing.List[typing.Optional[JobHiringManagersItem]]] = pydantic.Field() + hiring_managers: typing.Optional[typing.List[typing.Optional[JobHiringManagersItem]]] = pydantic.Field(default=None) """ IDs of `RemoteUser` objects that serve as hiring managers for this `Job`. """ - recruiters: typing.Optional[typing.List[typing.Optional[JobRecruitersItem]]] = pydantic.Field() + recruiters: typing.Optional[typing.List[typing.Optional[JobRecruitersItem]]] = pydantic.Field(default=None) """ IDs of `RemoteUser` objects that serve as recruiters for this `Job`. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/job_interview_stage.py b/src/merge/resources/ats/types/job_interview_stage.py index 42e0cbf8..8515121b 100644 --- a/src/merge/resources/ats/types/job_interview_stage.py +++ b/src/merge/resources/ats/types/job_interview_stage.py @@ -22,44 +22,44 @@ class JobInterviewStage(UniversalBaseModel): Fetch from the `LIST JobInterviewStages` endpoint and view the job interview stages used by a company. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ Standard stage names are offered by ATS systems but can be modified by users. """ - job: typing.Optional[JobInterviewStageJob] = pydantic.Field() + job: typing.Optional[JobInterviewStageJob] = pydantic.Field(default=None) """ This field is populated only if the stage is specific to a particular job. If the stage is generic, this field will not be populated. """ - stage_order: typing.Optional[int] = pydantic.Field() + stage_order: typing.Optional[int] = pydantic.Field(default=None) """ The stage’s order, with the lowest values ordered first. If the third-party does not return details on the order of stages, this field will not be populated. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/job_posting.py b/src/merge/resources/ats/types/job_posting.py index 0d8c3899..53b4a9b8 100644 --- a/src/merge/resources/ats/types/job_posting.py +++ b/src/merge/resources/ats/types/job_posting.py @@ -24,38 +24,38 @@ class JobPosting(UniversalBaseModel): Fetch from the `LIST JobPostings` endpoint to show all job postings. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - title: typing.Optional[str] = pydantic.Field() + title: typing.Optional[str] = pydantic.Field(default=None) """ The job posting’s title. """ - job_posting_urls: typing.Optional[typing.List[JobPostingJobPostingUrlsItem]] = pydantic.Field() + job_posting_urls: typing.Optional[typing.List[JobPostingJobPostingUrlsItem]] = pydantic.Field(default=None) """ The Url object is used to represent hyperlinks for a candidate to apply to a given job. """ - job: typing.Optional[JobPostingJob] = pydantic.Field() + job: typing.Optional[JobPostingJob] = pydantic.Field(default=None) """ ID of `Job` object for this `JobPosting`. """ - status: typing.Optional[JobPostingStatusEnum] = pydantic.Field() + status: typing.Optional[JobPostingStatusEnum] = pydantic.Field(default=None) """ The job posting's status. @@ -66,33 +66,33 @@ class JobPosting(UniversalBaseModel): - `PENDING` - PENDING """ - content: typing.Optional[str] = pydantic.Field() + content: typing.Optional[str] = pydantic.Field(default=None) """ The job posting’s content. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's job posting was created. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's job posting was updated. """ - is_internal: typing.Optional[bool] = pydantic.Field() + is_internal: typing.Optional[bool] = pydantic.Field(default=None) """ Indicates whether the job posting is internal or external. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/link_token.py b/src/merge/resources/ats/types/link_token.py index 1d25dddb..ac916d14 100644 --- a/src/merge/resources/ats/types/link_token.py +++ b/src/merge/resources/ats/types/link_token.py @@ -8,8 +8,8 @@ class LinkToken(UniversalBaseModel): link_token: str - integration_name: typing.Optional[str] - magic_link_url: typing.Optional[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 diff --git a/src/merge/resources/ats/types/meta_response.py b/src/merge/resources/ats/types/meta_response.py index 44e57fde..272535f0 100644 --- a/src/merge/resources/ats/types/meta_response.py +++ b/src/merge/resources/ats/types/meta_response.py @@ -9,8 +9,8 @@ class MetaResponse(UniversalBaseModel): request_schema: typing.Dict[str, typing.Optional[typing.Any]] - remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - status: typing.Optional[LinkedAccountStatus] + remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + status: typing.Optional[LinkedAccountStatus] = None has_conditional_params: bool has_required_linked_account_params: bool diff --git a/src/merge/resources/ats/types/model_permission_deserializer.py b/src/merge/resources/ats/types/model_permission_deserializer.py index b6d813e4..96f39e63 100644 --- a/src/merge/resources/ats/types/model_permission_deserializer.py +++ b/src/merge/resources/ats/types/model_permission_deserializer.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializer(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/ats/types/model_permission_deserializer_request.py b/src/merge/resources/ats/types/model_permission_deserializer_request.py index 5885627b..2619fb6a 100644 --- a/src/merge/resources/ats/types/model_permission_deserializer_request.py +++ b/src/merge/resources/ats/types/model_permission_deserializer_request.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializerRequest(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/ats/types/multipart_form_field_request.py b/src/merge/resources/ats/types/multipart_form_field_request.py index 80099016..507fa8c6 100644 --- a/src/merge/resources/ats/types/multipart_form_field_request.py +++ b/src/merge/resources/ats/types/multipart_form_field_request.py @@ -30,7 +30,7 @@ class MultipartFormFieldRequest(UniversalBaseModel): The data for the form field. """ - encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field() + encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field(default=None) """ The encoding of the value of `data`. Defaults to `RAW` if not defined. @@ -39,12 +39,12 @@ class MultipartFormFieldRequest(UniversalBaseModel): - `GZIP_BASE64` - GZIP_BASE64 """ - file_name: typing.Optional[str] = pydantic.Field() + 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() + content_type: typing.Optional[str] = pydantic.Field(default=None) """ The MIME type of the file, if the field is for a file. """ diff --git a/src/merge/resources/ats/types/offer.py b/src/merge/resources/ats/types/offer.py index 9fd3f6b3..d9bda09f 100644 --- a/src/merge/resources/ats/types/offer.py +++ b/src/merge/resources/ats/types/offer.py @@ -25,53 +25,53 @@ class Offer(UniversalBaseModel): Fetch from the `LIST Offers` endpoint and filter by `ID` to show all offers. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - application: typing.Optional["OfferApplication"] = pydantic.Field() + application: typing.Optional["OfferApplication"] = pydantic.Field(default=None) """ The application who is receiving the offer. """ - creator: typing.Optional[OfferCreator] = pydantic.Field() + creator: typing.Optional[OfferCreator] = pydantic.Field(default=None) """ The user who created the offer. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's offer was created. """ - closed_at: typing.Optional[dt.datetime] = pydantic.Field() + closed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the offer was closed. """ - sent_at: typing.Optional[dt.datetime] = pydantic.Field() + sent_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the offer was sent. """ - start_date: typing.Optional[dt.datetime] = pydantic.Field() + start_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The employment start date on the offer. """ - status: typing.Optional[OfferStatus] = pydantic.Field() + status: typing.Optional[OfferStatus] = pydantic.Field(default=None) """ The offer's status. @@ -86,13 +86,13 @@ class Offer(UniversalBaseModel): - `DEPRECATED` - DEPRECATED """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/office.py b/src/merge/resources/ats/types/office.py index b547fe4a..85cb09de 100644 --- a/src/merge/resources/ats/types/office.py +++ b/src/merge/resources/ats/types/office.py @@ -21,39 +21,39 @@ class Office(UniversalBaseModel): Fetch from the `LIST Offices` endpoint and view the offices within a company. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The office's name. """ - location: typing.Optional[str] = pydantic.Field() + location: typing.Optional[str] = pydantic.Field(default=None) """ The office's location. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/paginated_account_details_and_actions_list.py b/src/merge/resources/ats/types/paginated_account_details_and_actions_list.py index a9128c76..00ceeda5 100644 --- a/src/merge/resources/ats/types/paginated_account_details_and_actions_list.py +++ b/src/merge/resources/ats/types/paginated_account_details_and_actions_list.py @@ -8,9 +8,9 @@ class PaginatedAccountDetailsAndActionsList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AccountDetailsAndActions]] + 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 diff --git a/src/merge/resources/ats/types/paginated_activity_list.py b/src/merge/resources/ats/types/paginated_activity_list.py index 0c4832e2..b74b810d 100644 --- a/src/merge/resources/ats/types/paginated_activity_list.py +++ b/src/merge/resources/ats/types/paginated_activity_list.py @@ -8,9 +8,9 @@ class PaginatedActivityList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Activity]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Activity]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_application_list.py b/src/merge/resources/ats/types/paginated_application_list.py index 30fe8ba7..8be6d743 100644 --- a/src/merge/resources/ats/types/paginated_application_list.py +++ b/src/merge/resources/ats/types/paginated_application_list.py @@ -12,9 +12,9 @@ class PaginatedApplicationList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Application]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Application]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_attachment_list.py b/src/merge/resources/ats/types/paginated_attachment_list.py index 4331659b..38197910 100644 --- a/src/merge/resources/ats/types/paginated_attachment_list.py +++ b/src/merge/resources/ats/types/paginated_attachment_list.py @@ -8,9 +8,9 @@ class PaginatedAttachmentList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Attachment]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Attachment]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_audit_log_event_list.py b/src/merge/resources/ats/types/paginated_audit_log_event_list.py index a50b7c75..450de68c 100644 --- a/src/merge/resources/ats/types/paginated_audit_log_event_list.py +++ b/src/merge/resources/ats/types/paginated_audit_log_event_list.py @@ -8,9 +8,9 @@ class PaginatedAuditLogEventList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AuditLogEvent]] + 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 diff --git a/src/merge/resources/ats/types/paginated_candidate_list.py b/src/merge/resources/ats/types/paginated_candidate_list.py index dba61ba5..535bf83a 100644 --- a/src/merge/resources/ats/types/paginated_candidate_list.py +++ b/src/merge/resources/ats/types/paginated_candidate_list.py @@ -12,9 +12,9 @@ class PaginatedCandidateList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Candidate]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Candidate]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_department_list.py b/src/merge/resources/ats/types/paginated_department_list.py index 030bf008..bc1655a5 100644 --- a/src/merge/resources/ats/types/paginated_department_list.py +++ b/src/merge/resources/ats/types/paginated_department_list.py @@ -8,9 +8,9 @@ class PaginatedDepartmentList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Department]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Department]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_eeoc_list.py b/src/merge/resources/ats/types/paginated_eeoc_list.py index ce109201..d6d05bdf 100644 --- a/src/merge/resources/ats/types/paginated_eeoc_list.py +++ b/src/merge/resources/ats/types/paginated_eeoc_list.py @@ -13,9 +13,9 @@ class PaginatedEeocList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Eeoc]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Eeoc]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_issue_list.py b/src/merge/resources/ats/types/paginated_issue_list.py index 12b866d9..758e6dc3 100644 --- a/src/merge/resources/ats/types/paginated_issue_list.py +++ b/src/merge/resources/ats/types/paginated_issue_list.py @@ -8,9 +8,9 @@ class PaginatedIssueList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Issue]] + 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 diff --git a/src/merge/resources/ats/types/paginated_job_interview_stage_list.py b/src/merge/resources/ats/types/paginated_job_interview_stage_list.py index 981b15ed..3ab651f2 100644 --- a/src/merge/resources/ats/types/paginated_job_interview_stage_list.py +++ b/src/merge/resources/ats/types/paginated_job_interview_stage_list.py @@ -8,9 +8,9 @@ class PaginatedJobInterviewStageList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[JobInterviewStage]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[JobInterviewStage]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_job_list.py b/src/merge/resources/ats/types/paginated_job_list.py index 9c2f7118..94be4991 100644 --- a/src/merge/resources/ats/types/paginated_job_list.py +++ b/src/merge/resources/ats/types/paginated_job_list.py @@ -8,9 +8,9 @@ class PaginatedJobList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Job]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Job]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_job_posting_list.py b/src/merge/resources/ats/types/paginated_job_posting_list.py index 11f8a3f2..b18cbbf8 100644 --- a/src/merge/resources/ats/types/paginated_job_posting_list.py +++ b/src/merge/resources/ats/types/paginated_job_posting_list.py @@ -8,9 +8,9 @@ class PaginatedJobPostingList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[JobPosting]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[JobPosting]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_offer_list.py b/src/merge/resources/ats/types/paginated_offer_list.py index aeab94ea..88655039 100644 --- a/src/merge/resources/ats/types/paginated_offer_list.py +++ b/src/merge/resources/ats/types/paginated_offer_list.py @@ -12,9 +12,9 @@ class PaginatedOfferList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Offer]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Offer]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_office_list.py b/src/merge/resources/ats/types/paginated_office_list.py index 72aa2c5c..44e92d18 100644 --- a/src/merge/resources/ats/types/paginated_office_list.py +++ b/src/merge/resources/ats/types/paginated_office_list.py @@ -8,9 +8,9 @@ class PaginatedOfficeList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Office]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Office]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_reject_reason_list.py b/src/merge/resources/ats/types/paginated_reject_reason_list.py index 69e6bcc7..b69dfabb 100644 --- a/src/merge/resources/ats/types/paginated_reject_reason_list.py +++ b/src/merge/resources/ats/types/paginated_reject_reason_list.py @@ -8,9 +8,9 @@ class PaginatedRejectReasonList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[RejectReason]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[RejectReason]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_remote_user_list.py b/src/merge/resources/ats/types/paginated_remote_user_list.py index 87b92968..3130888f 100644 --- a/src/merge/resources/ats/types/paginated_remote_user_list.py +++ b/src/merge/resources/ats/types/paginated_remote_user_list.py @@ -8,9 +8,9 @@ class PaginatedRemoteUserList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[RemoteUser]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[RemoteUser]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_scheduled_interview_list.py b/src/merge/resources/ats/types/paginated_scheduled_interview_list.py index d54da6e9..d8f0dc70 100644 --- a/src/merge/resources/ats/types/paginated_scheduled_interview_list.py +++ b/src/merge/resources/ats/types/paginated_scheduled_interview_list.py @@ -13,9 +13,9 @@ class PaginatedScheduledInterviewList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[ScheduledInterview]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[ScheduledInterview]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_scorecard_list.py b/src/merge/resources/ats/types/paginated_scorecard_list.py index 5c318877..eee689fb 100644 --- a/src/merge/resources/ats/types/paginated_scorecard_list.py +++ b/src/merge/resources/ats/types/paginated_scorecard_list.py @@ -13,9 +13,9 @@ class PaginatedScorecardList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Scorecard]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Scorecard]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_screening_question_list.py b/src/merge/resources/ats/types/paginated_screening_question_list.py index 0a7c5f0c..2d5fbc0e 100644 --- a/src/merge/resources/ats/types/paginated_screening_question_list.py +++ b/src/merge/resources/ats/types/paginated_screening_question_list.py @@ -8,9 +8,9 @@ class PaginatedScreeningQuestionList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[ScreeningQuestion]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[ScreeningQuestion]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/paginated_sync_status_list.py b/src/merge/resources/ats/types/paginated_sync_status_list.py index f59f2c9a..f4f09ed1 100644 --- a/src/merge/resources/ats/types/paginated_sync_status_list.py +++ b/src/merge/resources/ats/types/paginated_sync_status_list.py @@ -8,9 +8,9 @@ class PaginatedSyncStatusList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[SyncStatus]] + 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 diff --git a/src/merge/resources/ats/types/paginated_tag_list.py b/src/merge/resources/ats/types/paginated_tag_list.py index 9c632ec6..7557bbd5 100644 --- a/src/merge/resources/ats/types/paginated_tag_list.py +++ b/src/merge/resources/ats/types/paginated_tag_list.py @@ -8,9 +8,9 @@ class PaginatedTagList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Tag]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Tag]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/patched_candidate_request.py b/src/merge/resources/ats/types/patched_candidate_request.py index 80c1496e..94867bda 100644 --- a/src/merge/resources/ats/types/patched_candidate_request.py +++ b/src/merge/resources/ats/types/patched_candidate_request.py @@ -23,67 +23,67 @@ class PatchedCandidateRequest(UniversalBaseModel): Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all candidates. """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's last name. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's current company. """ - title: typing.Optional[str] = pydantic.Field() + title: typing.Optional[str] = pydantic.Field(default=None) """ The candidate's current title. """ - last_interaction_at: typing.Optional[dt.datetime] = pydantic.Field() + last_interaction_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the most recent interaction with the candidate occurred. """ - is_private: typing.Optional[bool] = pydantic.Field() + is_private: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the candidate is private. """ - can_email: typing.Optional[bool] = pydantic.Field() + can_email: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the candidate can be emailed. """ - locations: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + locations: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The candidate's locations. """ - phone_numbers: typing.Optional[typing.List[PhoneNumberRequest]] - email_addresses: typing.Optional[typing.List[EmailAddressRequest]] - urls: typing.Optional[typing.List[UrlRequest]] - tags: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + phone_numbers: typing.Optional[typing.List[PhoneNumberRequest]] = None + email_addresses: typing.Optional[typing.List[EmailAddressRequest]] = None + urls: typing.Optional[typing.List[UrlRequest]] = None + tags: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ Array of `Tag` names as strings. """ - applications: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + applications: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ Array of `Application` object IDs. """ - attachments: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + attachments: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ Array of `Attachment` object IDs. """ - remote_template_id: typing.Optional[str] - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + remote_template_id: typing.Optional[str] = None + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ats/types/phone_number.py b/src/merge/resources/ats/types/phone_number.py index 1e8a2831..4aa5e94f 100644 --- a/src/merge/resources/ats/types/phone_number.py +++ b/src/merge/resources/ats/types/phone_number.py @@ -21,22 +21,22 @@ class PhoneNumber(UniversalBaseModel): Fetch from the `GET Candidate` endpoint and view their phone numbers. """ - created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - value: typing.Optional[str] = pydantic.Field() + value: typing.Optional[str] = pydantic.Field(default=None) """ The phone number. """ - phone_number_type: typing.Optional[PhoneNumberPhoneNumberType] = pydantic.Field() + phone_number_type: typing.Optional[PhoneNumberPhoneNumberType] = pydantic.Field(default=None) """ The type of phone number. @@ -47,7 +47,7 @@ class PhoneNumber(UniversalBaseModel): - `OTHER` - OTHER """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/ats/types/phone_number_request.py b/src/merge/resources/ats/types/phone_number_request.py index 36f7968c..a497702d 100644 --- a/src/merge/resources/ats/types/phone_number_request.py +++ b/src/merge/resources/ats/types/phone_number_request.py @@ -20,12 +20,12 @@ class PhoneNumberRequest(UniversalBaseModel): Fetch from the `GET Candidate` endpoint and view their phone numbers. """ - value: typing.Optional[str] = pydantic.Field() + value: typing.Optional[str] = pydantic.Field(default=None) """ The phone number. """ - phone_number_type: typing.Optional[PhoneNumberRequestPhoneNumberType] = pydantic.Field() + phone_number_type: typing.Optional[PhoneNumberRequestPhoneNumberType] = pydantic.Field(default=None) """ The type of phone number. @@ -36,8 +36,8 @@ class PhoneNumberRequest(UniversalBaseModel): - `OTHER` - OTHER """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ats/types/reject_reason.py b/src/merge/resources/ats/types/reject_reason.py index ee47ca32..be9e4928 100644 --- a/src/merge/resources/ats/types/reject_reason.py +++ b/src/merge/resources/ats/types/reject_reason.py @@ -21,34 +21,34 @@ class RejectReason(UniversalBaseModel): Fetch from the `LIST RejectReasons` endpoint and filter by `ID` to show all reasons. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The rejection reason’s name. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/remote_data.py b/src/merge/resources/ats/types/remote_data.py index 27c2a5f2..09a6b50b 100644 --- a/src/merge/resources/ats/types/remote_data.py +++ b/src/merge/resources/ats/types/remote_data.py @@ -8,7 +8,7 @@ class RemoteData(UniversalBaseModel): path: str - data: typing.Optional[typing.Optional[typing.Any]] + data: typing.Optional[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 diff --git a/src/merge/resources/ats/types/remote_field_api.py b/src/merge/resources/ats/types/remote_field_api.py index 18f2421d..82495d75 100644 --- a/src/merge/resources/ats/types/remote_field_api.py +++ b/src/merge/resources/ats/types/remote_field_api.py @@ -13,9 +13,9 @@ class RemoteFieldApi(UniversalBaseModel): 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]]] - advanced_metadata: typing.Optional[AdvancedMetadata] - coverage: typing.Optional[RemoteFieldApiCoverage] + example_values: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + advanced_metadata: typing.Optional[AdvancedMetadata] = 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 diff --git a/src/merge/resources/ats/types/remote_field_api_response.py b/src/merge/resources/ats/types/remote_field_api_response.py index 98d643a4..20e8941c 100644 --- a/src/merge/resources/ats/types/remote_field_api_response.py +++ b/src/merge/resources/ats/types/remote_field_api_response.py @@ -8,22 +8,26 @@ class RemoteFieldApiResponse(UniversalBaseModel): - activity: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Activity") - application: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Application") - attachment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Attachment") - candidate: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Candidate") - department: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Department") - eeoc: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="EEOC") - scheduled_interview: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="ScheduledInterview") - job: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Job") - job_posting: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="JobPosting") - job_interview_stage: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="JobInterviewStage") - offer: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Offer") - office: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Office") - reject_reason: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="RejectReason") - scorecard: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Scorecard") - tag: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Tag") - remote_user: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="RemoteUser") + activity: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Activity", default=None) + application: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Application", default=None) + attachment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Attachment", default=None) + candidate: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Candidate", default=None) + department: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Department", default=None) + eeoc: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="EEOC", default=None) + scheduled_interview: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="ScheduledInterview", default=None + ) + job: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Job", default=None) + job_posting: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="JobPosting", default=None) + job_interview_stage: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="JobInterviewStage", default=None + ) + offer: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Offer", default=None) + office: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Office", default=None) + reject_reason: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="RejectReason", default=None) + scorecard: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Scorecard", default=None) + tag: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Tag", default=None) + remote_user: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="RemoteUser", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ats/types/remote_response.py b/src/merge/resources/ats/types/remote_response.py index 4c9da086..a109efce 100644 --- a/src/merge/resources/ats/types/remote_response.py +++ b/src/merge/resources/ats/types/remote_response.py @@ -23,10 +23,10 @@ class RemoteResponse(UniversalBaseModel): method: str path: str status: int - response: typing.Optional[typing.Any] - response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - response_type: typing.Optional[RemoteResponseResponseType] - headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + 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 diff --git a/src/merge/resources/ats/types/remote_user.py b/src/merge/resources/ats/types/remote_user.py index 71d9be41..c257eac7 100644 --- a/src/merge/resources/ats/types/remote_user.py +++ b/src/merge/resources/ats/types/remote_user.py @@ -22,48 +22,48 @@ class RemoteUser(UniversalBaseModel): Fetch from the `LIST RemoteUsers` endpoint to show all users for a third party. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The user's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The user's last name. """ - email: typing.Optional[str] = pydantic.Field() + email: typing.Optional[str] = pydantic.Field(default=None) """ The user's email. """ - disabled: typing.Optional[bool] = pydantic.Field() + disabled: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the user's account had been disabled. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's user was created. """ - access_role: typing.Optional[RemoteUserAccessRole] = pydantic.Field() + access_role: typing.Optional[RemoteUserAccessRole] = pydantic.Field(default=None) """ The user's role. @@ -74,13 +74,13 @@ class RemoteUser(UniversalBaseModel): - `INTERVIEWER` - INTERVIEWER """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/scheduled_interview.py b/src/merge/resources/ats/types/scheduled_interview.py index ea8920f2..dcba69fb 100644 --- a/src/merge/resources/ats/types/scheduled_interview.py +++ b/src/merge/resources/ats/types/scheduled_interview.py @@ -31,68 +31,70 @@ class ScheduledInterview(UniversalBaseModel): Fetch from the `LIST ScheduledInterviews` endpoint and filter by `interviewers` to show all office locations. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - application: typing.Optional[ScheduledInterviewApplication] = pydantic.Field() + application: typing.Optional[ScheduledInterviewApplication] = pydantic.Field(default=None) """ The application being interviewed. """ - job_interview_stage: typing.Optional[ScheduledInterviewJobInterviewStage] = pydantic.Field() + job_interview_stage: typing.Optional[ScheduledInterviewJobInterviewStage] = pydantic.Field(default=None) """ The stage of the interview. """ - organizer: typing.Optional[ScheduledInterviewOrganizer] = pydantic.Field() + organizer: typing.Optional[ScheduledInterviewOrganizer] = pydantic.Field(default=None) """ The user organizing the interview. """ - interviewers: typing.Optional[typing.List[typing.Optional[ScheduledInterviewInterviewersItem]]] = pydantic.Field() + interviewers: typing.Optional[typing.List[typing.Optional[ScheduledInterviewInterviewersItem]]] = pydantic.Field( + default=None + ) """ Array of `RemoteUser` IDs. """ - location: typing.Optional[str] = pydantic.Field() + location: typing.Optional[str] = pydantic.Field(default=None) """ The interview's location. """ - start_at: typing.Optional[dt.datetime] = pydantic.Field() + start_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the interview was started. """ - end_at: typing.Optional[dt.datetime] = pydantic.Field() + end_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the interview was ended. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's interview was created. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's interview was updated. """ - status: typing.Optional[ScheduledInterviewStatus] = pydantic.Field() + status: typing.Optional[ScheduledInterviewStatus] = pydantic.Field(default=None) """ The interview's status. @@ -101,13 +103,13 @@ class ScheduledInterview(UniversalBaseModel): - `COMPLETE` - COMPLETE """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/scheduled_interview_request.py b/src/merge/resources/ats/types/scheduled_interview_request.py index 8213b884..c25b1fb1 100644 --- a/src/merge/resources/ats/types/scheduled_interview_request.py +++ b/src/merge/resources/ats/types/scheduled_interview_request.py @@ -30,44 +30,44 @@ class ScheduledInterviewRequest(UniversalBaseModel): Fetch from the `LIST ScheduledInterviews` endpoint and filter by `interviewers` to show all office locations. """ - application: typing.Optional[ScheduledInterviewRequestApplication] = pydantic.Field() + application: typing.Optional[ScheduledInterviewRequestApplication] = pydantic.Field(default=None) """ The application being interviewed. """ - job_interview_stage: typing.Optional[ScheduledInterviewRequestJobInterviewStage] = pydantic.Field() + job_interview_stage: typing.Optional[ScheduledInterviewRequestJobInterviewStage] = pydantic.Field(default=None) """ The stage of the interview. """ - organizer: typing.Optional[ScheduledInterviewRequestOrganizer] = pydantic.Field() + organizer: typing.Optional[ScheduledInterviewRequestOrganizer] = pydantic.Field(default=None) """ The user organizing the interview. """ interviewers: typing.Optional[typing.List[typing.Optional[ScheduledInterviewRequestInterviewersItem]]] = ( - pydantic.Field() + pydantic.Field(default=None) ) """ Array of `RemoteUser` IDs. """ - location: typing.Optional[str] = pydantic.Field() + location: typing.Optional[str] = pydantic.Field(default=None) """ The interview's location. """ - start_at: typing.Optional[dt.datetime] = pydantic.Field() + start_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the interview was started. """ - end_at: typing.Optional[dt.datetime] = pydantic.Field() + end_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the interview was ended. """ - status: typing.Optional[ScheduledInterviewRequestStatus] = pydantic.Field() + status: typing.Optional[ScheduledInterviewRequestStatus] = pydantic.Field(default=None) """ The interview's status. @@ -76,8 +76,8 @@ class ScheduledInterviewRequest(UniversalBaseModel): - `COMPLETE` - COMPLETE """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ats/types/scheduled_interview_response.py b/src/merge/resources/ats/types/scheduled_interview_response.py index fd5620aa..953a764c 100644 --- a/src/merge/resources/ats/types/scheduled_interview_response.py +++ b/src/merge/resources/ats/types/scheduled_interview_response.py @@ -19,7 +19,7 @@ class ScheduledInterviewResponse(UniversalBaseModel): model: ScheduledInterview warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ats/types/scorecard.py b/src/merge/resources/ats/types/scorecard.py index a6f70035..84f5b4ae 100644 --- a/src/merge/resources/ats/types/scorecard.py +++ b/src/merge/resources/ats/types/scorecard.py @@ -30,48 +30,48 @@ class Scorecard(UniversalBaseModel): Fetch from the `LIST Scorecards` endpoint and filter by `application` to show all scorecard for an applicant. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - application: typing.Optional[ScorecardApplication] = pydantic.Field() + application: typing.Optional[ScorecardApplication] = pydantic.Field(default=None) """ The application being scored. """ - interview: typing.Optional[ScorecardInterview] = pydantic.Field() + interview: typing.Optional[ScorecardInterview] = pydantic.Field(default=None) """ The interview being scored. """ - interviewer: typing.Optional[ScorecardInterviewer] = pydantic.Field() + interviewer: typing.Optional[ScorecardInterviewer] = pydantic.Field(default=None) """ The interviewer doing the scoring. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's scorecard was created. """ - submitted_at: typing.Optional[dt.datetime] = pydantic.Field() + submitted_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the scorecard was submitted. """ - overall_recommendation: typing.Optional[ScorecardOverallRecommendation] = pydantic.Field() + overall_recommendation: typing.Optional[ScorecardOverallRecommendation] = pydantic.Field(default=None) """ The inteviewer's recommendation. @@ -82,13 +82,13 @@ class Scorecard(UniversalBaseModel): - `NO_DECISION` - NO_DECISION """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ats/types/screening_question.py b/src/merge/resources/ats/types/screening_question.py index daeb2afe..63e5d503 100644 --- a/src/merge/resources/ats/types/screening_question.py +++ b/src/merge/resources/ats/types/screening_question.py @@ -22,38 +22,38 @@ class ScreeningQuestion(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - job: typing.Optional[ScreeningQuestionJob] = pydantic.Field() + job: typing.Optional[ScreeningQuestionJob] = pydantic.Field(default=None) """ The job associated with the screening question. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The description of the screening question """ - title: typing.Optional[str] = pydantic.Field() + title: typing.Optional[str] = pydantic.Field(default=None) """ The title of the screening question """ - type: typing.Optional[ScreeningQuestionType] = pydantic.Field() + type: typing.Optional[ScreeningQuestionType] = pydantic.Field(default=None) """ The data type for the screening question. @@ -67,13 +67,13 @@ class ScreeningQuestion(UniversalBaseModel): - `BOOLEAN` - BOOLEAN """ - required: typing.Optional[bool] = pydantic.Field() + required: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the screening question is required. """ - options: typing.Optional[typing.List[typing.Optional[typing.Any]]] - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + options: typing.Optional[typing.List[typing.Optional[typing.Any]]] = 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/). """ diff --git a/src/merge/resources/ats/types/screening_question_answer.py b/src/merge/resources/ats/types/screening_question_answer.py index b28f16bb..38e3f026 100644 --- a/src/merge/resources/ats/types/screening_question_answer.py +++ b/src/merge/resources/ats/types/screening_question_answer.py @@ -21,33 +21,33 @@ class ScreeningQuestionAnswer(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - question: typing.Optional[ScreeningQuestionAnswerQuestion] = pydantic.Field() + question: typing.Optional[ScreeningQuestionAnswerQuestion] = pydantic.Field(default=None) """ The screening question associated with the candidate’s answer. To determine the data type of the answer, you can expand on the screening question by adding `screening_question_answers.question` to the `expand` query parameter. """ - answer: typing.Optional[str] = pydantic.Field() + answer: typing.Optional[str] = pydantic.Field(default=None) """ The candidate’s response to the screening question. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/ats/types/screening_question_answer_request.py b/src/merge/resources/ats/types/screening_question_answer_request.py index c1cdf362..9517ea79 100644 --- a/src/merge/resources/ats/types/screening_question_answer_request.py +++ b/src/merge/resources/ats/types/screening_question_answer_request.py @@ -20,23 +20,23 @@ class ScreeningQuestionAnswerRequest(UniversalBaseModel): TODO """ - remote_id: typing.Optional[str] = pydantic.Field() + remote_id: typing.Optional[str] = pydantic.Field(default=None) """ The third-party API ID of the matching object. """ - question: typing.Optional[ScreeningQuestionAnswerRequestQuestion] = pydantic.Field() + question: typing.Optional[ScreeningQuestionAnswerRequestQuestion] = pydantic.Field(default=None) """ The screening question associated with the candidate’s answer. To determine the data type of the answer, you can expand on the screening question by adding `screening_question_answers.question` to the `expand` query parameter. """ - answer: typing.Optional[str] = pydantic.Field() + answer: typing.Optional[str] = pydantic.Field(default=None) """ The candidate’s response to the screening question. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ats/types/screening_question_option.py b/src/merge/resources/ats/types/screening_question_option.py index edb8a86f..e3c95098 100644 --- a/src/merge/resources/ats/types/screening_question_option.py +++ b/src/merge/resources/ats/types/screening_question_option.py @@ -20,28 +20,28 @@ class ScreeningQuestionOption(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - label: typing.Optional[str] = pydantic.Field() + label: typing.Optional[str] = pydantic.Field(default=None) """ Available response options """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/ats/types/sync_status.py b/src/merge/resources/ats/types/sync_status.py index f9a62229..c1a01c18 100644 --- a/src/merge/resources/ats/types/sync_status.py +++ b/src/merge/resources/ats/types/sync_status.py @@ -24,11 +24,11 @@ class SyncStatus(UniversalBaseModel): model_name: str model_id: str - last_sync_start: typing.Optional[dt.datetime] - next_sync_start: typing.Optional[dt.datetime] + last_sync_start: typing.Optional[dt.datetime] = None + next_sync_start: typing.Optional[dt.datetime] = None status: SyncStatusStatusEnum is_initial_sync: bool - selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] + 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 diff --git a/src/merge/resources/ats/types/tag.py b/src/merge/resources/ats/types/tag.py index a339f23c..1103c722 100644 --- a/src/merge/resources/ats/types/tag.py +++ b/src/merge/resources/ats/types/tag.py @@ -20,33 +20,33 @@ class Tag(UniversalBaseModel): Fetch from the `LIST Tags` endpoint and view the tags used within a company. """ - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The tag's name. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[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 diff --git a/src/merge/resources/ats/types/url.py b/src/merge/resources/ats/types/url.py index 5a8cc6d4..da3e90e2 100644 --- a/src/merge/resources/ats/types/url.py +++ b/src/merge/resources/ats/types/url.py @@ -21,22 +21,22 @@ class Url(UniversalBaseModel): Fetch from the `GET Candidate` endpoint and view their website urls. """ - created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - value: typing.Optional[str] = pydantic.Field() + value: typing.Optional[str] = pydantic.Field(default=None) """ The site's url. """ - url_type: typing.Optional[UrlUrlType] = pydantic.Field() + url_type: typing.Optional[UrlUrlType] = pydantic.Field(default=None) """ The type of site. @@ -49,7 +49,7 @@ class Url(UniversalBaseModel): - `JOB_POSTING` - JOB_POSTING """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ diff --git a/src/merge/resources/ats/types/url_request.py b/src/merge/resources/ats/types/url_request.py index af2e50e9..144db20e 100644 --- a/src/merge/resources/ats/types/url_request.py +++ b/src/merge/resources/ats/types/url_request.py @@ -20,12 +20,12 @@ class UrlRequest(UniversalBaseModel): Fetch from the `GET Candidate` endpoint and view their website urls. """ - value: typing.Optional[str] = pydantic.Field() + value: typing.Optional[str] = pydantic.Field(default=None) """ The site's url. """ - url_type: typing.Optional[UrlRequestUrlType] = pydantic.Field() + url_type: typing.Optional[UrlRequestUrlType] = pydantic.Field(default=None) """ The type of site. @@ -38,8 +38,8 @@ class UrlRequest(UniversalBaseModel): - `JOB_POSTING` - JOB_POSTING """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ats/types/warning_validation_problem.py b/src/merge/resources/ats/types/warning_validation_problem.py index d508bb6d..140199ca 100644 --- a/src/merge/resources/ats/types/warning_validation_problem.py +++ b/src/merge/resources/ats/types/warning_validation_problem.py @@ -8,7 +8,7 @@ class WarningValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/ats/types/webhook_receiver.py b/src/merge/resources/ats/types/webhook_receiver.py index e8cd17aa..ac8573be 100644 --- a/src/merge/resources/ats/types/webhook_receiver.py +++ b/src/merge/resources/ats/types/webhook_receiver.py @@ -9,7 +9,7 @@ class WebhookReceiver(UniversalBaseModel): event: str is_active: bool - key: typing.Optional[str] + 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 diff --git a/src/merge/resources/crm/types/account.py b/src/merge/resources/crm/types/account.py index ea257151..132b2c6d 100644 --- a/src/merge/resources/crm/types/account.py +++ b/src/merge/resources/crm/types/account.py @@ -25,77 +25,77 @@ class Account(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - owner: typing.Optional[AccountOwner] = pydantic.Field() + owner: typing.Optional[AccountOwner] = pydantic.Field(default=None) """ The account's owner. """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The account's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The account's description. """ - industry: typing.Optional[str] = pydantic.Field() + industry: typing.Optional[str] = pydantic.Field(default=None) """ The account's industry. """ - website: typing.Optional[str] = pydantic.Field() + website: typing.Optional[str] = pydantic.Field(default=None) """ The account's website. """ - number_of_employees: typing.Optional[int] = pydantic.Field() + number_of_employees: typing.Optional[int] = pydantic.Field(default=None) """ The account's number of employees. """ - addresses: typing.Optional[typing.List[Address]] - phone_numbers: typing.Optional[typing.List[PhoneNumber]] - last_activity_at: typing.Optional[dt.datetime] = pydantic.Field() + addresses: typing.Optional[typing.List[Address]] = None + phone_numbers: typing.Optional[typing.List[PhoneNumber]] = None + last_activity_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The last date (either most recent or furthest in the future) of when an activity occurs in an account. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the CRM system account data was last modified by a user with a login. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's account was created. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/account_details.py b/src/merge/resources/crm/types/account_details.py index dc91a6f3..aaf3c5e4 100644 --- a/src/merge/resources/crm/types/account_details.py +++ b/src/merge/resources/crm/types/account_details.py @@ -9,22 +9,22 @@ class AccountDetails(UniversalBaseModel): - id: typing.Optional[str] - integration: typing.Optional[str] - integration_slug: typing.Optional[str] - category: typing.Optional[CategoryEnum] - end_user_origin_id: typing.Optional[str] - end_user_organization_name: typing.Optional[str] - end_user_email_address: typing.Optional[str] - status: typing.Optional[str] - webhook_listener_url: typing.Optional[str] - is_duplicate: typing.Optional[bool] = pydantic.Field() + id: typing.Optional[str] = None + integration: typing.Optional[str] = None + integration_slug: typing.Optional[str] = None + category: typing.Optional[CategoryEnum] = None + end_user_origin_id: typing.Optional[str] = None + end_user_organization_name: typing.Optional[str] = None + end_user_email_address: typing.Optional[str] = None + status: typing.Optional[str] = None + webhook_listener_url: typing.Optional[str] = None + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - account_type: typing.Optional[str] - completed_at: typing.Optional[dt.datetime] = pydantic.Field() + account_type: typing.Optional[str] = None + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which account completes the linking flow. """ diff --git a/src/merge/resources/crm/types/account_details_and_actions.py b/src/merge/resources/crm/types/account_details_and_actions.py index 30e78b61..4c96905f 100644 --- a/src/merge/resources/crm/types/account_details_and_actions.py +++ b/src/merge/resources/crm/types/account_details_and_actions.py @@ -24,24 +24,24 @@ class AccountDetailsAndActions(UniversalBaseModel): """ id: str - category: typing.Optional[CategoryEnum] + category: typing.Optional[CategoryEnum] = None status: AccountDetailsAndActionsStatusEnum - status_detail: typing.Optional[str] - end_user_origin_id: typing.Optional[str] + status_detail: typing.Optional[str] = None + end_user_origin_id: typing.Optional[str] = None end_user_organization_name: str end_user_email_address: str - subdomain: typing.Optional[str] = pydantic.Field() + subdomain: typing.Optional[str] = pydantic.Field(default=None) """ The tenant or domain the customer has provided access to. """ webhook_listener_url: str - is_duplicate: typing.Optional[bool] = pydantic.Field() + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - integration: typing.Optional[AccountDetailsAndActionsIntegration] + integration: typing.Optional[AccountDetailsAndActionsIntegration] = None account_type: str completed_at: dt.datetime diff --git a/src/merge/resources/crm/types/account_details_and_actions_integration.py b/src/merge/resources/crm/types/account_details_and_actions_integration.py index 5779ac5b..8e47dbc4 100644 --- a/src/merge/resources/crm/types/account_details_and_actions_integration.py +++ b/src/merge/resources/crm/types/account_details_and_actions_integration.py @@ -11,12 +11,12 @@ class AccountDetailsAndActionsIntegration(UniversalBaseModel): name: str categories: typing.List[CategoriesEnum] - image: typing.Optional[str] - square_image: typing.Optional[str] + image: typing.Optional[str] = None + square_image: typing.Optional[str] = None color: str slug: str passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/crm/types/account_integration.py b/src/merge/resources/crm/types/account_integration.py index 2d18dedb..1dad1594 100644 --- a/src/merge/resources/crm/types/account_integration.py +++ b/src/merge/resources/crm/types/account_integration.py @@ -13,45 +13,45 @@ class AccountIntegration(UniversalBaseModel): Company name. """ - abbreviated_name: typing.Optional[str] = pydantic.Field() + abbreviated_name: typing.Optional[str] = pydantic.Field(default=None) """ Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).

Example: Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors) """ - categories: typing.Optional[typing.List[CategoriesEnum]] = pydantic.Field() + 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() + image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in rectangular shape. """ - square_image: typing.Optional[str] = pydantic.Field() + square_image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in square shape. """ - color: typing.Optional[str] = pydantic.Field() + 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] + slug: typing.Optional[str] = None api_endpoints_to_documentation_urls: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = ( - pydantic.Field() + 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() + 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() + 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. """ diff --git a/src/merge/resources/crm/types/account_request.py b/src/merge/resources/crm/types/account_request.py index 08e0235d..ea7ec61e 100644 --- a/src/merge/resources/crm/types/account_request.py +++ b/src/merge/resources/crm/types/account_request.py @@ -23,45 +23,45 @@ class AccountRequest(UniversalBaseModel): TODO """ - owner: typing.Optional[AccountRequestOwner] = pydantic.Field() + owner: typing.Optional[AccountRequestOwner] = pydantic.Field(default=None) """ The account's owner. """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The account's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The account's description. """ - industry: typing.Optional[str] = pydantic.Field() + industry: typing.Optional[str] = pydantic.Field(default=None) """ The account's industry. """ - website: typing.Optional[str] = pydantic.Field() + website: typing.Optional[str] = pydantic.Field(default=None) """ The account's website. """ - number_of_employees: typing.Optional[int] = pydantic.Field() + number_of_employees: typing.Optional[int] = pydantic.Field(default=None) """ The account's number of employees. """ - addresses: typing.Optional[typing.List[AddressRequest]] - last_activity_at: typing.Optional[dt.datetime] = pydantic.Field() + addresses: typing.Optional[typing.List[AddressRequest]] = None + last_activity_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The last date (either most recent or furthest in the future) of when an activity occurs in an account. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/address.py b/src/merge/resources/crm/types/address.py index 4f315038..f05e2490 100644 --- a/src/merge/resources/crm/types/address.py +++ b/src/merge/resources/crm/types/address.py @@ -22,42 +22,42 @@ class Address(UniversalBaseModel): TODO """ - created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - street_1: typing.Optional[str] = pydantic.Field() + street_1: typing.Optional[str] = pydantic.Field(default=None) """ Line 1 of the address's street. """ - street_2: typing.Optional[str] = pydantic.Field() + street_2: typing.Optional[str] = pydantic.Field(default=None) """ Line 2 of the address's street. """ - city: typing.Optional[str] = pydantic.Field() + city: typing.Optional[str] = pydantic.Field(default=None) """ The address's city. """ - state: typing.Optional[str] = pydantic.Field() + state: typing.Optional[str] = pydantic.Field(default=None) """ The address's state. """ - postal_code: typing.Optional[str] = pydantic.Field() + postal_code: typing.Optional[str] = pydantic.Field(default=None) """ The address's postal code. """ - country: typing.Optional[AddressCountry] = pydantic.Field() + country: typing.Optional[AddressCountry] = pydantic.Field(default=None) """ The address's country. @@ -312,7 +312,7 @@ class Address(UniversalBaseModel): - `ZW` - Zimbabwe """ - address_type: typing.Optional[AddressAddressType] = pydantic.Field() + address_type: typing.Optional[AddressAddressType] = pydantic.Field(default=None) """ The address type. diff --git a/src/merge/resources/crm/types/address_request.py b/src/merge/resources/crm/types/address_request.py index 9b156d15..7afa9d5c 100644 --- a/src/merge/resources/crm/types/address_request.py +++ b/src/merge/resources/crm/types/address_request.py @@ -21,32 +21,32 @@ class AddressRequest(UniversalBaseModel): TODO """ - street_1: typing.Optional[str] = pydantic.Field() + street_1: typing.Optional[str] = pydantic.Field(default=None) """ Line 1 of the address's street. """ - street_2: typing.Optional[str] = pydantic.Field() + street_2: typing.Optional[str] = pydantic.Field(default=None) """ Line 2 of the address's street. """ - city: typing.Optional[str] = pydantic.Field() + city: typing.Optional[str] = pydantic.Field(default=None) """ The address's city. """ - state: typing.Optional[str] = pydantic.Field() + state: typing.Optional[str] = pydantic.Field(default=None) """ The address's state. """ - postal_code: typing.Optional[str] = pydantic.Field() + postal_code: typing.Optional[str] = pydantic.Field(default=None) """ The address's postal code. """ - country: typing.Optional[AddressRequestCountry] = pydantic.Field() + country: typing.Optional[AddressRequestCountry] = pydantic.Field(default=None) """ The address's country. @@ -301,7 +301,7 @@ class AddressRequest(UniversalBaseModel): - `ZW` - Zimbabwe """ - address_type: typing.Optional[AddressRequestAddressType] = pydantic.Field() + address_type: typing.Optional[AddressRequestAddressType] = pydantic.Field(default=None) """ The address type. @@ -309,8 +309,8 @@ class AddressRequest(UniversalBaseModel): - `SHIPPING` - SHIPPING """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/crm/types/advanced_metadata.py b/src/merge/resources/crm/types/advanced_metadata.py index 6287a842..e570d69f 100644 --- a/src/merge/resources/crm/types/advanced_metadata.py +++ b/src/merge/resources/crm/types/advanced_metadata.py @@ -8,11 +8,11 @@ class AdvancedMetadata(UniversalBaseModel): id: str - display_name: typing.Optional[str] - description: typing.Optional[str] - is_required: typing.Optional[bool] - is_custom: typing.Optional[bool] - field_choices: typing.Optional[typing.List[typing.Optional[typing.Any]]] + 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 diff --git a/src/merge/resources/crm/types/association.py b/src/merge/resources/crm/types/association.py index 73ed1303..1afa6023 100644 --- a/src/merge/resources/crm/types/association.py +++ b/src/merge/resources/crm/types/association.py @@ -21,19 +21,19 @@ class Association(UniversalBaseModel): TODO """ - created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - source_object: typing.Optional[str] - target_object: typing.Optional[str] - association_type: typing.Optional[AssociationAssociationType] = pydantic.Field() + source_object: typing.Optional[str] = None + target_object: typing.Optional[str] = None + association_type: typing.Optional[AssociationAssociationType] = pydantic.Field(default=None) """ The association type the association belongs to. """ diff --git a/src/merge/resources/crm/types/association_sub_type.py b/src/merge/resources/crm/types/association_sub_type.py index 9a0b34c6..dbf77660 100644 --- a/src/merge/resources/crm/types/association_sub_type.py +++ b/src/merge/resources/crm/types/association_sub_type.py @@ -8,18 +8,18 @@ class AssociationSubType(UniversalBaseModel): - id: typing.Optional[str] - created_at: typing.Optional[dt.datetime] = pydantic.Field() + id: typing.Optional[str] = None + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - origin_type: typing.Optional[str] + origin_type: typing.Optional[str] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/association_type.py b/src/merge/resources/crm/types/association_type.py index e3939e0b..ceb1747a 100644 --- a/src/merge/resources/crm/types/association_type.py +++ b/src/merge/resources/crm/types/association_type.py @@ -22,32 +22,32 @@ class AssociationType(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - source_object_class: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field() + source_object_class: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None) """ The class of the source object (Custom Object or Common Model) for the association type. """ - target_object_classes: typing.Optional[typing.List[AssociationSubType]] - remote_key_name: typing.Optional[str] - display_name: typing.Optional[str] - cardinality: typing.Optional[AssociationTypeCardinality] - is_required: typing.Optional[bool] + target_object_classes: typing.Optional[typing.List[AssociationSubType]] = None + remote_key_name: typing.Optional[str] = None + display_name: typing.Optional[str] = None + cardinality: typing.Optional[AssociationTypeCardinality] = None + is_required: typing.Optional[bool] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/association_type_request_request.py b/src/merge/resources/crm/types/association_type_request_request.py index c1607e12..5f442927 100644 --- a/src/merge/resources/crm/types/association_type_request_request.py +++ b/src/merge/resources/crm/types/association_type_request_request.py @@ -12,9 +12,9 @@ class AssociationTypeRequestRequest(UniversalBaseModel): source_object_class: ObjectClassDescriptionRequest target_object_classes: typing.List[ObjectClassDescriptionRequest] remote_key_name: str - display_name: typing.Optional[str] - cardinality: typing.Optional[CardinalityEnum] - is_required: typing.Optional[bool] + display_name: typing.Optional[str] = None + cardinality: typing.Optional[CardinalityEnum] = None + is_required: typing.Optional[bool] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/audit_log_event.py b/src/merge/resources/crm/types/audit_log_event.py index b57101fc..1c32586b 100644 --- a/src/merge/resources/crm/types/audit_log_event.py +++ b/src/merge/resources/crm/types/audit_log_event.py @@ -10,13 +10,13 @@ class AuditLogEvent(UniversalBaseModel): - id: typing.Optional[str] - user_name: typing.Optional[str] = pydantic.Field() + 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() + user_email: typing.Optional[str] = pydantic.Field(default=None) """ The User's email at the time of this Event occurring. """ @@ -79,7 +79,7 @@ class AuditLogEvent(UniversalBaseModel): """ event_description: str - created_at: typing.Optional[dt.datetime] + 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 diff --git a/src/merge/resources/crm/types/available_actions.py b/src/merge/resources/crm/types/available_actions.py index 5f164db6..57cee06d 100644 --- a/src/merge/resources/crm/types/available_actions.py +++ b/src/merge/resources/crm/types/available_actions.py @@ -23,7 +23,7 @@ class AvailableActions(UniversalBaseModel): integration: AccountIntegration passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/crm/types/contact.py b/src/merge/resources/crm/types/contact.py index d90b3381..730c7463 100644 --- a/src/merge/resources/crm/types/contact.py +++ b/src/merge/resources/crm/types/contact.py @@ -27,63 +27,63 @@ class Contact(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The contact's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The contact's last name. """ - account: typing.Optional[ContactAccount] = pydantic.Field() + account: typing.Optional[ContactAccount] = pydantic.Field(default=None) """ The contact's account. """ - owner: typing.Optional[ContactOwner] = pydantic.Field() + owner: typing.Optional[ContactOwner] = pydantic.Field(default=None) """ The contact's owner. """ - addresses: typing.Optional[typing.List[Address]] - email_addresses: typing.Optional[typing.List[EmailAddress]] - phone_numbers: typing.Optional[typing.List[PhoneNumber]] - last_activity_at: typing.Optional[dt.datetime] = pydantic.Field() + addresses: typing.Optional[typing.List[Address]] = None + email_addresses: typing.Optional[typing.List[EmailAddress]] = None + phone_numbers: typing.Optional[typing.List[PhoneNumber]] = None + last_activity_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the contact's last activity occurred. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's contact was created. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/contact_request.py b/src/merge/resources/crm/types/contact_request.py index 82ec878f..c9f0c229 100644 --- a/src/merge/resources/crm/types/contact_request.py +++ b/src/merge/resources/crm/types/contact_request.py @@ -26,37 +26,37 @@ class ContactRequest(UniversalBaseModel): TODO """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The contact's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The contact's last name. """ - account: typing.Optional[ContactRequestAccount] = pydantic.Field() + account: typing.Optional[ContactRequestAccount] = pydantic.Field(default=None) """ The contact's account. """ - owner: typing.Optional[ContactRequestOwner] = pydantic.Field() + owner: typing.Optional[ContactRequestOwner] = pydantic.Field(default=None) """ The contact's owner. """ - addresses: typing.Optional[typing.List[AddressRequest]] - email_addresses: typing.Optional[typing.List[EmailAddressRequest]] - phone_numbers: typing.Optional[typing.List[PhoneNumberRequest]] - last_activity_at: typing.Optional[dt.datetime] = pydantic.Field() + addresses: typing.Optional[typing.List[AddressRequest]] = None + email_addresses: typing.Optional[typing.List[EmailAddressRequest]] = None + phone_numbers: typing.Optional[typing.List[PhoneNumberRequest]] = None + last_activity_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the contact's last activity occurred. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/crm_account_response.py b/src/merge/resources/crm/types/crm_account_response.py index 659b5c83..77ddd2cc 100644 --- a/src/merge/resources/crm/types/crm_account_response.py +++ b/src/merge/resources/crm/types/crm_account_response.py @@ -14,7 +14,7 @@ class CrmAccountResponse(UniversalBaseModel): model: Account warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/crm/types/crm_association_type_response.py b/src/merge/resources/crm/types/crm_association_type_response.py index 662f14f3..d740e368 100644 --- a/src/merge/resources/crm/types/crm_association_type_response.py +++ b/src/merge/resources/crm/types/crm_association_type_response.py @@ -14,7 +14,7 @@ class CrmAssociationTypeResponse(UniversalBaseModel): model: AssociationType warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/crm/types/crm_contact_response.py b/src/merge/resources/crm/types/crm_contact_response.py index b684b406..73c3a5fc 100644 --- a/src/merge/resources/crm/types/crm_contact_response.py +++ b/src/merge/resources/crm/types/crm_contact_response.py @@ -14,7 +14,7 @@ class CrmContactResponse(UniversalBaseModel): model: Contact warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/crm/types/crm_custom_object_response.py b/src/merge/resources/crm/types/crm_custom_object_response.py index cac5d642..fa3649e6 100644 --- a/src/merge/resources/crm/types/crm_custom_object_response.py +++ b/src/merge/resources/crm/types/crm_custom_object_response.py @@ -14,7 +14,7 @@ class CrmCustomObjectResponse(UniversalBaseModel): model: CustomObject warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/crm/types/custom_object.py b/src/merge/resources/crm/types/custom_object.py index 1a637020..49d9e453 100644 --- a/src/merge/resources/crm/types/custom_object.py +++ b/src/merge/resources/crm/types/custom_object.py @@ -21,33 +21,33 @@ class CustomObject(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - object_class: typing.Optional[str] = pydantic.Field() + object_class: typing.Optional[str] = pydantic.Field(default=None) """ The custom object class the custom object record belongs to. """ - fields: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field() + fields: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None) """ The fields and values contained within the custom object record. """ - remote_fields: typing.Optional[typing.List[RemoteField]] + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/custom_object_class.py b/src/merge/resources/crm/types/custom_object_class.py index d837c78f..90ccd6f1 100644 --- a/src/merge/resources/crm/types/custom_object_class.py +++ b/src/merge/resources/crm/types/custom_object_class.py @@ -21,31 +21,33 @@ class CustomObjectClass(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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] - modified_at: typing.Optional[dt.datetime] - name: typing.Optional[str] = pydantic.Field() + created_at: typing.Optional[dt.datetime] = None + modified_at: typing.Optional[dt.datetime] = None + name: typing.Optional[str] = pydantic.Field(default=None) """ The custom object class's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The custom object class's description. """ - labels: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field() + labels: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None) """ The custom object class's singular and plural labels. """ - fields: typing.Optional[typing.List[RemoteFieldClassForCustomObjectClass]] - association_types: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field() + fields: typing.Optional[typing.List[RemoteFieldClassForCustomObjectClass]] = None + association_types: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field( + default=None + ) """ The types of associations with other models that the custom object class can have. """ diff --git a/src/merge/resources/crm/types/data_passthrough_request.py b/src/merge/resources/crm/types/data_passthrough_request.py index f2718105..2b0595cf 100644 --- a/src/merge/resources/crm/types/data_passthrough_request.py +++ b/src/merge/resources/crm/types/data_passthrough_request.py @@ -28,28 +28,28 @@ class DataPassthroughRequest(UniversalBaseModel): The path of the request in the third party's platform. """ - base_url_override: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + 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[RequestFormatEnum] - normalize_response: typing.Optional[bool] = pydantic.Field() + request_format: typing.Optional[RequestFormatEnum] = 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`. """ diff --git a/src/merge/resources/crm/types/email_address.py b/src/merge/resources/crm/types/email_address.py index 55aab508..1bfee446 100644 --- a/src/merge/resources/crm/types/email_address.py +++ b/src/merge/resources/crm/types/email_address.py @@ -20,22 +20,22 @@ class EmailAddress(UniversalBaseModel): Fetch from the `GET Contact` endpoint and view their email addresses. """ - created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + 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() + email_address: typing.Optional[str] = pydantic.Field(default=None) """ The email address. """ - email_address_type: typing.Optional[str] = pydantic.Field() + email_address_type: typing.Optional[str] = pydantic.Field(default=None) """ The email address's type. """ diff --git a/src/merge/resources/crm/types/email_address_request.py b/src/merge/resources/crm/types/email_address_request.py index 0bf4df19..91a6fca7 100644 --- a/src/merge/resources/crm/types/email_address_request.py +++ b/src/merge/resources/crm/types/email_address_request.py @@ -19,18 +19,18 @@ class EmailAddressRequest(UniversalBaseModel): Fetch from the `GET Contact` endpoint and view their email addresses. """ - email_address: typing.Optional[str] = pydantic.Field() + email_address: typing.Optional[str] = pydantic.Field(default=None) """ The email address. """ - email_address_type: typing.Optional[str] = pydantic.Field() + email_address_type: typing.Optional[str] = pydantic.Field(default=None) """ The email address's type. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/crm/types/engagement.py b/src/merge/resources/crm/types/engagement.py index 5263f7ba..de892f0a 100644 --- a/src/merge/resources/crm/types/engagement.py +++ b/src/merge/resources/crm/types/engagement.py @@ -27,38 +27,38 @@ class Engagement(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - owner: typing.Optional[EngagementOwner] = pydantic.Field() + owner: typing.Optional[EngagementOwner] = pydantic.Field(default=None) """ The engagement's owner. """ - content: typing.Optional[str] = pydantic.Field() + content: typing.Optional[str] = pydantic.Field(default=None) """ The engagement's content. """ - subject: typing.Optional[str] = pydantic.Field() + subject: typing.Optional[str] = pydantic.Field(default=None) """ The engagement's subject. """ - direction: typing.Optional[EngagementDirection] = pydantic.Field() + direction: typing.Optional[EngagementDirection] = pydantic.Field(default=None) """ The engagement's direction. @@ -66,35 +66,35 @@ class Engagement(UniversalBaseModel): - `OUTBOUND` - OUTBOUND """ - engagement_type: typing.Optional[EngagementEngagementType] = pydantic.Field() + engagement_type: typing.Optional[EngagementEngagementType] = pydantic.Field(default=None) """ The engagement type of the engagement. """ - start_time: typing.Optional[dt.datetime] = pydantic.Field() + start_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which the engagement started. """ - end_time: typing.Optional[dt.datetime] = pydantic.Field() + end_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which the engagement ended. """ - account: typing.Optional[EngagementAccount] = pydantic.Field() + account: typing.Optional[EngagementAccount] = pydantic.Field(default=None) """ The account of the engagement. """ - contacts: typing.Optional[typing.List[typing.Optional[EngagementContactsItem]]] - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + contacts: typing.Optional[typing.List[typing.Optional[EngagementContactsItem]]] = 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/engagement_request.py b/src/merge/resources/crm/types/engagement_request.py index e65bd1f1..c60502a4 100644 --- a/src/merge/resources/crm/types/engagement_request.py +++ b/src/merge/resources/crm/types/engagement_request.py @@ -26,22 +26,22 @@ class EngagementRequest(UniversalBaseModel): TODO """ - owner: typing.Optional[EngagementRequestOwner] = pydantic.Field() + owner: typing.Optional[EngagementRequestOwner] = pydantic.Field(default=None) """ The engagement's owner. """ - content: typing.Optional[str] = pydantic.Field() + content: typing.Optional[str] = pydantic.Field(default=None) """ The engagement's content. """ - subject: typing.Optional[str] = pydantic.Field() + subject: typing.Optional[str] = pydantic.Field(default=None) """ The engagement's subject. """ - direction: typing.Optional[EngagementRequestDirection] = pydantic.Field() + direction: typing.Optional[EngagementRequestDirection] = pydantic.Field(default=None) """ The engagement's direction. @@ -49,30 +49,30 @@ class EngagementRequest(UniversalBaseModel): - `OUTBOUND` - OUTBOUND """ - engagement_type: typing.Optional[EngagementRequestEngagementType] = pydantic.Field() + engagement_type: typing.Optional[EngagementRequestEngagementType] = pydantic.Field(default=None) """ The engagement type of the engagement. """ - start_time: typing.Optional[dt.datetime] = pydantic.Field() + start_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which the engagement started. """ - end_time: typing.Optional[dt.datetime] = pydantic.Field() + end_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which the engagement ended. """ - account: typing.Optional[EngagementRequestAccount] = pydantic.Field() + account: typing.Optional[EngagementRequestAccount] = pydantic.Field(default=None) """ The account of the engagement. """ - contacts: typing.Optional[typing.List[typing.Optional[EngagementRequestContactsItem]]] - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + contacts: typing.Optional[typing.List[typing.Optional[EngagementRequestContactsItem]]] = None + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/engagement_response.py b/src/merge/resources/crm/types/engagement_response.py index ac42b08a..eb4aa52b 100644 --- a/src/merge/resources/crm/types/engagement_response.py +++ b/src/merge/resources/crm/types/engagement_response.py @@ -14,7 +14,7 @@ class EngagementResponse(UniversalBaseModel): model: Engagement warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/crm/types/engagement_type.py b/src/merge/resources/crm/types/engagement_type.py index a5497cbd..e40693bf 100644 --- a/src/merge/resources/crm/types/engagement_type.py +++ b/src/merge/resources/crm/types/engagement_type.py @@ -22,23 +22,23 @@ class EngagementType(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - activity_type: typing.Optional[EngagementTypeActivityType] = pydantic.Field() + activity_type: typing.Optional[EngagementTypeActivityType] = pydantic.Field(default=None) """ The engagement type's activity type. @@ -47,12 +47,12 @@ class EngagementType(UniversalBaseModel): - `EMAIL` - EMAIL """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The engagement type's name. """ - remote_fields: typing.Optional[typing.List[RemoteField]] + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/error_validation_problem.py b/src/merge/resources/crm/types/error_validation_problem.py index 58ea87e6..91565918 100644 --- a/src/merge/resources/crm/types/error_validation_problem.py +++ b/src/merge/resources/crm/types/error_validation_problem.py @@ -8,7 +8,7 @@ class ErrorValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/crm/types/external_target_field_api.py b/src/merge/resources/crm/types/external_target_field_api.py index 18988d44..1ed19a99 100644 --- a/src/merge/resources/crm/types/external_target_field_api.py +++ b/src/merge/resources/crm/types/external_target_field_api.py @@ -7,9 +7,9 @@ class ExternalTargetFieldApi(UniversalBaseModel): - name: typing.Optional[str] - description: typing.Optional[str] - is_mapped: typing.Optional[str] + 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 diff --git a/src/merge/resources/crm/types/external_target_field_api_response.py b/src/merge/resources/crm/types/external_target_field_api_response.py index 3f54e5de..b6180b30 100644 --- a/src/merge/resources/crm/types/external_target_field_api_response.py +++ b/src/merge/resources/crm/types/external_target_field_api_response.py @@ -8,15 +8,17 @@ class ExternalTargetFieldApiResponse(UniversalBaseModel): - account: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Account") - contact: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Contact") - lead: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Lead") - note: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Note") - opportunity: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Opportunity") - stage: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Stage") - user: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="User") - task: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Task") - engagement: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Engagement") + account: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Account", default=None) + contact: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Contact", default=None) + lead: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Lead", default=None) + note: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Note", default=None) + opportunity: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="Opportunity", default=None + ) + stage: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Stage", default=None) + user: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="User", default=None) + task: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Task", default=None) + engagement: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Engagement", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/field_mapping_api_instance.py b/src/merge/resources/crm/types/field_mapping_api_instance.py index ef4d9c48..1cc2f4a2 100644 --- a/src/merge/resources/crm/types/field_mapping_api_instance.py +++ b/src/merge/resources/crm/types/field_mapping_api_instance.py @@ -9,10 +9,10 @@ class FieldMappingApiInstance(UniversalBaseModel): - id: typing.Optional[str] - is_integration_wide: typing.Optional[bool] - target_field: typing.Optional[FieldMappingApiInstanceTargetField] - remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] + id: typing.Optional[str] = None + is_integration_wide: typing.Optional[bool] = None + target_field: typing.Optional[FieldMappingApiInstanceTargetField] = None + remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py b/src/merge/resources/crm/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py index 14c37c76..9eeb4fbf 100644 --- a/src/merge/resources/crm/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py +++ b/src/merge/resources/crm/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py @@ -7,9 +7,9 @@ class FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo(UniversalBaseModel): - method: typing.Optional[str] - url_path: typing.Optional[str] - field_traversal_path: typing.Optional[typing.List[str]] + 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 diff --git a/src/merge/resources/crm/types/field_mapping_api_instance_response.py b/src/merge/resources/crm/types/field_mapping_api_instance_response.py index 9cbff6e6..4df5ed60 100644 --- a/src/merge/resources/crm/types/field_mapping_api_instance_response.py +++ b/src/merge/resources/crm/types/field_mapping_api_instance_response.py @@ -8,15 +8,17 @@ class FieldMappingApiInstanceResponse(UniversalBaseModel): - account: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Account") - contact: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Contact") - lead: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Lead") - note: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Note") - opportunity: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Opportunity") - stage: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Stage") - user: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="User") - task: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Task") - engagement: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Engagement") + account: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Account", default=None) + contact: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Contact", default=None) + lead: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Lead", default=None) + note: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Note", default=None) + opportunity: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="Opportunity", default=None + ) + stage: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Stage", default=None) + user: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="User", default=None) + task: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Task", default=None) + engagement: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Engagement", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/field_mapping_instance_response.py b/src/merge/resources/crm/types/field_mapping_instance_response.py index a56aeb93..2123f4d3 100644 --- a/src/merge/resources/crm/types/field_mapping_instance_response.py +++ b/src/merge/resources/crm/types/field_mapping_instance_response.py @@ -14,7 +14,7 @@ class FieldMappingInstanceResponse(UniversalBaseModel): model: FieldMappingApiInstance warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/crm/types/field_permission_deserializer.py b/src/merge/resources/crm/types/field_permission_deserializer.py index 9670537a..ea7cc235 100644 --- a/src/merge/resources/crm/types/field_permission_deserializer.py +++ b/src/merge/resources/crm/types/field_permission_deserializer.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializer(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/crm/types/field_permission_deserializer_request.py b/src/merge/resources/crm/types/field_permission_deserializer_request.py index 04e14608..e5617ad6 100644 --- a/src/merge/resources/crm/types/field_permission_deserializer_request.py +++ b/src/merge/resources/crm/types/field_permission_deserializer_request.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializerRequest(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/crm/types/ignore_common_model_request.py b/src/merge/resources/crm/types/ignore_common_model_request.py index c43672c1..70fc095f 100644 --- a/src/merge/resources/crm/types/ignore_common_model_request.py +++ b/src/merge/resources/crm/types/ignore_common_model_request.py @@ -9,7 +9,7 @@ class IgnoreCommonModelRequest(UniversalBaseModel): reason: ReasonEnum - message: typing.Optional[str] + message: typing.Optional[str] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/individual_common_model_scope_deserializer.py b/src/merge/resources/crm/types/individual_common_model_scope_deserializer.py index 122df11c..70704314 100644 --- a/src/merge/resources/crm/types/individual_common_model_scope_deserializer.py +++ b/src/merge/resources/crm/types/individual_common_model_scope_deserializer.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializer(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializer]] - field_permissions: typing.Optional[FieldPermissionDeserializer] + 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 diff --git a/src/merge/resources/crm/types/individual_common_model_scope_deserializer_request.py b/src/merge/resources/crm/types/individual_common_model_scope_deserializer_request.py index a1a80902..d42dd53a 100644 --- a/src/merge/resources/crm/types/individual_common_model_scope_deserializer_request.py +++ b/src/merge/resources/crm/types/individual_common_model_scope_deserializer_request.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializerRequest(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializerRequest]] - field_permissions: typing.Optional[FieldPermissionDeserializerRequest] + 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 diff --git a/src/merge/resources/crm/types/issue.py b/src/merge/resources/crm/types/issue.py index 5a584515..7adc1f31 100644 --- a/src/merge/resources/crm/types/issue.py +++ b/src/merge/resources/crm/types/issue.py @@ -9,8 +9,8 @@ class Issue(UniversalBaseModel): - id: typing.Optional[str] - status: typing.Optional[IssueStatus] = pydantic.Field() + id: typing.Optional[str] = None + status: typing.Optional[IssueStatus] = pydantic.Field(default=None) """ Status of the issue. Options: ('ONGOING', 'RESOLVED') @@ -19,11 +19,11 @@ class Issue(UniversalBaseModel): """ error_description: str - end_user: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - first_incident_time: typing.Optional[dt.datetime] - last_incident_time: typing.Optional[dt.datetime] - is_muted: typing.Optional[bool] - error_details: typing.Optional[typing.List[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 diff --git a/src/merge/resources/crm/types/item_schema.py b/src/merge/resources/crm/types/item_schema.py index cfe24209..7f82ffbb 100644 --- a/src/merge/resources/crm/types/item_schema.py +++ b/src/merge/resources/crm/types/item_schema.py @@ -9,9 +9,9 @@ class ItemSchema(UniversalBaseModel): - item_type: typing.Optional[ItemTypeEnum] - item_format: typing.Optional[ItemFormatEnum] - item_choices: typing.Optional[typing.List[str]] + item_type: typing.Optional[ItemTypeEnum] = None + item_format: typing.Optional[ItemFormatEnum] = None + item_choices: 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 diff --git a/src/merge/resources/crm/types/lead.py b/src/merge/resources/crm/types/lead.py index ff650413..dde0c190 100644 --- a/src/merge/resources/crm/types/lead.py +++ b/src/merge/resources/crm/types/lead.py @@ -28,88 +28,88 @@ class Lead(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - owner: typing.Optional[LeadOwner] = pydantic.Field() + owner: typing.Optional[LeadOwner] = pydantic.Field(default=None) """ The lead's owner. """ - lead_source: typing.Optional[str] = pydantic.Field() + lead_source: typing.Optional[str] = pydantic.Field(default=None) """ The lead's source. """ - title: typing.Optional[str] = pydantic.Field() + title: typing.Optional[str] = pydantic.Field(default=None) """ The lead's title. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The lead's company. """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The lead's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The lead's last name. """ - addresses: typing.Optional[typing.List[Address]] - email_addresses: typing.Optional[typing.List[EmailAddress]] - phone_numbers: typing.Optional[typing.List[PhoneNumber]] - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + addresses: typing.Optional[typing.List[Address]] = None + email_addresses: typing.Optional[typing.List[EmailAddress]] = None + phone_numbers: typing.Optional[typing.List[PhoneNumber]] = None + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's lead was updated. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's lead was created. """ - converted_date: typing.Optional[dt.datetime] = pydantic.Field() + converted_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the lead was converted. """ - converted_contact: typing.Optional[LeadConvertedContact] = pydantic.Field() + converted_contact: typing.Optional[LeadConvertedContact] = pydantic.Field(default=None) """ The contact of the converted lead. """ - converted_account: typing.Optional[LeadConvertedAccount] = pydantic.Field() + converted_account: typing.Optional[LeadConvertedAccount] = pydantic.Field(default=None) """ The account of the converted lead. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/lead_request.py b/src/merge/resources/crm/types/lead_request.py index b8628b87..8a28194d 100644 --- a/src/merge/resources/crm/types/lead_request.py +++ b/src/merge/resources/crm/types/lead_request.py @@ -27,57 +27,57 @@ class LeadRequest(UniversalBaseModel): TODO """ - owner: typing.Optional[LeadRequestOwner] = pydantic.Field() + owner: typing.Optional[LeadRequestOwner] = pydantic.Field(default=None) """ The lead's owner. """ - lead_source: typing.Optional[str] = pydantic.Field() + lead_source: typing.Optional[str] = pydantic.Field(default=None) """ The lead's source. """ - title: typing.Optional[str] = pydantic.Field() + title: typing.Optional[str] = pydantic.Field(default=None) """ The lead's title. """ - company: typing.Optional[str] = pydantic.Field() + company: typing.Optional[str] = pydantic.Field(default=None) """ The lead's company. """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The lead's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The lead's last name. """ - addresses: typing.Optional[typing.List[AddressRequest]] - email_addresses: typing.Optional[typing.List[EmailAddressRequest]] - phone_numbers: typing.Optional[typing.List[PhoneNumberRequest]] - converted_date: typing.Optional[dt.datetime] = pydantic.Field() + addresses: typing.Optional[typing.List[AddressRequest]] = None + email_addresses: typing.Optional[typing.List[EmailAddressRequest]] = None + phone_numbers: typing.Optional[typing.List[PhoneNumberRequest]] = None + converted_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the lead was converted. """ - converted_contact: typing.Optional[LeadRequestConvertedContact] = pydantic.Field() + converted_contact: typing.Optional[LeadRequestConvertedContact] = pydantic.Field(default=None) """ The contact of the converted lead. """ - converted_account: typing.Optional[LeadRequestConvertedAccount] = pydantic.Field() + converted_account: typing.Optional[LeadRequestConvertedAccount] = pydantic.Field(default=None) """ The account of the converted lead. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/lead_response.py b/src/merge/resources/crm/types/lead_response.py index a8d60426..7b506053 100644 --- a/src/merge/resources/crm/types/lead_response.py +++ b/src/merge/resources/crm/types/lead_response.py @@ -14,7 +14,7 @@ class LeadResponse(UniversalBaseModel): model: Lead warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/crm/types/link_token.py b/src/merge/resources/crm/types/link_token.py index 1d25dddb..ac916d14 100644 --- a/src/merge/resources/crm/types/link_token.py +++ b/src/merge/resources/crm/types/link_token.py @@ -8,8 +8,8 @@ class LinkToken(UniversalBaseModel): link_token: str - integration_name: typing.Optional[str] - magic_link_url: typing.Optional[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 diff --git a/src/merge/resources/crm/types/meta_response.py b/src/merge/resources/crm/types/meta_response.py index 44e57fde..272535f0 100644 --- a/src/merge/resources/crm/types/meta_response.py +++ b/src/merge/resources/crm/types/meta_response.py @@ -9,8 +9,8 @@ class MetaResponse(UniversalBaseModel): request_schema: typing.Dict[str, typing.Optional[typing.Any]] - remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - status: typing.Optional[LinkedAccountStatus] + remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + status: typing.Optional[LinkedAccountStatus] = None has_conditional_params: bool has_required_linked_account_params: bool diff --git a/src/merge/resources/crm/types/model_permission_deserializer.py b/src/merge/resources/crm/types/model_permission_deserializer.py index b6d813e4..96f39e63 100644 --- a/src/merge/resources/crm/types/model_permission_deserializer.py +++ b/src/merge/resources/crm/types/model_permission_deserializer.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializer(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/crm/types/model_permission_deserializer_request.py b/src/merge/resources/crm/types/model_permission_deserializer_request.py index 5885627b..2619fb6a 100644 --- a/src/merge/resources/crm/types/model_permission_deserializer_request.py +++ b/src/merge/resources/crm/types/model_permission_deserializer_request.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializerRequest(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/crm/types/multipart_form_field_request.py b/src/merge/resources/crm/types/multipart_form_field_request.py index 80099016..507fa8c6 100644 --- a/src/merge/resources/crm/types/multipart_form_field_request.py +++ b/src/merge/resources/crm/types/multipart_form_field_request.py @@ -30,7 +30,7 @@ class MultipartFormFieldRequest(UniversalBaseModel): The data for the form field. """ - encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field() + encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field(default=None) """ The encoding of the value of `data`. Defaults to `RAW` if not defined. @@ -39,12 +39,12 @@ class MultipartFormFieldRequest(UniversalBaseModel): - `GZIP_BASE64` - GZIP_BASE64 """ - file_name: typing.Optional[str] = pydantic.Field() + 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() + content_type: typing.Optional[str] = pydantic.Field(default=None) """ The MIME type of the file, if the field is for a file. """ diff --git a/src/merge/resources/crm/types/note.py b/src/merge/resources/crm/types/note.py index f73f0e2f..196c65af 100644 --- a/src/merge/resources/crm/types/note.py +++ b/src/merge/resources/crm/types/note.py @@ -26,65 +26,65 @@ class Note(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - owner: typing.Optional[NoteOwner] = pydantic.Field() + owner: typing.Optional[NoteOwner] = pydantic.Field(default=None) """ The note's owner. """ - content: typing.Optional[str] = pydantic.Field() + content: typing.Optional[str] = pydantic.Field(default=None) """ The note's content. """ - contact: typing.Optional[NoteContact] = pydantic.Field() + contact: typing.Optional[NoteContact] = pydantic.Field(default=None) """ The note's contact. """ - account: typing.Optional[NoteAccount] = pydantic.Field() + account: typing.Optional[NoteAccount] = pydantic.Field(default=None) """ The note's account. """ - opportunity: typing.Optional[NoteOpportunity] = pydantic.Field() + opportunity: typing.Optional[NoteOpportunity] = pydantic.Field(default=None) """ The note's opportunity. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's lead was updated. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's lead was created. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/note_request.py b/src/merge/resources/crm/types/note_request.py index e783a748..6c723105 100644 --- a/src/merge/resources/crm/types/note_request.py +++ b/src/merge/resources/crm/types/note_request.py @@ -24,34 +24,34 @@ class NoteRequest(UniversalBaseModel): TODO """ - owner: typing.Optional[NoteRequestOwner] = pydantic.Field() + owner: typing.Optional[NoteRequestOwner] = pydantic.Field(default=None) """ The note's owner. """ - content: typing.Optional[str] = pydantic.Field() + content: typing.Optional[str] = pydantic.Field(default=None) """ The note's content. """ - contact: typing.Optional[NoteRequestContact] = pydantic.Field() + contact: typing.Optional[NoteRequestContact] = pydantic.Field(default=None) """ The note's contact. """ - account: typing.Optional[NoteRequestAccount] = pydantic.Field() + account: typing.Optional[NoteRequestAccount] = pydantic.Field(default=None) """ The note's account. """ - opportunity: typing.Optional[NoteRequestOpportunity] = pydantic.Field() + opportunity: typing.Optional[NoteRequestOpportunity] = pydantic.Field(default=None) """ The note's opportunity. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/note_response.py b/src/merge/resources/crm/types/note_response.py index bc76f3de..d6de4f12 100644 --- a/src/merge/resources/crm/types/note_response.py +++ b/src/merge/resources/crm/types/note_response.py @@ -14,7 +14,7 @@ class NoteResponse(UniversalBaseModel): model: Note warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/crm/types/opportunity.py b/src/merge/resources/crm/types/opportunity.py index 267275c2..4ce7768e 100644 --- a/src/merge/resources/crm/types/opportunity.py +++ b/src/merge/resources/crm/types/opportunity.py @@ -26,53 +26,53 @@ class Opportunity(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The opportunity's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The opportunity's description. """ - amount: typing.Optional[int] = pydantic.Field() + amount: typing.Optional[int] = pydantic.Field(default=None) """ The opportunity's amount. """ - owner: typing.Optional[OpportunityOwner] = pydantic.Field() + owner: typing.Optional[OpportunityOwner] = pydantic.Field(default=None) """ The opportunity's owner. """ - account: typing.Optional[OpportunityAccount] = pydantic.Field() + account: typing.Optional[OpportunityAccount] = pydantic.Field(default=None) """ The account of the opportunity. """ - stage: typing.Optional[OpportunityStage] = pydantic.Field() + stage: typing.Optional[OpportunityStage] = pydantic.Field(default=None) """ The stage of the opportunity. """ - status: typing.Optional[OpportunityStatus] = pydantic.Field() + status: typing.Optional[OpportunityStatus] = pydantic.Field(default=None) """ The opportunity's status. @@ -81,29 +81,29 @@ class Opportunity(UniversalBaseModel): - `LOST` - LOST """ - last_activity_at: typing.Optional[dt.datetime] = pydantic.Field() + last_activity_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the opportunity's last activity occurred. """ - close_date: typing.Optional[dt.datetime] = pydantic.Field() + close_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the opportunity was closed. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's opportunity was created. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/opportunity_request.py b/src/merge/resources/crm/types/opportunity_request.py index 96c5b16b..8dd1614e 100644 --- a/src/merge/resources/crm/types/opportunity_request.py +++ b/src/merge/resources/crm/types/opportunity_request.py @@ -25,37 +25,37 @@ class OpportunityRequest(UniversalBaseModel): TODO """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The opportunity's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The opportunity's description. """ - amount: typing.Optional[int] = pydantic.Field() + amount: typing.Optional[int] = pydantic.Field(default=None) """ The opportunity's amount. """ - owner: typing.Optional[OpportunityRequestOwner] = pydantic.Field() + owner: typing.Optional[OpportunityRequestOwner] = pydantic.Field(default=None) """ The opportunity's owner. """ - account: typing.Optional[OpportunityRequestAccount] = pydantic.Field() + account: typing.Optional[OpportunityRequestAccount] = pydantic.Field(default=None) """ The account of the opportunity. """ - stage: typing.Optional[OpportunityRequestStage] = pydantic.Field() + stage: typing.Optional[OpportunityRequestStage] = pydantic.Field(default=None) """ The stage of the opportunity. """ - status: typing.Optional[OpportunityRequestStatus] = pydantic.Field() + status: typing.Optional[OpportunityRequestStatus] = pydantic.Field(default=None) """ The opportunity's status. @@ -64,19 +64,19 @@ class OpportunityRequest(UniversalBaseModel): - `LOST` - LOST """ - last_activity_at: typing.Optional[dt.datetime] = pydantic.Field() + last_activity_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the opportunity's last activity occurred. """ - close_date: typing.Optional[dt.datetime] = pydantic.Field() + close_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the opportunity was closed. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/opportunity_response.py b/src/merge/resources/crm/types/opportunity_response.py index fcfe47fc..ed7add78 100644 --- a/src/merge/resources/crm/types/opportunity_response.py +++ b/src/merge/resources/crm/types/opportunity_response.py @@ -14,7 +14,7 @@ class OpportunityResponse(UniversalBaseModel): model: Opportunity warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/crm/types/paginated_account_details_and_actions_list.py b/src/merge/resources/crm/types/paginated_account_details_and_actions_list.py index a9128c76..00ceeda5 100644 --- a/src/merge/resources/crm/types/paginated_account_details_and_actions_list.py +++ b/src/merge/resources/crm/types/paginated_account_details_and_actions_list.py @@ -8,9 +8,9 @@ class PaginatedAccountDetailsAndActionsList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AccountDetailsAndActions]] + 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 diff --git a/src/merge/resources/crm/types/paginated_account_list.py b/src/merge/resources/crm/types/paginated_account_list.py index b49c8fba..dcabf6cb 100644 --- a/src/merge/resources/crm/types/paginated_account_list.py +++ b/src/merge/resources/crm/types/paginated_account_list.py @@ -8,9 +8,9 @@ class PaginatedAccountList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Account]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Account]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_association_list.py b/src/merge/resources/crm/types/paginated_association_list.py index 1ee397a4..899325fb 100644 --- a/src/merge/resources/crm/types/paginated_association_list.py +++ b/src/merge/resources/crm/types/paginated_association_list.py @@ -8,9 +8,9 @@ class PaginatedAssociationList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Association]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Association]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_association_type_list.py b/src/merge/resources/crm/types/paginated_association_type_list.py index 6c8726e3..4760f70c 100644 --- a/src/merge/resources/crm/types/paginated_association_type_list.py +++ b/src/merge/resources/crm/types/paginated_association_type_list.py @@ -8,9 +8,9 @@ class PaginatedAssociationTypeList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AssociationType]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[AssociationType]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_audit_log_event_list.py b/src/merge/resources/crm/types/paginated_audit_log_event_list.py index a50b7c75..450de68c 100644 --- a/src/merge/resources/crm/types/paginated_audit_log_event_list.py +++ b/src/merge/resources/crm/types/paginated_audit_log_event_list.py @@ -8,9 +8,9 @@ class PaginatedAuditLogEventList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AuditLogEvent]] + 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 diff --git a/src/merge/resources/crm/types/paginated_contact_list.py b/src/merge/resources/crm/types/paginated_contact_list.py index 07c47744..c711818a 100644 --- a/src/merge/resources/crm/types/paginated_contact_list.py +++ b/src/merge/resources/crm/types/paginated_contact_list.py @@ -8,9 +8,9 @@ class PaginatedContactList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Contact]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Contact]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_custom_object_class_list.py b/src/merge/resources/crm/types/paginated_custom_object_class_list.py index 2237c8e4..59c8d543 100644 --- a/src/merge/resources/crm/types/paginated_custom_object_class_list.py +++ b/src/merge/resources/crm/types/paginated_custom_object_class_list.py @@ -8,9 +8,9 @@ class PaginatedCustomObjectClassList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[CustomObjectClass]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[CustomObjectClass]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_custom_object_list.py b/src/merge/resources/crm/types/paginated_custom_object_list.py index 72b2af33..728f8936 100644 --- a/src/merge/resources/crm/types/paginated_custom_object_list.py +++ b/src/merge/resources/crm/types/paginated_custom_object_list.py @@ -8,9 +8,9 @@ class PaginatedCustomObjectList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[CustomObject]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[CustomObject]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_engagement_list.py b/src/merge/resources/crm/types/paginated_engagement_list.py index bd62a315..63af3e86 100644 --- a/src/merge/resources/crm/types/paginated_engagement_list.py +++ b/src/merge/resources/crm/types/paginated_engagement_list.py @@ -8,9 +8,9 @@ class PaginatedEngagementList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Engagement]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Engagement]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_engagement_type_list.py b/src/merge/resources/crm/types/paginated_engagement_type_list.py index d1515e2c..d851171f 100644 --- a/src/merge/resources/crm/types/paginated_engagement_type_list.py +++ b/src/merge/resources/crm/types/paginated_engagement_type_list.py @@ -8,9 +8,9 @@ class PaginatedEngagementTypeList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[EngagementType]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[EngagementType]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_issue_list.py b/src/merge/resources/crm/types/paginated_issue_list.py index 12b866d9..758e6dc3 100644 --- a/src/merge/resources/crm/types/paginated_issue_list.py +++ b/src/merge/resources/crm/types/paginated_issue_list.py @@ -8,9 +8,9 @@ class PaginatedIssueList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Issue]] + 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 diff --git a/src/merge/resources/crm/types/paginated_lead_list.py b/src/merge/resources/crm/types/paginated_lead_list.py index e91b2228..d5b12ba9 100644 --- a/src/merge/resources/crm/types/paginated_lead_list.py +++ b/src/merge/resources/crm/types/paginated_lead_list.py @@ -8,9 +8,9 @@ class PaginatedLeadList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Lead]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Lead]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_note_list.py b/src/merge/resources/crm/types/paginated_note_list.py index 560c64a3..a92c1e4c 100644 --- a/src/merge/resources/crm/types/paginated_note_list.py +++ b/src/merge/resources/crm/types/paginated_note_list.py @@ -8,9 +8,9 @@ class PaginatedNoteList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Note]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Note]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_opportunity_list.py b/src/merge/resources/crm/types/paginated_opportunity_list.py index 3c30e955..2d4e8b33 100644 --- a/src/merge/resources/crm/types/paginated_opportunity_list.py +++ b/src/merge/resources/crm/types/paginated_opportunity_list.py @@ -8,9 +8,9 @@ class PaginatedOpportunityList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Opportunity]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Opportunity]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_remote_field_class_list.py b/src/merge/resources/crm/types/paginated_remote_field_class_list.py index 1f51ab63..65c907cc 100644 --- a/src/merge/resources/crm/types/paginated_remote_field_class_list.py +++ b/src/merge/resources/crm/types/paginated_remote_field_class_list.py @@ -8,9 +8,9 @@ class PaginatedRemoteFieldClassList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[RemoteFieldClass]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[RemoteFieldClass]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_stage_list.py b/src/merge/resources/crm/types/paginated_stage_list.py index 3cde19f3..23f1304b 100644 --- a/src/merge/resources/crm/types/paginated_stage_list.py +++ b/src/merge/resources/crm/types/paginated_stage_list.py @@ -8,9 +8,9 @@ class PaginatedStageList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Stage]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Stage]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_sync_status_list.py b/src/merge/resources/crm/types/paginated_sync_status_list.py index f59f2c9a..f4f09ed1 100644 --- a/src/merge/resources/crm/types/paginated_sync_status_list.py +++ b/src/merge/resources/crm/types/paginated_sync_status_list.py @@ -8,9 +8,9 @@ class PaginatedSyncStatusList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[SyncStatus]] + 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 diff --git a/src/merge/resources/crm/types/paginated_task_list.py b/src/merge/resources/crm/types/paginated_task_list.py index d5bc07f4..de41b9e7 100644 --- a/src/merge/resources/crm/types/paginated_task_list.py +++ b/src/merge/resources/crm/types/paginated_task_list.py @@ -8,9 +8,9 @@ class PaginatedTaskList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Task]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Task]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/paginated_user_list.py b/src/merge/resources/crm/types/paginated_user_list.py index 98e9b7e5..397d4664 100644 --- a/src/merge/resources/crm/types/paginated_user_list.py +++ b/src/merge/resources/crm/types/paginated_user_list.py @@ -8,9 +8,9 @@ class PaginatedUserList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[User]] + 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 diff --git a/src/merge/resources/crm/types/patched_account_request.py b/src/merge/resources/crm/types/patched_account_request.py index c422d16c..b45c559c 100644 --- a/src/merge/resources/crm/types/patched_account_request.py +++ b/src/merge/resources/crm/types/patched_account_request.py @@ -22,45 +22,45 @@ class PatchedAccountRequest(UniversalBaseModel): TODO """ - owner: typing.Optional[str] = pydantic.Field() + owner: typing.Optional[str] = pydantic.Field(default=None) """ The account's owner. """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The account's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The account's description. """ - industry: typing.Optional[str] = pydantic.Field() + industry: typing.Optional[str] = pydantic.Field(default=None) """ The account's industry. """ - website: typing.Optional[str] = pydantic.Field() + website: typing.Optional[str] = pydantic.Field(default=None) """ The account's website. """ - number_of_employees: typing.Optional[int] = pydantic.Field() + number_of_employees: typing.Optional[int] = pydantic.Field(default=None) """ The account's number of employees. """ - addresses: typing.Optional[typing.List[AddressRequest]] - last_activity_at: typing.Optional[dt.datetime] = pydantic.Field() + addresses: typing.Optional[typing.List[AddressRequest]] = None + last_activity_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The last date (either most recent or furthest in the future) of when an activity occurs in an account. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/patched_contact_request.py b/src/merge/resources/crm/types/patched_contact_request.py index 95ab9817..f32ff30c 100644 --- a/src/merge/resources/crm/types/patched_contact_request.py +++ b/src/merge/resources/crm/types/patched_contact_request.py @@ -25,37 +25,37 @@ class PatchedContactRequest(UniversalBaseModel): TODO """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The contact's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The contact's last name. """ - account: typing.Optional[str] = pydantic.Field() + account: typing.Optional[str] = pydantic.Field(default=None) """ The contact's account. """ - owner: typing.Optional[PatchedContactRequestOwner] = pydantic.Field() + owner: typing.Optional[PatchedContactRequestOwner] = pydantic.Field(default=None) """ The contact's owner. """ - addresses: typing.Optional[typing.List[AddressRequest]] - email_addresses: typing.Optional[typing.List[EmailAddressRequest]] - phone_numbers: typing.Optional[typing.List[PhoneNumberRequest]] - last_activity_at: typing.Optional[dt.datetime] = pydantic.Field() + addresses: typing.Optional[typing.List[AddressRequest]] = None + email_addresses: typing.Optional[typing.List[EmailAddressRequest]] = None + phone_numbers: typing.Optional[typing.List[PhoneNumberRequest]] = None + last_activity_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the contact's last activity occurred. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/patched_engagement_request.py b/src/merge/resources/crm/types/patched_engagement_request.py index 1abf3f35..337662c7 100644 --- a/src/merge/resources/crm/types/patched_engagement_request.py +++ b/src/merge/resources/crm/types/patched_engagement_request.py @@ -22,22 +22,22 @@ class PatchedEngagementRequest(UniversalBaseModel): TODO """ - owner: typing.Optional[str] = pydantic.Field() + owner: typing.Optional[str] = pydantic.Field(default=None) """ The engagement's owner. """ - content: typing.Optional[str] = pydantic.Field() + content: typing.Optional[str] = pydantic.Field(default=None) """ The engagement's content. """ - subject: typing.Optional[str] = pydantic.Field() + subject: typing.Optional[str] = pydantic.Field(default=None) """ The engagement's subject. """ - direction: typing.Optional[PatchedEngagementRequestDirection] = pydantic.Field() + direction: typing.Optional[PatchedEngagementRequestDirection] = pydantic.Field(default=None) """ The engagement's direction. @@ -45,30 +45,30 @@ class PatchedEngagementRequest(UniversalBaseModel): - `OUTBOUND` - OUTBOUND """ - engagement_type: typing.Optional[str] = pydantic.Field() + engagement_type: typing.Optional[str] = pydantic.Field(default=None) """ The engagement type of the engagement. """ - start_time: typing.Optional[dt.datetime] = pydantic.Field() + start_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which the engagement started. """ - end_time: typing.Optional[dt.datetime] = pydantic.Field() + end_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which the engagement ended. """ - account: typing.Optional[str] = pydantic.Field() + account: typing.Optional[str] = pydantic.Field(default=None) """ The account of the engagement. """ - contacts: typing.Optional[typing.List[typing.Optional[str]]] - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + contacts: typing.Optional[typing.List[typing.Optional[str]]] = None + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/patched_opportunity_request.py b/src/merge/resources/crm/types/patched_opportunity_request.py index 66659b8f..58778d4b 100644 --- a/src/merge/resources/crm/types/patched_opportunity_request.py +++ b/src/merge/resources/crm/types/patched_opportunity_request.py @@ -22,37 +22,37 @@ class PatchedOpportunityRequest(UniversalBaseModel): TODO """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The opportunity's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The opportunity's description. """ - amount: typing.Optional[int] = pydantic.Field() + amount: typing.Optional[int] = pydantic.Field(default=None) """ The opportunity's amount. """ - owner: typing.Optional[str] = pydantic.Field() + owner: typing.Optional[str] = pydantic.Field(default=None) """ The opportunity's owner. """ - account: typing.Optional[str] = pydantic.Field() + account: typing.Optional[str] = pydantic.Field(default=None) """ The account of the opportunity. """ - stage: typing.Optional[str] = pydantic.Field() + stage: typing.Optional[str] = pydantic.Field(default=None) """ The stage of the opportunity. """ - status: typing.Optional[PatchedOpportunityRequestStatus] = pydantic.Field() + status: typing.Optional[PatchedOpportunityRequestStatus] = pydantic.Field(default=None) """ The opportunity's status. @@ -61,19 +61,19 @@ class PatchedOpportunityRequest(UniversalBaseModel): - `LOST` - LOST """ - last_activity_at: typing.Optional[dt.datetime] = pydantic.Field() + last_activity_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the opportunity's last activity occurred. """ - close_date: typing.Optional[dt.datetime] = pydantic.Field() + close_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the opportunity was closed. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/patched_task_request.py b/src/merge/resources/crm/types/patched_task_request.py index 9a581187..21ce7b69 100644 --- a/src/merge/resources/crm/types/patched_task_request.py +++ b/src/merge/resources/crm/types/patched_task_request.py @@ -22,42 +22,42 @@ class PatchedTaskRequest(UniversalBaseModel): TODO """ - subject: typing.Optional[str] = pydantic.Field() + subject: typing.Optional[str] = pydantic.Field(default=None) """ The task's subject. """ - content: typing.Optional[str] = pydantic.Field() + content: typing.Optional[str] = pydantic.Field(default=None) """ The task's content. """ - owner: typing.Optional[str] = pydantic.Field() + owner: typing.Optional[str] = pydantic.Field(default=None) """ The task's owner. """ - account: typing.Optional[str] = pydantic.Field() + account: typing.Optional[str] = pydantic.Field(default=None) """ The task's account. """ - opportunity: typing.Optional[str] = pydantic.Field() + opportunity: typing.Optional[str] = pydantic.Field(default=None) """ The task's opportunity. """ - completed_date: typing.Optional[dt.datetime] = pydantic.Field() + completed_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the task is completed. """ - due_date: typing.Optional[dt.datetime] = pydantic.Field() + due_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the task is due. """ - status: typing.Optional[PatchedTaskRequestStatus] = pydantic.Field() + status: typing.Optional[PatchedTaskRequestStatus] = pydantic.Field(default=None) """ The task's status. @@ -65,9 +65,9 @@ class PatchedTaskRequest(UniversalBaseModel): - `CLOSED` - CLOSED """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/phone_number.py b/src/merge/resources/crm/types/phone_number.py index ca99e40e..fc68dfbf 100644 --- a/src/merge/resources/crm/types/phone_number.py +++ b/src/merge/resources/crm/types/phone_number.py @@ -20,22 +20,22 @@ class PhoneNumber(UniversalBaseModel): Fetch from the `GET Contact` endpoint and view their phone numbers. """ - created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - phone_number: typing.Optional[str] = pydantic.Field() + phone_number: typing.Optional[str] = pydantic.Field(default=None) """ The phone number. """ - phone_number_type: typing.Optional[str] = pydantic.Field() + phone_number_type: typing.Optional[str] = pydantic.Field(default=None) """ The phone number's type. """ diff --git a/src/merge/resources/crm/types/phone_number_request.py b/src/merge/resources/crm/types/phone_number_request.py index 9a23d09e..894d52b0 100644 --- a/src/merge/resources/crm/types/phone_number_request.py +++ b/src/merge/resources/crm/types/phone_number_request.py @@ -19,18 +19,18 @@ class PhoneNumberRequest(UniversalBaseModel): Fetch from the `GET Contact` endpoint and view their phone numbers. """ - phone_number: typing.Optional[str] = pydantic.Field() + phone_number: typing.Optional[str] = pydantic.Field(default=None) """ The phone number. """ - phone_number_type: typing.Optional[str] = pydantic.Field() + phone_number_type: typing.Optional[str] = pydantic.Field(default=None) """ The phone number's type. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/crm/types/remote_data.py b/src/merge/resources/crm/types/remote_data.py index 27c2a5f2..09a6b50b 100644 --- a/src/merge/resources/crm/types/remote_data.py +++ b/src/merge/resources/crm/types/remote_data.py @@ -8,7 +8,7 @@ class RemoteData(UniversalBaseModel): path: str - data: typing.Optional[typing.Optional[typing.Any]] + data: typing.Optional[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 diff --git a/src/merge/resources/crm/types/remote_field.py b/src/merge/resources/crm/types/remote_field.py index 0d50d6c8..8b30e1a9 100644 --- a/src/merge/resources/crm/types/remote_field.py +++ b/src/merge/resources/crm/types/remote_field.py @@ -9,7 +9,7 @@ class RemoteField(UniversalBaseModel): remote_field_class: RemoteFieldRemoteFieldClass - value: typing.Optional[typing.Optional[typing.Any]] + value: typing.Optional[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 diff --git a/src/merge/resources/crm/types/remote_field_api.py b/src/merge/resources/crm/types/remote_field_api.py index 18f2421d..82495d75 100644 --- a/src/merge/resources/crm/types/remote_field_api.py +++ b/src/merge/resources/crm/types/remote_field_api.py @@ -13,9 +13,9 @@ class RemoteFieldApi(UniversalBaseModel): 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]]] - advanced_metadata: typing.Optional[AdvancedMetadata] - coverage: typing.Optional[RemoteFieldApiCoverage] + example_values: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + advanced_metadata: typing.Optional[AdvancedMetadata] = 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 diff --git a/src/merge/resources/crm/types/remote_field_api_response.py b/src/merge/resources/crm/types/remote_field_api_response.py index 63dd1816..0972b974 100644 --- a/src/merge/resources/crm/types/remote_field_api_response.py +++ b/src/merge/resources/crm/types/remote_field_api_response.py @@ -8,15 +8,15 @@ class RemoteFieldApiResponse(UniversalBaseModel): - account: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Account") - contact: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Contact") - lead: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Lead") - note: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Note") - opportunity: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Opportunity") - stage: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Stage") - user: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="User") - task: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Task") - engagement: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Engagement") + account: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Account", default=None) + contact: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Contact", default=None) + lead: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Lead", default=None) + note: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Note", default=None) + opportunity: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Opportunity", default=None) + stage: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Stage", default=None) + user: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="User", default=None) + task: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Task", default=None) + engagement: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Engagement", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/remote_field_class.py b/src/merge/resources/crm/types/remote_field_class.py index 7abfc779..90072f8e 100644 --- a/src/merge/resources/crm/types/remote_field_class.py +++ b/src/merge/resources/crm/types/remote_field_class.py @@ -11,16 +11,16 @@ class RemoteFieldClass(UniversalBaseModel): - id: typing.Optional[str] - display_name: typing.Optional[str] - remote_key_name: typing.Optional[str] - description: typing.Optional[str] - is_custom: typing.Optional[bool] - is_required: typing.Optional[bool] - field_type: typing.Optional[RemoteFieldClassFieldType] - field_format: typing.Optional[RemoteFieldClassFieldFormat] - field_choices: typing.Optional[typing.List[RemoteFieldClassFieldChoicesItem]] - item_schema: typing.Optional[ItemSchema] + id: typing.Optional[str] = None + display_name: typing.Optional[str] = None + remote_key_name: typing.Optional[str] = None + description: typing.Optional[str] = None + is_custom: typing.Optional[bool] = None + is_required: typing.Optional[bool] = None + field_type: typing.Optional[RemoteFieldClassFieldType] = None + field_format: typing.Optional[RemoteFieldClassFieldFormat] = None + field_choices: typing.Optional[typing.List[RemoteFieldClassFieldChoicesItem]] = None + item_schema: typing.Optional[ItemSchema] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/remote_field_class_field_choices_item.py b/src/merge/resources/crm/types/remote_field_class_field_choices_item.py index 8ae991ae..0778af8b 100644 --- a/src/merge/resources/crm/types/remote_field_class_field_choices_item.py +++ b/src/merge/resources/crm/types/remote_field_class_field_choices_item.py @@ -7,8 +7,8 @@ class RemoteFieldClassFieldChoicesItem(UniversalBaseModel): - value: typing.Optional[typing.Optional[typing.Any]] - display_name: typing.Optional[str] + value: typing.Optional[typing.Optional[typing.Any]] = None + display_name: typing.Optional[str] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/remote_field_class_for_custom_object_class.py b/src/merge/resources/crm/types/remote_field_class_for_custom_object_class.py index 75012af9..a6d07b92 100644 --- a/src/merge/resources/crm/types/remote_field_class_for_custom_object_class.py +++ b/src/merge/resources/crm/types/remote_field_class_for_custom_object_class.py @@ -14,24 +14,24 @@ class RemoteFieldClassForCustomObjectClass(UniversalBaseModel): - created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - display_name: typing.Optional[str] - remote_key_name: typing.Optional[str] - description: typing.Optional[str] - is_required: typing.Optional[bool] - field_type: typing.Optional[RemoteFieldClassForCustomObjectClassFieldType] - field_format: typing.Optional[RemoteFieldClassForCustomObjectClassFieldFormat] - field_choices: typing.Optional[typing.List[RemoteFieldClassForCustomObjectClassFieldChoicesItem]] - item_schema: typing.Optional[RemoteFieldClassForCustomObjectClassItemSchema] + display_name: typing.Optional[str] = None + remote_key_name: typing.Optional[str] = None + description: typing.Optional[str] = None + is_required: typing.Optional[bool] = None + field_type: typing.Optional[RemoteFieldClassForCustomObjectClassFieldType] = None + field_format: typing.Optional[RemoteFieldClassForCustomObjectClassFieldFormat] = None + field_choices: typing.Optional[typing.List[RemoteFieldClassForCustomObjectClassFieldChoicesItem]] = None + item_schema: typing.Optional[RemoteFieldClassForCustomObjectClassItemSchema] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/remote_field_class_for_custom_object_class_field_choices_item.py b/src/merge/resources/crm/types/remote_field_class_for_custom_object_class_field_choices_item.py index 6d1bcb7a..351e7276 100644 --- a/src/merge/resources/crm/types/remote_field_class_for_custom_object_class_field_choices_item.py +++ b/src/merge/resources/crm/types/remote_field_class_for_custom_object_class_field_choices_item.py @@ -7,8 +7,8 @@ class RemoteFieldClassForCustomObjectClassFieldChoicesItem(UniversalBaseModel): - value: typing.Optional[typing.Optional[typing.Any]] - display_name: typing.Optional[str] + value: typing.Optional[typing.Optional[typing.Any]] = None + display_name: typing.Optional[str] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/remote_field_class_for_custom_object_class_item_schema.py b/src/merge/resources/crm/types/remote_field_class_for_custom_object_class_item_schema.py index e1f83c79..a99ec795 100644 --- a/src/merge/resources/crm/types/remote_field_class_for_custom_object_class_item_schema.py +++ b/src/merge/resources/crm/types/remote_field_class_for_custom_object_class_item_schema.py @@ -7,9 +7,9 @@ class RemoteFieldClassForCustomObjectClassItemSchema(UniversalBaseModel): - item_type: typing.Optional[str] - item_format: typing.Optional[str] - item_choices: typing.Optional[typing.List[typing.Optional[str]]] + item_type: typing.Optional[str] = None + item_format: typing.Optional[str] = None + item_choices: typing.Optional[typing.List[typing.Optional[str]]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/remote_field_request.py b/src/merge/resources/crm/types/remote_field_request.py index bf5b7ce4..7e4d9f40 100644 --- a/src/merge/resources/crm/types/remote_field_request.py +++ b/src/merge/resources/crm/types/remote_field_request.py @@ -9,7 +9,7 @@ class RemoteFieldRequest(UniversalBaseModel): remote_field_class: RemoteFieldRequestRemoteFieldClass - value: typing.Optional[typing.Optional[typing.Any]] + value: typing.Optional[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 diff --git a/src/merge/resources/crm/types/remote_response.py b/src/merge/resources/crm/types/remote_response.py index e2d1620d..49988647 100644 --- a/src/merge/resources/crm/types/remote_response.py +++ b/src/merge/resources/crm/types/remote_response.py @@ -23,10 +23,10 @@ class RemoteResponse(UniversalBaseModel): method: str path: str status: int - response: typing.Optional[typing.Any] - response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - response_type: typing.Optional[ResponseTypeEnum] - headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + response: typing.Optional[typing.Any] = None + response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + response_type: typing.Optional[ResponseTypeEnum] = 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 diff --git a/src/merge/resources/crm/types/stage.py b/src/merge/resources/crm/types/stage.py index 4a9583a9..87b74868 100644 --- a/src/merge/resources/crm/types/stage.py +++ b/src/merge/resources/crm/types/stage.py @@ -22,35 +22,35 @@ class Stage(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The stage's name. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/sync_status.py b/src/merge/resources/crm/types/sync_status.py index f9a62229..c1a01c18 100644 --- a/src/merge/resources/crm/types/sync_status.py +++ b/src/merge/resources/crm/types/sync_status.py @@ -24,11 +24,11 @@ class SyncStatus(UniversalBaseModel): model_name: str model_id: str - last_sync_start: typing.Optional[dt.datetime] - next_sync_start: typing.Optional[dt.datetime] + last_sync_start: typing.Optional[dt.datetime] = None + next_sync_start: typing.Optional[dt.datetime] = None status: SyncStatusStatusEnum is_initial_sync: bool - selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] + 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 diff --git a/src/merge/resources/crm/types/task.py b/src/merge/resources/crm/types/task.py index fb5f875d..a24c14cd 100644 --- a/src/merge/resources/crm/types/task.py +++ b/src/merge/resources/crm/types/task.py @@ -26,58 +26,58 @@ class Task(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + subject: typing.Optional[str] = pydantic.Field(default=None) """ The task's subject. """ - content: typing.Optional[str] = pydantic.Field() + content: typing.Optional[str] = pydantic.Field(default=None) """ The task's content. """ - owner: typing.Optional[TaskOwner] = pydantic.Field() + owner: typing.Optional[TaskOwner] = pydantic.Field(default=None) """ The task's owner. """ - account: typing.Optional[TaskAccount] = pydantic.Field() + account: typing.Optional[TaskAccount] = pydantic.Field(default=None) """ The task's account. """ - opportunity: typing.Optional[TaskOpportunity] = pydantic.Field() + opportunity: typing.Optional[TaskOpportunity] = pydantic.Field(default=None) """ The task's opportunity. """ - completed_date: typing.Optional[dt.datetime] = pydantic.Field() + completed_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the task is completed. """ - due_date: typing.Optional[dt.datetime] = pydantic.Field() + due_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the task is due. """ - status: typing.Optional[TaskStatus] = pydantic.Field() + status: typing.Optional[TaskStatus] = pydantic.Field(default=None) """ The task's status. @@ -85,14 +85,14 @@ class Task(UniversalBaseModel): - `CLOSED` - CLOSED """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/task_request.py b/src/merge/resources/crm/types/task_request.py index 0bc7078d..4ad164e3 100644 --- a/src/merge/resources/crm/types/task_request.py +++ b/src/merge/resources/crm/types/task_request.py @@ -25,42 +25,42 @@ class TaskRequest(UniversalBaseModel): TODO """ - subject: typing.Optional[str] = pydantic.Field() + subject: typing.Optional[str] = pydantic.Field(default=None) """ The task's subject. """ - content: typing.Optional[str] = pydantic.Field() + content: typing.Optional[str] = pydantic.Field(default=None) """ The task's content. """ - owner: typing.Optional[TaskRequestOwner] = pydantic.Field() + owner: typing.Optional[TaskRequestOwner] = pydantic.Field(default=None) """ The task's owner. """ - account: typing.Optional[TaskRequestAccount] = pydantic.Field() + account: typing.Optional[TaskRequestAccount] = pydantic.Field(default=None) """ The task's account. """ - opportunity: typing.Optional[TaskRequestOpportunity] = pydantic.Field() + opportunity: typing.Optional[TaskRequestOpportunity] = pydantic.Field(default=None) """ The task's opportunity. """ - completed_date: typing.Optional[dt.datetime] = pydantic.Field() + completed_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the task is completed. """ - due_date: typing.Optional[dt.datetime] = pydantic.Field() + due_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the task is due. """ - status: typing.Optional[TaskRequestStatus] = pydantic.Field() + status: typing.Optional[TaskRequestStatus] = pydantic.Field(default=None) """ The task's status. @@ -68,9 +68,9 @@ class TaskRequest(UniversalBaseModel): - `CLOSED` - CLOSED """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/task_response.py b/src/merge/resources/crm/types/task_response.py index 49273ea6..4177cec5 100644 --- a/src/merge/resources/crm/types/task_response.py +++ b/src/merge/resources/crm/types/task_response.py @@ -14,7 +14,7 @@ class TaskResponse(UniversalBaseModel): model: Task warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/crm/types/user.py b/src/merge/resources/crm/types/user.py index 0686763b..252256f5 100644 --- a/src/merge/resources/crm/types/user.py +++ b/src/merge/resources/crm/types/user.py @@ -22,45 +22,45 @@ class User(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The user's name. """ - email: typing.Optional[str] = pydantic.Field() + email: typing.Optional[str] = pydantic.Field(default=None) """ The user's email address. """ - is_active: typing.Optional[bool] = pydantic.Field() + is_active: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the user is active. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/crm/types/warning_validation_problem.py b/src/merge/resources/crm/types/warning_validation_problem.py index d508bb6d..140199ca 100644 --- a/src/merge/resources/crm/types/warning_validation_problem.py +++ b/src/merge/resources/crm/types/warning_validation_problem.py @@ -8,7 +8,7 @@ class WarningValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/crm/types/webhook_receiver.py b/src/merge/resources/crm/types/webhook_receiver.py index e8cd17aa..ac8573be 100644 --- a/src/merge/resources/crm/types/webhook_receiver.py +++ b/src/merge/resources/crm/types/webhook_receiver.py @@ -9,7 +9,7 @@ class WebhookReceiver(UniversalBaseModel): event: str is_active: bool - key: typing.Optional[str] + 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 diff --git a/src/merge/resources/filestorage/types/account_details.py b/src/merge/resources/filestorage/types/account_details.py index dc91a6f3..aaf3c5e4 100644 --- a/src/merge/resources/filestorage/types/account_details.py +++ b/src/merge/resources/filestorage/types/account_details.py @@ -9,22 +9,22 @@ class AccountDetails(UniversalBaseModel): - id: typing.Optional[str] - integration: typing.Optional[str] - integration_slug: typing.Optional[str] - category: typing.Optional[CategoryEnum] - end_user_origin_id: typing.Optional[str] - end_user_organization_name: typing.Optional[str] - end_user_email_address: typing.Optional[str] - status: typing.Optional[str] - webhook_listener_url: typing.Optional[str] - is_duplicate: typing.Optional[bool] = pydantic.Field() + id: typing.Optional[str] = None + integration: typing.Optional[str] = None + integration_slug: typing.Optional[str] = None + category: typing.Optional[CategoryEnum] = None + end_user_origin_id: typing.Optional[str] = None + end_user_organization_name: typing.Optional[str] = None + end_user_email_address: typing.Optional[str] = None + status: typing.Optional[str] = None + webhook_listener_url: typing.Optional[str] = None + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - account_type: typing.Optional[str] - completed_at: typing.Optional[dt.datetime] = pydantic.Field() + account_type: typing.Optional[str] = None + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which account completes the linking flow. """ diff --git a/src/merge/resources/filestorage/types/account_details_and_actions.py b/src/merge/resources/filestorage/types/account_details_and_actions.py index 30e78b61..4c96905f 100644 --- a/src/merge/resources/filestorage/types/account_details_and_actions.py +++ b/src/merge/resources/filestorage/types/account_details_and_actions.py @@ -24,24 +24,24 @@ class AccountDetailsAndActions(UniversalBaseModel): """ id: str - category: typing.Optional[CategoryEnum] + category: typing.Optional[CategoryEnum] = None status: AccountDetailsAndActionsStatusEnum - status_detail: typing.Optional[str] - end_user_origin_id: typing.Optional[str] + status_detail: typing.Optional[str] = None + end_user_origin_id: typing.Optional[str] = None end_user_organization_name: str end_user_email_address: str - subdomain: typing.Optional[str] = pydantic.Field() + subdomain: typing.Optional[str] = pydantic.Field(default=None) """ The tenant or domain the customer has provided access to. """ webhook_listener_url: str - is_duplicate: typing.Optional[bool] = pydantic.Field() + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - integration: typing.Optional[AccountDetailsAndActionsIntegration] + integration: typing.Optional[AccountDetailsAndActionsIntegration] = None account_type: str completed_at: dt.datetime diff --git a/src/merge/resources/filestorage/types/account_details_and_actions_integration.py b/src/merge/resources/filestorage/types/account_details_and_actions_integration.py index 5779ac5b..8e47dbc4 100644 --- a/src/merge/resources/filestorage/types/account_details_and_actions_integration.py +++ b/src/merge/resources/filestorage/types/account_details_and_actions_integration.py @@ -11,12 +11,12 @@ class AccountDetailsAndActionsIntegration(UniversalBaseModel): name: str categories: typing.List[CategoriesEnum] - image: typing.Optional[str] - square_image: typing.Optional[str] + image: typing.Optional[str] = None + square_image: typing.Optional[str] = None color: str slug: str passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/filestorage/types/account_integration.py b/src/merge/resources/filestorage/types/account_integration.py index 2d18dedb..1dad1594 100644 --- a/src/merge/resources/filestorage/types/account_integration.py +++ b/src/merge/resources/filestorage/types/account_integration.py @@ -13,45 +13,45 @@ class AccountIntegration(UniversalBaseModel): Company name. """ - abbreviated_name: typing.Optional[str] = pydantic.Field() + abbreviated_name: typing.Optional[str] = pydantic.Field(default=None) """ Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).

Example: Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors) """ - categories: typing.Optional[typing.List[CategoriesEnum]] = pydantic.Field() + 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() + image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in rectangular shape. """ - square_image: typing.Optional[str] = pydantic.Field() + square_image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in square shape. """ - color: typing.Optional[str] = pydantic.Field() + 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] + slug: typing.Optional[str] = None api_endpoints_to_documentation_urls: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = ( - pydantic.Field() + 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() + 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() + 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. """ diff --git a/src/merge/resources/filestorage/types/advanced_metadata.py b/src/merge/resources/filestorage/types/advanced_metadata.py index 6287a842..e570d69f 100644 --- a/src/merge/resources/filestorage/types/advanced_metadata.py +++ b/src/merge/resources/filestorage/types/advanced_metadata.py @@ -8,11 +8,11 @@ class AdvancedMetadata(UniversalBaseModel): id: str - display_name: typing.Optional[str] - description: typing.Optional[str] - is_required: typing.Optional[bool] - is_custom: typing.Optional[bool] - field_choices: typing.Optional[typing.List[typing.Optional[typing.Any]]] + 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 diff --git a/src/merge/resources/filestorage/types/audit_log_event.py b/src/merge/resources/filestorage/types/audit_log_event.py index b57101fc..1c32586b 100644 --- a/src/merge/resources/filestorage/types/audit_log_event.py +++ b/src/merge/resources/filestorage/types/audit_log_event.py @@ -10,13 +10,13 @@ class AuditLogEvent(UniversalBaseModel): - id: typing.Optional[str] - user_name: typing.Optional[str] = pydantic.Field() + 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() + user_email: typing.Optional[str] = pydantic.Field(default=None) """ The User's email at the time of this Event occurring. """ @@ -79,7 +79,7 @@ class AuditLogEvent(UniversalBaseModel): """ event_description: str - created_at: typing.Optional[dt.datetime] + 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 diff --git a/src/merge/resources/filestorage/types/available_actions.py b/src/merge/resources/filestorage/types/available_actions.py index 5f164db6..57cee06d 100644 --- a/src/merge/resources/filestorage/types/available_actions.py +++ b/src/merge/resources/filestorage/types/available_actions.py @@ -23,7 +23,7 @@ class AvailableActions(UniversalBaseModel): integration: AccountIntegration passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/filestorage/types/data_passthrough_request.py b/src/merge/resources/filestorage/types/data_passthrough_request.py index f2718105..2b0595cf 100644 --- a/src/merge/resources/filestorage/types/data_passthrough_request.py +++ b/src/merge/resources/filestorage/types/data_passthrough_request.py @@ -28,28 +28,28 @@ class DataPassthroughRequest(UniversalBaseModel): The path of the request in the third party's platform. """ - base_url_override: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + 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[RequestFormatEnum] - normalize_response: typing.Optional[bool] = pydantic.Field() + request_format: typing.Optional[RequestFormatEnum] = 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`. """ diff --git a/src/merge/resources/filestorage/types/drive.py b/src/merge/resources/filestorage/types/drive.py index 5b8ffcf9..08fa643e 100644 --- a/src/merge/resources/filestorage/types/drive.py +++ b/src/merge/resources/filestorage/types/drive.py @@ -20,44 +20,44 @@ class Drive(UniversalBaseModel): Fetch from the `GET /api/filestorage/v1/drives` endpoint and view their drives. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The drive's name. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's drive was created. """ - drive_url: typing.Optional[str] = pydantic.Field() + drive_url: typing.Optional[str] = pydantic.Field(default=None) """ The drive's url. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[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 diff --git a/src/merge/resources/filestorage/types/error_validation_problem.py b/src/merge/resources/filestorage/types/error_validation_problem.py index 58ea87e6..91565918 100644 --- a/src/merge/resources/filestorage/types/error_validation_problem.py +++ b/src/merge/resources/filestorage/types/error_validation_problem.py @@ -8,7 +8,7 @@ class ErrorValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/filestorage/types/external_target_field_api.py b/src/merge/resources/filestorage/types/external_target_field_api.py index 18988d44..1ed19a99 100644 --- a/src/merge/resources/filestorage/types/external_target_field_api.py +++ b/src/merge/resources/filestorage/types/external_target_field_api.py @@ -7,9 +7,9 @@ class ExternalTargetFieldApi(UniversalBaseModel): - name: typing.Optional[str] - description: typing.Optional[str] - is_mapped: typing.Optional[str] + 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 diff --git a/src/merge/resources/filestorage/types/external_target_field_api_response.py b/src/merge/resources/filestorage/types/external_target_field_api_response.py index dc78ea6d..bf8e88d6 100644 --- a/src/merge/resources/filestorage/types/external_target_field_api_response.py +++ b/src/merge/resources/filestorage/types/external_target_field_api_response.py @@ -8,11 +8,11 @@ class ExternalTargetFieldApiResponse(UniversalBaseModel): - file: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="File") - folder: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Folder") - drive: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Drive") - group: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Group") - user: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="User") + file: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="File", default=None) + folder: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Folder", default=None) + drive: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Drive", default=None) + group: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Group", default=None) + user: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="User", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/filestorage/types/field_mapping_api_instance.py b/src/merge/resources/filestorage/types/field_mapping_api_instance.py index ef4d9c48..1cc2f4a2 100644 --- a/src/merge/resources/filestorage/types/field_mapping_api_instance.py +++ b/src/merge/resources/filestorage/types/field_mapping_api_instance.py @@ -9,10 +9,10 @@ class FieldMappingApiInstance(UniversalBaseModel): - id: typing.Optional[str] - is_integration_wide: typing.Optional[bool] - target_field: typing.Optional[FieldMappingApiInstanceTargetField] - remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] + id: typing.Optional[str] = None + is_integration_wide: typing.Optional[bool] = None + target_field: typing.Optional[FieldMappingApiInstanceTargetField] = None + remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/filestorage/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py b/src/merge/resources/filestorage/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py index 14c37c76..9eeb4fbf 100644 --- a/src/merge/resources/filestorage/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py +++ b/src/merge/resources/filestorage/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py @@ -7,9 +7,9 @@ class FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo(UniversalBaseModel): - method: typing.Optional[str] - url_path: typing.Optional[str] - field_traversal_path: typing.Optional[typing.List[str]] + 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 diff --git a/src/merge/resources/filestorage/types/field_mapping_api_instance_response.py b/src/merge/resources/filestorage/types/field_mapping_api_instance_response.py index b9ec73bd..61ad9f7c 100644 --- a/src/merge/resources/filestorage/types/field_mapping_api_instance_response.py +++ b/src/merge/resources/filestorage/types/field_mapping_api_instance_response.py @@ -8,11 +8,11 @@ class FieldMappingApiInstanceResponse(UniversalBaseModel): - file: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="File") - folder: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Folder") - drive: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Drive") - group: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Group") - user: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="User") + file: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="File", default=None) + folder: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Folder", default=None) + drive: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Drive", default=None) + group: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Group", default=None) + user: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="User", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/filestorage/types/field_mapping_instance_response.py b/src/merge/resources/filestorage/types/field_mapping_instance_response.py index a56aeb93..2123f4d3 100644 --- a/src/merge/resources/filestorage/types/field_mapping_instance_response.py +++ b/src/merge/resources/filestorage/types/field_mapping_instance_response.py @@ -14,7 +14,7 @@ class FieldMappingInstanceResponse(UniversalBaseModel): model: FieldMappingApiInstance warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/filestorage/types/field_permission_deserializer.py b/src/merge/resources/filestorage/types/field_permission_deserializer.py index 9670537a..ea7cc235 100644 --- a/src/merge/resources/filestorage/types/field_permission_deserializer.py +++ b/src/merge/resources/filestorage/types/field_permission_deserializer.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializer(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/filestorage/types/field_permission_deserializer_request.py b/src/merge/resources/filestorage/types/field_permission_deserializer_request.py index 04e14608..e5617ad6 100644 --- a/src/merge/resources/filestorage/types/field_permission_deserializer_request.py +++ b/src/merge/resources/filestorage/types/field_permission_deserializer_request.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializerRequest(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/filestorage/types/file.py b/src/merge/resources/filestorage/types/file.py index 8c578811..12b61785 100644 --- a/src/merge/resources/filestorage/types/file.py +++ b/src/merge/resources/filestorage/types/file.py @@ -26,84 +26,84 @@ class File(UniversalBaseModel): Fetch from the `GET /api/filestorage/v1/files` endpoint and view their files. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The file's name. """ - file_url: typing.Optional[str] = pydantic.Field() + file_url: typing.Optional[str] = pydantic.Field(default=None) """ The URL to access the file. """ - file_thumbnail_url: typing.Optional[str] = pydantic.Field() + file_thumbnail_url: typing.Optional[str] = pydantic.Field(default=None) """ The URL that produces a thumbnail preview of the file. Typically an image. """ - size: typing.Optional[int] = pydantic.Field() + size: typing.Optional[int] = pydantic.Field(default=None) """ The file's size, in bytes. """ - mime_type: typing.Optional[str] = pydantic.Field() + mime_type: typing.Optional[str] = pydantic.Field(default=None) """ The file's mime type. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The file's description. """ - folder: typing.Optional[FileFolder] = pydantic.Field() + folder: typing.Optional[FileFolder] = pydantic.Field(default=None) """ The folder that the file belongs to. """ - permissions: typing.Optional[FilePermissions] = pydantic.Field() + permissions: typing.Optional[FilePermissions] = pydantic.Field(default=None) """ The Permission object is used to represent a user's or group's access to a File or Folder. Permissions are unexpanded by default. Use the query param `expand=permissions` to see more details under `GET /files`. """ - drive: typing.Optional[FileDrive] = pydantic.Field() + drive: typing.Optional[FileDrive] = pydantic.Field(default=None) """ The drive that the file belongs to. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's file was created. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's file was updated. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[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 diff --git a/src/merge/resources/filestorage/types/file_request.py b/src/merge/resources/filestorage/types/file_request.py index fb61ea15..357bc0b6 100644 --- a/src/merge/resources/filestorage/types/file_request.py +++ b/src/merge/resources/filestorage/types/file_request.py @@ -25,53 +25,53 @@ class FileRequest(UniversalBaseModel): Fetch from the `GET /api/filestorage/v1/files` endpoint and view their files. """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The file's name. """ - file_url: typing.Optional[str] = pydantic.Field() + file_url: typing.Optional[str] = pydantic.Field(default=None) """ The URL to access the file. """ - file_thumbnail_url: typing.Optional[str] = pydantic.Field() + file_thumbnail_url: typing.Optional[str] = pydantic.Field(default=None) """ The URL that produces a thumbnail preview of the file. Typically an image. """ - size: typing.Optional[int] = pydantic.Field() + size: typing.Optional[int] = pydantic.Field(default=None) """ The file's size, in bytes. """ - mime_type: typing.Optional[str] = pydantic.Field() + mime_type: typing.Optional[str] = pydantic.Field(default=None) """ The file's mime type. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The file's description. """ - folder: typing.Optional[FileRequestFolder] = pydantic.Field() + folder: typing.Optional[FileRequestFolder] = pydantic.Field(default=None) """ The folder that the file belongs to. """ - permissions: typing.Optional[FileRequestPermissions] = pydantic.Field() + permissions: typing.Optional[FileRequestPermissions] = pydantic.Field(default=None) """ The Permission object is used to represent a user's or group's access to a File or Folder. Permissions are unexpanded by default. Use the query param `expand=permissions` to see more details under `GET /files`. """ - drive: typing.Optional[FileRequestDrive] = pydantic.Field() + drive: typing.Optional[FileRequestDrive] = pydantic.Field(default=None) """ The drive that the file belongs to. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/filestorage/types/file_storage_file_response.py b/src/merge/resources/filestorage/types/file_storage_file_response.py index 498dd53a..831c87f0 100644 --- a/src/merge/resources/filestorage/types/file_storage_file_response.py +++ b/src/merge/resources/filestorage/types/file_storage_file_response.py @@ -17,7 +17,7 @@ class FileStorageFileResponse(UniversalBaseModel): model: File warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/filestorage/types/file_storage_folder_response.py b/src/merge/resources/filestorage/types/file_storage_folder_response.py index fbb7dd2b..f3b702af 100644 --- a/src/merge/resources/filestorage/types/file_storage_folder_response.py +++ b/src/merge/resources/filestorage/types/file_storage_folder_response.py @@ -16,7 +16,7 @@ class FileStorageFolderResponse(UniversalBaseModel): model: Folder warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/filestorage/types/folder.py b/src/merge/resources/filestorage/types/folder.py index 50af0c42..f440191a 100644 --- a/src/merge/resources/filestorage/types/folder.py +++ b/src/merge/resources/filestorage/types/folder.py @@ -24,74 +24,74 @@ class Folder(UniversalBaseModel): Fetch from the `GET /api/filestorage/v1/folders` endpoint and view their folders. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The folder's name. """ - folder_url: typing.Optional[str] = pydantic.Field() + folder_url: typing.Optional[str] = pydantic.Field(default=None) """ The URL to access the folder. """ - size: typing.Optional[int] = pydantic.Field() + size: typing.Optional[int] = pydantic.Field(default=None) """ The folder's size, in bytes. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The folder's description. """ - parent_folder: typing.Optional["FolderParentFolder"] = pydantic.Field() + parent_folder: typing.Optional["FolderParentFolder"] = pydantic.Field(default=None) """ The folder that the folder belongs to. """ - drive: typing.Optional[FolderDrive] = pydantic.Field() + drive: typing.Optional[FolderDrive] = pydantic.Field(default=None) """ The drive that the folder belongs to. """ - permissions: typing.Optional[FolderPermissions] = pydantic.Field() + permissions: typing.Optional[FolderPermissions] = pydantic.Field(default=None) """ The Permission object is used to represent a user's or group's access to a File or Folder. Permissions are unexpanded by default. Use the query param `expand=permissions` to see more details under `GET /folders`. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + 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() + 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() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[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 diff --git a/src/merge/resources/filestorage/types/folder_request.py b/src/merge/resources/filestorage/types/folder_request.py index f2febdf3..b0967ac7 100644 --- a/src/merge/resources/filestorage/types/folder_request.py +++ b/src/merge/resources/filestorage/types/folder_request.py @@ -25,43 +25,43 @@ class FolderRequest(UniversalBaseModel): Fetch from the `GET /api/filestorage/v1/folders` endpoint and view their folders. """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The folder's name. """ - folder_url: typing.Optional[str] = pydantic.Field() + folder_url: typing.Optional[str] = pydantic.Field(default=None) """ The URL to access the folder. """ - size: typing.Optional[int] = pydantic.Field() + size: typing.Optional[int] = pydantic.Field(default=None) """ The folder's size, in bytes. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The folder's description. """ - parent_folder: typing.Optional[FolderRequestParentFolder] = pydantic.Field() + parent_folder: typing.Optional[FolderRequestParentFolder] = pydantic.Field(default=None) """ The folder that the folder belongs to. """ - drive: typing.Optional[FolderRequestDrive] = pydantic.Field() + drive: typing.Optional[FolderRequestDrive] = pydantic.Field(default=None) """ The drive that the folder belongs to. """ - permissions: typing.Optional[FolderRequestPermissions] = pydantic.Field() + permissions: typing.Optional[FolderRequestPermissions] = pydantic.Field(default=None) """ The Permission object is used to represent a user's or group's access to a File or Folder. Permissions are unexpanded by default. Use the query param `expand=permissions` to see more details under `GET /folders`. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/filestorage/types/group.py b/src/merge/resources/filestorage/types/group.py index 95784988..96b94496 100644 --- a/src/merge/resources/filestorage/types/group.py +++ b/src/merge/resources/filestorage/types/group.py @@ -20,23 +20,23 @@ class Group(UniversalBaseModel): Fetch from the `GET /api/filestorage/v1/groups` endpoint and view their groups. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The group's name. """ @@ -46,13 +46,13 @@ class Group(UniversalBaseModel): The users that belong in the group. If null, this typically means it's either a domain or the third-party platform does not surface this information. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[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 diff --git a/src/merge/resources/filestorage/types/individual_common_model_scope_deserializer.py b/src/merge/resources/filestorage/types/individual_common_model_scope_deserializer.py index 122df11c..70704314 100644 --- a/src/merge/resources/filestorage/types/individual_common_model_scope_deserializer.py +++ b/src/merge/resources/filestorage/types/individual_common_model_scope_deserializer.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializer(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializer]] - field_permissions: typing.Optional[FieldPermissionDeserializer] + 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 diff --git a/src/merge/resources/filestorage/types/individual_common_model_scope_deserializer_request.py b/src/merge/resources/filestorage/types/individual_common_model_scope_deserializer_request.py index a1a80902..d42dd53a 100644 --- a/src/merge/resources/filestorage/types/individual_common_model_scope_deserializer_request.py +++ b/src/merge/resources/filestorage/types/individual_common_model_scope_deserializer_request.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializerRequest(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializerRequest]] - field_permissions: typing.Optional[FieldPermissionDeserializerRequest] + 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 diff --git a/src/merge/resources/filestorage/types/issue.py b/src/merge/resources/filestorage/types/issue.py index 5a584515..7adc1f31 100644 --- a/src/merge/resources/filestorage/types/issue.py +++ b/src/merge/resources/filestorage/types/issue.py @@ -9,8 +9,8 @@ class Issue(UniversalBaseModel): - id: typing.Optional[str] - status: typing.Optional[IssueStatus] = pydantic.Field() + id: typing.Optional[str] = None + status: typing.Optional[IssueStatus] = pydantic.Field(default=None) """ Status of the issue. Options: ('ONGOING', 'RESOLVED') @@ -19,11 +19,11 @@ class Issue(UniversalBaseModel): """ error_description: str - end_user: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - first_incident_time: typing.Optional[dt.datetime] - last_incident_time: typing.Optional[dt.datetime] - is_muted: typing.Optional[bool] - error_details: typing.Optional[typing.List[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 diff --git a/src/merge/resources/filestorage/types/link_token.py b/src/merge/resources/filestorage/types/link_token.py index 1d25dddb..ac916d14 100644 --- a/src/merge/resources/filestorage/types/link_token.py +++ b/src/merge/resources/filestorage/types/link_token.py @@ -8,8 +8,8 @@ class LinkToken(UniversalBaseModel): link_token: str - integration_name: typing.Optional[str] - magic_link_url: typing.Optional[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 diff --git a/src/merge/resources/filestorage/types/meta_response.py b/src/merge/resources/filestorage/types/meta_response.py index 44e57fde..272535f0 100644 --- a/src/merge/resources/filestorage/types/meta_response.py +++ b/src/merge/resources/filestorage/types/meta_response.py @@ -9,8 +9,8 @@ class MetaResponse(UniversalBaseModel): request_schema: typing.Dict[str, typing.Optional[typing.Any]] - remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - status: typing.Optional[LinkedAccountStatus] + remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + status: typing.Optional[LinkedAccountStatus] = None has_conditional_params: bool has_required_linked_account_params: bool diff --git a/src/merge/resources/filestorage/types/model_permission_deserializer.py b/src/merge/resources/filestorage/types/model_permission_deserializer.py index b6d813e4..96f39e63 100644 --- a/src/merge/resources/filestorage/types/model_permission_deserializer.py +++ b/src/merge/resources/filestorage/types/model_permission_deserializer.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializer(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/filestorage/types/model_permission_deserializer_request.py b/src/merge/resources/filestorage/types/model_permission_deserializer_request.py index 5885627b..2619fb6a 100644 --- a/src/merge/resources/filestorage/types/model_permission_deserializer_request.py +++ b/src/merge/resources/filestorage/types/model_permission_deserializer_request.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializerRequest(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/filestorage/types/multipart_form_field_request.py b/src/merge/resources/filestorage/types/multipart_form_field_request.py index 80099016..507fa8c6 100644 --- a/src/merge/resources/filestorage/types/multipart_form_field_request.py +++ b/src/merge/resources/filestorage/types/multipart_form_field_request.py @@ -30,7 +30,7 @@ class MultipartFormFieldRequest(UniversalBaseModel): The data for the form field. """ - encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field() + encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field(default=None) """ The encoding of the value of `data`. Defaults to `RAW` if not defined. @@ -39,12 +39,12 @@ class MultipartFormFieldRequest(UniversalBaseModel): - `GZIP_BASE64` - GZIP_BASE64 """ - file_name: typing.Optional[str] = pydantic.Field() + 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() + content_type: typing.Optional[str] = pydantic.Field(default=None) """ The MIME type of the file, if the field is for a file. """ diff --git a/src/merge/resources/filestorage/types/paginated_account_details_and_actions_list.py b/src/merge/resources/filestorage/types/paginated_account_details_and_actions_list.py index a9128c76..00ceeda5 100644 --- a/src/merge/resources/filestorage/types/paginated_account_details_and_actions_list.py +++ b/src/merge/resources/filestorage/types/paginated_account_details_and_actions_list.py @@ -8,9 +8,9 @@ class PaginatedAccountDetailsAndActionsList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AccountDetailsAndActions]] + 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 diff --git a/src/merge/resources/filestorage/types/paginated_audit_log_event_list.py b/src/merge/resources/filestorage/types/paginated_audit_log_event_list.py index a50b7c75..450de68c 100644 --- a/src/merge/resources/filestorage/types/paginated_audit_log_event_list.py +++ b/src/merge/resources/filestorage/types/paginated_audit_log_event_list.py @@ -8,9 +8,9 @@ class PaginatedAuditLogEventList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AuditLogEvent]] + 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 diff --git a/src/merge/resources/filestorage/types/paginated_drive_list.py b/src/merge/resources/filestorage/types/paginated_drive_list.py index 345838c9..6ffe7197 100644 --- a/src/merge/resources/filestorage/types/paginated_drive_list.py +++ b/src/merge/resources/filestorage/types/paginated_drive_list.py @@ -8,9 +8,9 @@ class PaginatedDriveList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Drive]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Drive]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/filestorage/types/paginated_file_list.py b/src/merge/resources/filestorage/types/paginated_file_list.py index 7effa118..67776d56 100644 --- a/src/merge/resources/filestorage/types/paginated_file_list.py +++ b/src/merge/resources/filestorage/types/paginated_file_list.py @@ -11,9 +11,9 @@ class PaginatedFileList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[File]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[File]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/filestorage/types/paginated_folder_list.py b/src/merge/resources/filestorage/types/paginated_folder_list.py index 3b239279..fab85217 100644 --- a/src/merge/resources/filestorage/types/paginated_folder_list.py +++ b/src/merge/resources/filestorage/types/paginated_folder_list.py @@ -10,9 +10,9 @@ class PaginatedFolderList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Folder]] + 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 diff --git a/src/merge/resources/filestorage/types/paginated_group_list.py b/src/merge/resources/filestorage/types/paginated_group_list.py index 72413a02..fbe99b23 100644 --- a/src/merge/resources/filestorage/types/paginated_group_list.py +++ b/src/merge/resources/filestorage/types/paginated_group_list.py @@ -8,9 +8,9 @@ class PaginatedGroupList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Group]] + 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 diff --git a/src/merge/resources/filestorage/types/paginated_issue_list.py b/src/merge/resources/filestorage/types/paginated_issue_list.py index 12b866d9..758e6dc3 100644 --- a/src/merge/resources/filestorage/types/paginated_issue_list.py +++ b/src/merge/resources/filestorage/types/paginated_issue_list.py @@ -8,9 +8,9 @@ class PaginatedIssueList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Issue]] + 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 diff --git a/src/merge/resources/filestorage/types/paginated_sync_status_list.py b/src/merge/resources/filestorage/types/paginated_sync_status_list.py index f59f2c9a..f4f09ed1 100644 --- a/src/merge/resources/filestorage/types/paginated_sync_status_list.py +++ b/src/merge/resources/filestorage/types/paginated_sync_status_list.py @@ -8,9 +8,9 @@ class PaginatedSyncStatusList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[SyncStatus]] + 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 diff --git a/src/merge/resources/filestorage/types/paginated_user_list.py b/src/merge/resources/filestorage/types/paginated_user_list.py index 98e9b7e5..397d4664 100644 --- a/src/merge/resources/filestorage/types/paginated_user_list.py +++ b/src/merge/resources/filestorage/types/paginated_user_list.py @@ -8,9 +8,9 @@ class PaginatedUserList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[User]] + 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 diff --git a/src/merge/resources/filestorage/types/permission.py b/src/merge/resources/filestorage/types/permission.py index 4c7596c6..47958dcb 100644 --- a/src/merge/resources/filestorage/types/permission.py +++ b/src/merge/resources/filestorage/types/permission.py @@ -24,33 +24,33 @@ class Permission(UniversalBaseModel): Fetch from the `GET Files` or `GET Folders` endpoint. Permissions are unexpanded by default. Use the query param `expand=permissions` to see more details. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - user: typing.Optional[PermissionUser] = pydantic.Field() + user: typing.Optional[PermissionUser] = pydantic.Field(default=None) """ The user that is granted this permission. """ - group: typing.Optional[PermissionGroup] = pydantic.Field() + group: typing.Optional[PermissionGroup] = pydantic.Field(default=None) """ The group that is granted this permission. """ - type: typing.Optional[PermissionType] = pydantic.Field() + type: typing.Optional[PermissionType] = pydantic.Field(default=None) """ Denotes what type of people have access to the file. @@ -60,7 +60,7 @@ class Permission(UniversalBaseModel): - `ANYONE` - ANYONE """ - roles: typing.Optional[typing.List[typing.Optional[PermissionRolesItem]]] = pydantic.Field() + roles: typing.Optional[typing.List[typing.Optional[PermissionRolesItem]]] = pydantic.Field(default=None) """ The permissions that the user or group has for the File or Folder. It is possible for a user or group to have multiple roles, such as viewing & uploading. Possible values include: `READ`, `WRITE`, `OWNER`. In cases where there is no clear mapping, the original value passed through will be returned. """ diff --git a/src/merge/resources/filestorage/types/permission_request.py b/src/merge/resources/filestorage/types/permission_request.py index acf54542..6697b3c0 100644 --- a/src/merge/resources/filestorage/types/permission_request.py +++ b/src/merge/resources/filestorage/types/permission_request.py @@ -23,22 +23,22 @@ class PermissionRequest(UniversalBaseModel): Fetch from the `GET Files` or `GET Folders` endpoint. Permissions are unexpanded by default. Use the query param `expand=permissions` to see more details. """ - remote_id: typing.Optional[str] = pydantic.Field() + remote_id: typing.Optional[str] = pydantic.Field(default=None) """ The third-party API ID of the matching object. """ - user: typing.Optional[PermissionRequestUser] = pydantic.Field() + user: typing.Optional[PermissionRequestUser] = pydantic.Field(default=None) """ The user that is granted this permission. """ - group: typing.Optional[PermissionRequestGroup] = pydantic.Field() + group: typing.Optional[PermissionRequestGroup] = pydantic.Field(default=None) """ The group that is granted this permission. """ - type: typing.Optional[PermissionRequestType] = pydantic.Field() + type: typing.Optional[PermissionRequestType] = pydantic.Field(default=None) """ Denotes what type of people have access to the file. @@ -48,13 +48,13 @@ class PermissionRequest(UniversalBaseModel): - `ANYONE` - ANYONE """ - roles: typing.Optional[typing.List[typing.Optional[PermissionRequestRolesItem]]] = pydantic.Field() + roles: typing.Optional[typing.List[typing.Optional[PermissionRequestRolesItem]]] = pydantic.Field(default=None) """ The permissions that the user or group has for the File or Folder. It is possible for a user or group to have multiple roles, such as viewing & uploading. Possible values include: `READ`, `WRITE`, `OWNER`. In cases where there is no clear mapping, the original value passed through will be returned. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/filestorage/types/remote_field_api.py b/src/merge/resources/filestorage/types/remote_field_api.py index 18f2421d..82495d75 100644 --- a/src/merge/resources/filestorage/types/remote_field_api.py +++ b/src/merge/resources/filestorage/types/remote_field_api.py @@ -13,9 +13,9 @@ class RemoteFieldApi(UniversalBaseModel): 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]]] - advanced_metadata: typing.Optional[AdvancedMetadata] - coverage: typing.Optional[RemoteFieldApiCoverage] + example_values: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + advanced_metadata: typing.Optional[AdvancedMetadata] = 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 diff --git a/src/merge/resources/filestorage/types/remote_field_api_response.py b/src/merge/resources/filestorage/types/remote_field_api_response.py index 82889f90..2b52b9dc 100644 --- a/src/merge/resources/filestorage/types/remote_field_api_response.py +++ b/src/merge/resources/filestorage/types/remote_field_api_response.py @@ -8,11 +8,11 @@ class RemoteFieldApiResponse(UniversalBaseModel): - file: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="File") - folder: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Folder") - drive: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Drive") - group: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Group") - user: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="User") + file: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="File", default=None) + folder: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Folder", default=None) + drive: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Drive", default=None) + group: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Group", default=None) + user: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="User", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/filestorage/types/remote_response.py b/src/merge/resources/filestorage/types/remote_response.py index e2d1620d..49988647 100644 --- a/src/merge/resources/filestorage/types/remote_response.py +++ b/src/merge/resources/filestorage/types/remote_response.py @@ -23,10 +23,10 @@ class RemoteResponse(UniversalBaseModel): method: str path: str status: int - response: typing.Optional[typing.Any] - response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - response_type: typing.Optional[ResponseTypeEnum] - headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + response: typing.Optional[typing.Any] = None + response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + response_type: typing.Optional[ResponseTypeEnum] = 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 diff --git a/src/merge/resources/filestorage/types/sync_status.py b/src/merge/resources/filestorage/types/sync_status.py index f9a62229..c1a01c18 100644 --- a/src/merge/resources/filestorage/types/sync_status.py +++ b/src/merge/resources/filestorage/types/sync_status.py @@ -24,11 +24,11 @@ class SyncStatus(UniversalBaseModel): model_name: str model_id: str - last_sync_start: typing.Optional[dt.datetime] - next_sync_start: typing.Optional[dt.datetime] + last_sync_start: typing.Optional[dt.datetime] = None + next_sync_start: typing.Optional[dt.datetime] = None status: SyncStatusStatusEnum is_initial_sync: bool - selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] + 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 diff --git a/src/merge/resources/filestorage/types/user.py b/src/merge/resources/filestorage/types/user.py index 2ab9d78a..fc5d4db3 100644 --- a/src/merge/resources/filestorage/types/user.py +++ b/src/merge/resources/filestorage/types/user.py @@ -20,44 +20,44 @@ class User(UniversalBaseModel): Fetch from the `GET /api/filestorage/v1/users` endpoint and view their users. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The user's name. """ - email_address: typing.Optional[str] = pydantic.Field() + email_address: typing.Optional[str] = pydantic.Field(default=None) """ The user's email address. This is typically used to identify a user across linked accounts. """ - is_me: typing.Optional[bool] = pydantic.Field() + is_me: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the user is the one who linked this account. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[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 diff --git a/src/merge/resources/filestorage/types/warning_validation_problem.py b/src/merge/resources/filestorage/types/warning_validation_problem.py index d508bb6d..140199ca 100644 --- a/src/merge/resources/filestorage/types/warning_validation_problem.py +++ b/src/merge/resources/filestorage/types/warning_validation_problem.py @@ -8,7 +8,7 @@ class WarningValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/filestorage/types/webhook_receiver.py b/src/merge/resources/filestorage/types/webhook_receiver.py index e8cd17aa..ac8573be 100644 --- a/src/merge/resources/filestorage/types/webhook_receiver.py +++ b/src/merge/resources/filestorage/types/webhook_receiver.py @@ -9,7 +9,7 @@ class WebhookReceiver(UniversalBaseModel): event: str is_active: bool - key: typing.Optional[str] + 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 diff --git a/src/merge/resources/hris/types/account_details.py b/src/merge/resources/hris/types/account_details.py index dc91a6f3..aaf3c5e4 100644 --- a/src/merge/resources/hris/types/account_details.py +++ b/src/merge/resources/hris/types/account_details.py @@ -9,22 +9,22 @@ class AccountDetails(UniversalBaseModel): - id: typing.Optional[str] - integration: typing.Optional[str] - integration_slug: typing.Optional[str] - category: typing.Optional[CategoryEnum] - end_user_origin_id: typing.Optional[str] - end_user_organization_name: typing.Optional[str] - end_user_email_address: typing.Optional[str] - status: typing.Optional[str] - webhook_listener_url: typing.Optional[str] - is_duplicate: typing.Optional[bool] = pydantic.Field() + id: typing.Optional[str] = None + integration: typing.Optional[str] = None + integration_slug: typing.Optional[str] = None + category: typing.Optional[CategoryEnum] = None + end_user_origin_id: typing.Optional[str] = None + end_user_organization_name: typing.Optional[str] = None + end_user_email_address: typing.Optional[str] = None + status: typing.Optional[str] = None + webhook_listener_url: typing.Optional[str] = None + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - account_type: typing.Optional[str] - completed_at: typing.Optional[dt.datetime] = pydantic.Field() + account_type: typing.Optional[str] = None + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which account completes the linking flow. """ diff --git a/src/merge/resources/hris/types/account_details_and_actions.py b/src/merge/resources/hris/types/account_details_and_actions.py index 30e78b61..4c96905f 100644 --- a/src/merge/resources/hris/types/account_details_and_actions.py +++ b/src/merge/resources/hris/types/account_details_and_actions.py @@ -24,24 +24,24 @@ class AccountDetailsAndActions(UniversalBaseModel): """ id: str - category: typing.Optional[CategoryEnum] + category: typing.Optional[CategoryEnum] = None status: AccountDetailsAndActionsStatusEnum - status_detail: typing.Optional[str] - end_user_origin_id: typing.Optional[str] + status_detail: typing.Optional[str] = None + end_user_origin_id: typing.Optional[str] = None end_user_organization_name: str end_user_email_address: str - subdomain: typing.Optional[str] = pydantic.Field() + subdomain: typing.Optional[str] = pydantic.Field(default=None) """ The tenant or domain the customer has provided access to. """ webhook_listener_url: str - is_duplicate: typing.Optional[bool] = pydantic.Field() + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - integration: typing.Optional[AccountDetailsAndActionsIntegration] + integration: typing.Optional[AccountDetailsAndActionsIntegration] = None account_type: str completed_at: dt.datetime diff --git a/src/merge/resources/hris/types/account_details_and_actions_integration.py b/src/merge/resources/hris/types/account_details_and_actions_integration.py index 5779ac5b..8e47dbc4 100644 --- a/src/merge/resources/hris/types/account_details_and_actions_integration.py +++ b/src/merge/resources/hris/types/account_details_and_actions_integration.py @@ -11,12 +11,12 @@ class AccountDetailsAndActionsIntegration(UniversalBaseModel): name: str categories: typing.List[CategoriesEnum] - image: typing.Optional[str] - square_image: typing.Optional[str] + image: typing.Optional[str] = None + square_image: typing.Optional[str] = None color: str slug: str passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/hris/types/account_integration.py b/src/merge/resources/hris/types/account_integration.py index 2d18dedb..1dad1594 100644 --- a/src/merge/resources/hris/types/account_integration.py +++ b/src/merge/resources/hris/types/account_integration.py @@ -13,45 +13,45 @@ class AccountIntegration(UniversalBaseModel): Company name. """ - abbreviated_name: typing.Optional[str] = pydantic.Field() + abbreviated_name: typing.Optional[str] = pydantic.Field(default=None) """ Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).

Example: Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors) """ - categories: typing.Optional[typing.List[CategoriesEnum]] = pydantic.Field() + 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() + image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in rectangular shape. """ - square_image: typing.Optional[str] = pydantic.Field() + square_image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in square shape. """ - color: typing.Optional[str] = pydantic.Field() + 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] + slug: typing.Optional[str] = None api_endpoints_to_documentation_urls: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = ( - pydantic.Field() + 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() + 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() + 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. """ diff --git a/src/merge/resources/hris/types/advanced_metadata.py b/src/merge/resources/hris/types/advanced_metadata.py index 6287a842..e570d69f 100644 --- a/src/merge/resources/hris/types/advanced_metadata.py +++ b/src/merge/resources/hris/types/advanced_metadata.py @@ -8,11 +8,11 @@ class AdvancedMetadata(UniversalBaseModel): id: str - display_name: typing.Optional[str] - description: typing.Optional[str] - is_required: typing.Optional[bool] - is_custom: typing.Optional[bool] - field_choices: typing.Optional[typing.List[typing.Optional[typing.Any]]] + 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 diff --git a/src/merge/resources/hris/types/audit_log_event.py b/src/merge/resources/hris/types/audit_log_event.py index b57101fc..1c32586b 100644 --- a/src/merge/resources/hris/types/audit_log_event.py +++ b/src/merge/resources/hris/types/audit_log_event.py @@ -10,13 +10,13 @@ class AuditLogEvent(UniversalBaseModel): - id: typing.Optional[str] - user_name: typing.Optional[str] = pydantic.Field() + 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() + user_email: typing.Optional[str] = pydantic.Field(default=None) """ The User's email at the time of this Event occurring. """ @@ -79,7 +79,7 @@ class AuditLogEvent(UniversalBaseModel): """ event_description: str - created_at: typing.Optional[dt.datetime] + 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 diff --git a/src/merge/resources/hris/types/available_actions.py b/src/merge/resources/hris/types/available_actions.py index 5f164db6..57cee06d 100644 --- a/src/merge/resources/hris/types/available_actions.py +++ b/src/merge/resources/hris/types/available_actions.py @@ -23,7 +23,7 @@ class AvailableActions(UniversalBaseModel): integration: AccountIntegration passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/hris/types/bank_info.py b/src/merge/resources/hris/types/bank_info.py index 0672edeb..662ad57a 100644 --- a/src/merge/resources/hris/types/bank_info.py +++ b/src/merge/resources/hris/types/bank_info.py @@ -28,43 +28,43 @@ class BankInfo(UniversalBaseModel): Fetch from the `LIST BankInfo` endpoint and filter by `ID` to show all bank information. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee: typing.Optional[BankInfoEmployee] = pydantic.Field() + employee: typing.Optional[BankInfoEmployee] = pydantic.Field(default=None) """ The employee with this bank account. """ - account_number: typing.Optional[str] = pydantic.Field() + account_number: typing.Optional[str] = pydantic.Field(default=None) """ The account number. """ - routing_number: typing.Optional[str] = pydantic.Field() + routing_number: typing.Optional[str] = pydantic.Field(default=None) """ The routing number. """ - bank_name: typing.Optional[str] = pydantic.Field() + bank_name: typing.Optional[str] = pydantic.Field(default=None) """ The bank name. """ - account_type: typing.Optional[BankInfoAccountType] = pydantic.Field() + account_type: typing.Optional[BankInfoAccountType] = pydantic.Field(default=None) """ The bank account type @@ -72,18 +72,18 @@ class BankInfo(UniversalBaseModel): - `CHECKING` - CHECKING """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the matching bank object was created in the third party system. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/benefit.py b/src/merge/resources/hris/types/benefit.py index 3c4eb9ab..c3372e49 100644 --- a/src/merge/resources/hris/types/benefit.py +++ b/src/merge/resources/hris/types/benefit.py @@ -27,69 +27,69 @@ class Benefit(UniversalBaseModel): Fetch from the `LIST Benefits` endpoint and filter by `ID` to show all benefits. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee: typing.Optional[BenefitEmployee] = pydantic.Field() + employee: typing.Optional[BenefitEmployee] = pydantic.Field(default=None) """ The employee on the plan. """ - provider_name: typing.Optional[str] = pydantic.Field() + provider_name: typing.Optional[str] = pydantic.Field(default=None) """ The name of the benefit provider. """ - benefit_plan_type: typing.Optional[str] = pydantic.Field() + benefit_plan_type: typing.Optional[str] = pydantic.Field(default=None) """ The type of benefit plan """ - employee_contribution: typing.Optional[float] = pydantic.Field() + employee_contribution: typing.Optional[float] = pydantic.Field(default=None) """ The employee's contribution. """ - company_contribution: typing.Optional[float] = pydantic.Field() + company_contribution: typing.Optional[float] = pydantic.Field(default=None) """ The company's contribution. """ - start_date: typing.Optional[dt.datetime] = pydantic.Field() + start_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time the benefit started. """ - end_date: typing.Optional[dt.datetime] = pydantic.Field() + end_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time the benefit ended. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ - employer_benefit: typing.Optional[str] = pydantic.Field() + employer_benefit: typing.Optional[str] = pydantic.Field(default=None) """ The employer benefit plan the employee is enrolled in. """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/company.py b/src/merge/resources/hris/types/company.py index e3abfd23..73c668cb 100644 --- a/src/merge/resources/hris/types/company.py +++ b/src/merge/resources/hris/types/company.py @@ -21,44 +21,44 @@ class Company(UniversalBaseModel): Fetch from the `LIST Companies` endpoint and filter by `ID` to show all companies. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - legal_name: typing.Optional[str] = pydantic.Field() + legal_name: typing.Optional[str] = pydantic.Field(default=None) """ The company's legal name. """ - display_name: typing.Optional[str] = pydantic.Field() + display_name: typing.Optional[str] = pydantic.Field(default=None) """ The company's display name. """ - eins: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + eins: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The company's Employer Identification Numbers. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/data_passthrough_request.py b/src/merge/resources/hris/types/data_passthrough_request.py index f2718105..2b0595cf 100644 --- a/src/merge/resources/hris/types/data_passthrough_request.py +++ b/src/merge/resources/hris/types/data_passthrough_request.py @@ -28,28 +28,28 @@ class DataPassthroughRequest(UniversalBaseModel): The path of the request in the third party's platform. """ - base_url_override: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + 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[RequestFormatEnum] - normalize_response: typing.Optional[bool] = pydantic.Field() + request_format: typing.Optional[RequestFormatEnum] = 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`. """ diff --git a/src/merge/resources/hris/types/deduction.py b/src/merge/resources/hris/types/deduction.py index 42c5b209..b9ad9d69 100644 --- a/src/merge/resources/hris/types/deduction.py +++ b/src/merge/resources/hris/types/deduction.py @@ -21,45 +21,45 @@ class Deduction(UniversalBaseModel): Fetch from the `LIST Deductions` endpoint and filter by `ID` to show all deductions. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee_payroll_run: typing.Optional[str] - name: typing.Optional[str] = pydantic.Field() + employee_payroll_run: typing.Optional[str] = None + name: typing.Optional[str] = pydantic.Field(default=None) """ The deduction's name. """ - employee_deduction: typing.Optional[float] = pydantic.Field() + employee_deduction: typing.Optional[float] = pydantic.Field(default=None) """ The amount of money that is withheld from an employee's gross pay by the employee. """ - company_deduction: typing.Optional[float] = pydantic.Field() + company_deduction: typing.Optional[float] = pydantic.Field(default=None) """ The amount of money that is withheld on behalf of an employee by the company. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/dependent.py b/src/merge/resources/hris/types/dependent.py index ddb4727f..8dec8299 100644 --- a/src/merge/resources/hris/types/dependent.py +++ b/src/merge/resources/hris/types/dependent.py @@ -23,38 +23,38 @@ class Dependent(UniversalBaseModel): Fetch from the `LIST Dependents` endpoint and filter by `ID` to show all dependents. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The dependents's first name. """ - middle_name: typing.Optional[str] = pydantic.Field() + middle_name: typing.Optional[str] = pydantic.Field(default=None) """ The dependents's middle name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The dependents's last name. """ - relationship: typing.Optional[DependentRelationship] = pydantic.Field() + relationship: typing.Optional[DependentRelationship] = pydantic.Field(default=None) """ The dependent's relationship to the employee. @@ -63,17 +63,17 @@ class Dependent(UniversalBaseModel): - `DOMESTIC_PARTNER` - DOMESTIC_PARTNER """ - employee: typing.Optional[str] = pydantic.Field() + employee: typing.Optional[str] = pydantic.Field(default=None) """ The employee this person is a dependent of. """ - date_of_birth: typing.Optional[dt.datetime] = pydantic.Field() + date_of_birth: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The dependent's date of birth. """ - gender: typing.Optional[DependentGender] = pydantic.Field() + gender: typing.Optional[DependentGender] = pydantic.Field(default=None) """ The dependent's gender. @@ -84,33 +84,33 @@ class Dependent(UniversalBaseModel): - `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE """ - phone_number: typing.Optional[str] = pydantic.Field() + phone_number: typing.Optional[str] = pydantic.Field(default=None) """ The dependent's phone number. """ - home_location: typing.Optional[str] = pydantic.Field() + home_location: typing.Optional[str] = pydantic.Field(default=None) """ The dependents's home address. """ - is_student: typing.Optional[bool] = pydantic.Field() + is_student: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the dependent is a student """ - ssn: typing.Optional[str] = pydantic.Field() + ssn: typing.Optional[str] = pydantic.Field(default=None) """ The dependents's social security number. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/earning.py b/src/merge/resources/hris/types/earning.py index 93beb202..66cd3e2b 100644 --- a/src/merge/resources/hris/types/earning.py +++ b/src/merge/resources/hris/types/earning.py @@ -22,29 +22,29 @@ class Earning(UniversalBaseModel): Fetch from the `LIST Earnings` endpoint and filter by `ID` to show all earnings. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee_payroll_run: typing.Optional[str] - amount: typing.Optional[float] = pydantic.Field() + employee_payroll_run: typing.Optional[str] = None + amount: typing.Optional[float] = pydantic.Field(default=None) """ The amount earned. """ - type: typing.Optional[EarningType] = pydantic.Field() + type: typing.Optional[EarningType] = pydantic.Field(default=None) """ The type of earning. @@ -54,13 +54,13 @@ class Earning(UniversalBaseModel): - `BONUS` - BONUS """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/employee.py b/src/merge/resources/hris/types/employee.py index 8c829bdc..f4d76dd9 100644 --- a/src/merge/resources/hris/types/employee.py +++ b/src/merge/resources/hris/types/employee.py @@ -34,109 +34,109 @@ class Employee(UniversalBaseModel): Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee_number: typing.Optional[str] = pydantic.Field() + employee_number: typing.Optional[str] = pydantic.Field(default=None) """ The employee's number that appears in the third-party integration's UI. """ - company: typing.Optional[EmployeeCompany] = pydantic.Field() + company: typing.Optional[EmployeeCompany] = pydantic.Field(default=None) """ The ID of the employee's company. """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The employee's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The employee's last name. """ - preferred_name: typing.Optional[str] = pydantic.Field() + preferred_name: typing.Optional[str] = pydantic.Field(default=None) """ The employee's preferred first name. """ - display_full_name: typing.Optional[str] = pydantic.Field() + display_full_name: typing.Optional[str] = pydantic.Field(default=None) """ The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. """ - username: typing.Optional[str] = pydantic.Field() + username: typing.Optional[str] = pydantic.Field(default=None) """ The employee's username that appears in the remote UI. """ - groups: typing.Optional[typing.List[typing.Optional[EmployeeGroupsItem]]] - work_email: typing.Optional[str] = pydantic.Field() + groups: typing.Optional[typing.List[typing.Optional[EmployeeGroupsItem]]] = None + work_email: typing.Optional[str] = pydantic.Field(default=None) """ The employee's work email. """ - personal_email: typing.Optional[str] = pydantic.Field() + personal_email: typing.Optional[str] = pydantic.Field(default=None) """ The employee's personal email. """ - mobile_phone_number: typing.Optional[str] = pydantic.Field() + mobile_phone_number: typing.Optional[str] = pydantic.Field(default=None) """ The employee's mobile phone number. """ - employments: typing.Optional[typing.List[typing.Optional["EmployeeEmploymentsItem"]]] = pydantic.Field() + employments: typing.Optional[typing.List[typing.Optional["EmployeeEmploymentsItem"]]] = pydantic.Field(default=None) """ Array of `Employment` IDs for this Employee. """ - home_location: typing.Optional[EmployeeHomeLocation] = pydantic.Field() + home_location: typing.Optional[EmployeeHomeLocation] = pydantic.Field(default=None) """ The employee's home address. """ - work_location: typing.Optional[EmployeeWorkLocation] = pydantic.Field() + work_location: typing.Optional[EmployeeWorkLocation] = pydantic.Field(default=None) """ The employee's work address. """ - manager: typing.Optional["EmployeeManager"] = pydantic.Field() + manager: typing.Optional["EmployeeManager"] = pydantic.Field(default=None) """ The employee ID of the employee's manager. """ - team: typing.Optional[EmployeeTeam] = pydantic.Field() + team: typing.Optional[EmployeeTeam] = pydantic.Field(default=None) """ The employee's team. """ - pay_group: typing.Optional[EmployeePayGroup] = pydantic.Field() + pay_group: typing.Optional[EmployeePayGroup] = pydantic.Field(default=None) """ The employee's pay group """ - ssn: typing.Optional[str] = pydantic.Field() + ssn: typing.Optional[str] = pydantic.Field(default=None) """ The employee's social security number. """ - gender: typing.Optional[EmployeeGender] = pydantic.Field() + gender: typing.Optional[EmployeeGender] = pydantic.Field(default=None) """ The employee's gender. @@ -147,7 +147,7 @@ class Employee(UniversalBaseModel): - `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE """ - ethnicity: typing.Optional[EmployeeEthnicity] = pydantic.Field() + ethnicity: typing.Optional[EmployeeEthnicity] = pydantic.Field(default=None) """ The employee's ethnicity. @@ -161,7 +161,7 @@ class Employee(UniversalBaseModel): - `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE """ - marital_status: typing.Optional[EmployeeMaritalStatus] = pydantic.Field() + marital_status: typing.Optional[EmployeeMaritalStatus] = pydantic.Field(default=None) """ The employee's filing status as related to marital status. @@ -172,27 +172,27 @@ class Employee(UniversalBaseModel): - `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD """ - date_of_birth: typing.Optional[dt.datetime] = pydantic.Field() + date_of_birth: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The employee's date of birth. """ - hire_date: typing.Optional[dt.datetime] = pydantic.Field() + hire_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field. """ - start_date: typing.Optional[dt.datetime] = pydantic.Field() + start_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The date that the employee started working. If an employee was rehired, the most recent start date will be returned. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's employee was created. """ - employment_status: typing.Optional[EmployeeEmploymentStatus] = pydantic.Field() + employment_status: typing.Optional[EmployeeEmploymentStatus] = pydantic.Field(default=None) """ The employment status of the employee. @@ -201,28 +201,28 @@ class Employee(UniversalBaseModel): - `INACTIVE` - INACTIVE """ - termination_date: typing.Optional[dt.datetime] = pydantic.Field() + termination_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The employee's termination date. """ - avatar: typing.Optional[str] = pydantic.Field() + avatar: typing.Optional[str] = pydantic.Field(default=None) """ The URL of the employee's avatar image. """ - custom_fields: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field() + custom_fields: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None) """ Custom fields configured for a given model. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/employee_payroll_run.py b/src/merge/resources/hris/types/employee_payroll_run.py index 51e1f481..726f7f94 100644 --- a/src/merge/resources/hris/types/employee_payroll_run.py +++ b/src/merge/resources/hris/types/employee_payroll_run.py @@ -31,67 +31,67 @@ class EmployeePayrollRun(UniversalBaseModel): Fetch from the `LIST EmployeePayrollRun` endpoint and filter by `ID` to show all employee payroll runs. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee: typing.Optional[EmployeePayrollRunEmployee] = pydantic.Field() + employee: typing.Optional[EmployeePayrollRunEmployee] = pydantic.Field(default=None) """ The employee whose payroll is being run. """ - payroll_run: typing.Optional[EmployeePayrollRunPayrollRun] = pydantic.Field() + payroll_run: typing.Optional[EmployeePayrollRunPayrollRun] = pydantic.Field(default=None) """ The payroll being run. """ - gross_pay: typing.Optional[float] = pydantic.Field() + gross_pay: typing.Optional[float] = pydantic.Field(default=None) """ The total earnings throughout a given period for an employee before any deductions are made. """ - net_pay: typing.Optional[float] = pydantic.Field() + net_pay: typing.Optional[float] = pydantic.Field(default=None) """ The take-home pay throughout a given period for an employee after deductions are made. """ - start_date: typing.Optional[dt.datetime] = pydantic.Field() + start_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time the payroll run started. """ - end_date: typing.Optional[dt.datetime] = pydantic.Field() + end_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time the payroll run ended. """ - check_date: typing.Optional[dt.datetime] = pydantic.Field() + check_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time the payroll run was checked. """ - earnings: typing.Optional[typing.List[Earning]] - deductions: typing.Optional[typing.List[Deduction]] - taxes: typing.Optional[typing.List[Tax]] - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + earnings: typing.Optional[typing.List[Earning]] = None + deductions: typing.Optional[typing.List[Deduction]] = None + taxes: typing.Optional[typing.List[Tax]] = 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/employee_request.py b/src/merge/resources/hris/types/employee_request.py index 97cf559c..15b390f7 100644 --- a/src/merge/resources/hris/types/employee_request.py +++ b/src/merge/resources/hris/types/employee_request.py @@ -37,93 +37,95 @@ class EmployeeRequest(UniversalBaseModel): Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees. """ - employee_number: typing.Optional[str] = pydantic.Field() + employee_number: typing.Optional[str] = pydantic.Field(default=None) """ The employee's number that appears in the third-party integration's UI. """ - company: typing.Optional[EmployeeRequestCompany] = pydantic.Field() + company: typing.Optional[EmployeeRequestCompany] = pydantic.Field(default=None) """ The ID of the employee's company. """ - first_name: typing.Optional[str] = pydantic.Field() + first_name: typing.Optional[str] = pydantic.Field(default=None) """ The employee's first name. """ - last_name: typing.Optional[str] = pydantic.Field() + last_name: typing.Optional[str] = pydantic.Field(default=None) """ The employee's last name. """ - preferred_name: typing.Optional[str] = pydantic.Field() + preferred_name: typing.Optional[str] = pydantic.Field(default=None) """ The employee's preferred first name. """ - display_full_name: typing.Optional[str] = pydantic.Field() + display_full_name: typing.Optional[str] = pydantic.Field(default=None) """ The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. """ - username: typing.Optional[str] = pydantic.Field() + username: typing.Optional[str] = pydantic.Field(default=None) """ The employee's username that appears in the remote UI. """ - groups: typing.Optional[typing.List[typing.Optional[EmployeeRequestGroupsItem]]] - work_email: typing.Optional[str] = pydantic.Field() + groups: typing.Optional[typing.List[typing.Optional[EmployeeRequestGroupsItem]]] = None + work_email: typing.Optional[str] = pydantic.Field(default=None) """ The employee's work email. """ - personal_email: typing.Optional[str] = pydantic.Field() + personal_email: typing.Optional[str] = pydantic.Field(default=None) """ The employee's personal email. """ - mobile_phone_number: typing.Optional[str] = pydantic.Field() + mobile_phone_number: typing.Optional[str] = pydantic.Field(default=None) """ The employee's mobile phone number. """ - employments: typing.Optional[typing.List[typing.Optional[EmployeeRequestEmploymentsItem]]] = pydantic.Field() + employments: typing.Optional[typing.List[typing.Optional[EmployeeRequestEmploymentsItem]]] = pydantic.Field( + default=None + ) """ Array of `Employment` IDs for this Employee. """ - home_location: typing.Optional[EmployeeRequestHomeLocation] = pydantic.Field() + home_location: typing.Optional[EmployeeRequestHomeLocation] = pydantic.Field(default=None) """ The employee's home address. """ - work_location: typing.Optional[EmployeeRequestWorkLocation] = pydantic.Field() + work_location: typing.Optional[EmployeeRequestWorkLocation] = pydantic.Field(default=None) """ The employee's work address. """ - manager: typing.Optional[EmployeeRequestManager] = pydantic.Field() + manager: typing.Optional[EmployeeRequestManager] = pydantic.Field(default=None) """ The employee ID of the employee's manager. """ - team: typing.Optional[EmployeeRequestTeam] = pydantic.Field() + team: typing.Optional[EmployeeRequestTeam] = pydantic.Field(default=None) """ The employee's team. """ - pay_group: typing.Optional[EmployeeRequestPayGroup] = pydantic.Field() + pay_group: typing.Optional[EmployeeRequestPayGroup] = pydantic.Field(default=None) """ The employee's pay group """ - ssn: typing.Optional[str] = pydantic.Field() + ssn: typing.Optional[str] = pydantic.Field(default=None) """ The employee's social security number. """ - gender: typing.Optional[EmployeeRequestGender] = pydantic.Field() + gender: typing.Optional[EmployeeRequestGender] = pydantic.Field(default=None) """ The employee's gender. @@ -134,7 +136,7 @@ class EmployeeRequest(UniversalBaseModel): - `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE """ - ethnicity: typing.Optional[EmployeeRequestEthnicity] = pydantic.Field() + ethnicity: typing.Optional[EmployeeRequestEthnicity] = pydantic.Field(default=None) """ The employee's ethnicity. @@ -148,7 +150,7 @@ class EmployeeRequest(UniversalBaseModel): - `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE """ - marital_status: typing.Optional[EmployeeRequestMaritalStatus] = pydantic.Field() + marital_status: typing.Optional[EmployeeRequestMaritalStatus] = pydantic.Field(default=None) """ The employee's filing status as related to marital status. @@ -159,22 +161,22 @@ class EmployeeRequest(UniversalBaseModel): - `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD """ - date_of_birth: typing.Optional[dt.datetime] = pydantic.Field() + date_of_birth: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The employee's date of birth. """ - hire_date: typing.Optional[dt.datetime] = pydantic.Field() + hire_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field. """ - start_date: typing.Optional[dt.datetime] = pydantic.Field() + start_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The date that the employee started working. If an employee was rehired, the most recent start date will be returned. """ - employment_status: typing.Optional[EmployeeRequestEmploymentStatus] = pydantic.Field() + employment_status: typing.Optional[EmployeeRequestEmploymentStatus] = pydantic.Field(default=None) """ The employment status of the employee. @@ -183,18 +185,18 @@ class EmployeeRequest(UniversalBaseModel): - `INACTIVE` - INACTIVE """ - termination_date: typing.Optional[dt.datetime] = pydantic.Field() + termination_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The employee's termination date. """ - avatar: typing.Optional[str] = pydantic.Field() + avatar: typing.Optional[str] = pydantic.Field(default=None) """ The URL of the employee's avatar image. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/hris/types/employee_response.py b/src/merge/resources/hris/types/employee_response.py index e236db18..268c78fb 100644 --- a/src/merge/resources/hris/types/employee_response.py +++ b/src/merge/resources/hris/types/employee_response.py @@ -18,7 +18,7 @@ class EmployeeResponse(UniversalBaseModel): model: Employee warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/hris/types/employer_benefit.py b/src/merge/resources/hris/types/employer_benefit.py index 6bb942d1..0b68d916 100644 --- a/src/merge/resources/hris/types/employer_benefit.py +++ b/src/merge/resources/hris/types/employer_benefit.py @@ -21,23 +21,23 @@ class EmployerBenefit(UniversalBaseModel): Fetch from the `LIST EmployerBenefits` endpoint and filter by `ID` to show all EmployerBenefits. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - benefit_plan_type: typing.Optional[EmployerBenefitBenefitPlanType] = pydantic.Field() + benefit_plan_type: typing.Optional[EmployerBenefitBenefitPlanType] = pydantic.Field(default=None) """ The type of benefit plan. @@ -48,28 +48,28 @@ class EmployerBenefit(UniversalBaseModel): - `OTHER` - OTHER """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The employer benefit's name - typically the carrier or network name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The employer benefit's description. """ - deduction_code: typing.Optional[str] = pydantic.Field() + deduction_code: typing.Optional[str] = pydantic.Field(default=None) """ The employer benefit's deduction code. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[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 diff --git a/src/merge/resources/hris/types/employment.py b/src/merge/resources/hris/types/employment.py index ccf4bfda..fa18fe63 100644 --- a/src/merge/resources/hris/types/employment.py +++ b/src/merge/resources/hris/types/employment.py @@ -32,38 +32,38 @@ class Employment(UniversalBaseModel): Fetch from the `LIST Employments` endpoint and filter by `ID` to show all employees. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee: typing.Optional["EmploymentEmployee"] = pydantic.Field() + employee: typing.Optional["EmploymentEmployee"] = pydantic.Field(default=None) """ The employee holding this position. """ - job_title: typing.Optional[str] = pydantic.Field() + job_title: typing.Optional[str] = pydantic.Field(default=None) """ The position's title. """ - pay_rate: typing.Optional[float] = pydantic.Field() + pay_rate: typing.Optional[float] = pydantic.Field(default=None) """ The position's pay rate. """ - pay_period: typing.Optional[EmploymentPayPeriod] = pydantic.Field() + pay_period: typing.Optional[EmploymentPayPeriod] = pydantic.Field(default=None) """ The time period this pay rate encompasses. @@ -78,7 +78,7 @@ class Employment(UniversalBaseModel): - `YEAR` - YEAR """ - pay_frequency: typing.Optional[EmploymentPayFrequency] = pydantic.Field() + pay_frequency: typing.Optional[EmploymentPayFrequency] = pydantic.Field(default=None) """ The position's pay frequency. @@ -93,7 +93,7 @@ class Employment(UniversalBaseModel): - `SEMIMONTHLY` - SEMIMONTHLY """ - pay_currency: typing.Optional[EmploymentPayCurrency] = pydantic.Field() + pay_currency: typing.Optional[EmploymentPayCurrency] = pydantic.Field(default=None) """ The position's currency code. @@ -405,12 +405,12 @@ class Employment(UniversalBaseModel): - `ZWL` - Zimbabwean Dollar (2009) """ - pay_group: typing.Optional[EmploymentPayGroup] = pydantic.Field() + pay_group: typing.Optional[EmploymentPayGroup] = pydantic.Field(default=None) """ The employment's pay group """ - flsa_status: typing.Optional[EmploymentFlsaStatus] = pydantic.Field() + flsa_status: typing.Optional[EmploymentFlsaStatus] = pydantic.Field(default=None) """ The position's FLSA status. @@ -420,12 +420,12 @@ class Employment(UniversalBaseModel): - `OWNER` - OWNER """ - effective_date: typing.Optional[dt.datetime] = pydantic.Field() + effective_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The position's effective date. """ - employment_type: typing.Optional[EmploymentEmploymentType] = pydantic.Field() + employment_type: typing.Optional[EmploymentEmploymentType] = pydantic.Field(default=None) """ The position's type of employment. @@ -436,13 +436,13 @@ class Employment(UniversalBaseModel): - `FREELANCE` - FREELANCE """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/error_validation_problem.py b/src/merge/resources/hris/types/error_validation_problem.py index 58ea87e6..91565918 100644 --- a/src/merge/resources/hris/types/error_validation_problem.py +++ b/src/merge/resources/hris/types/error_validation_problem.py @@ -8,7 +8,7 @@ class ErrorValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/hris/types/external_target_field_api.py b/src/merge/resources/hris/types/external_target_field_api.py index 18988d44..1ed19a99 100644 --- a/src/merge/resources/hris/types/external_target_field_api.py +++ b/src/merge/resources/hris/types/external_target_field_api.py @@ -7,9 +7,9 @@ class ExternalTargetFieldApi(UniversalBaseModel): - name: typing.Optional[str] - description: typing.Optional[str] - is_mapped: typing.Optional[str] + 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 diff --git a/src/merge/resources/hris/types/external_target_field_api_response.py b/src/merge/resources/hris/types/external_target_field_api_response.py index bb1b09a4..bc0c5e67 100644 --- a/src/merge/resources/hris/types/external_target_field_api_response.py +++ b/src/merge/resources/hris/types/external_target_field_api_response.py @@ -8,24 +8,30 @@ class ExternalTargetFieldApiResponse(UniversalBaseModel): - benefit: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Benefit") - employer_benefit: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="EmployerBenefit") - company: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Company") + benefit: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Benefit", default=None) + employer_benefit: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="EmployerBenefit", default=None + ) + company: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Company", default=None) employee_payroll_run: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( - alias="EmployeePayrollRun" + alias="EmployeePayrollRun", default=None + ) + employee: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Employee", default=None) + employment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Employment", default=None) + location: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Location", default=None) + payroll_run: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="PayrollRun", default=None) + team: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Team", default=None) + time_off: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="TimeOff", default=None) + time_off_balance: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="TimeOffBalance", default=None + ) + bank_info: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="BankInfo", default=None) + pay_group: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="PayGroup", default=None) + group: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Group", default=None) + dependent: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Dependent", default=None) + timesheet_entry: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field( + alias="TimesheetEntry", default=None ) - employee: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Employee") - employment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Employment") - location: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Location") - payroll_run: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="PayrollRun") - team: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Team") - time_off: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="TimeOff") - time_off_balance: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="TimeOffBalance") - bank_info: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="BankInfo") - pay_group: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="PayGroup") - group: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Group") - dependent: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Dependent") - timesheet_entry: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="TimesheetEntry") if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/field_mapping_api_instance.py b/src/merge/resources/hris/types/field_mapping_api_instance.py index ef4d9c48..1cc2f4a2 100644 --- a/src/merge/resources/hris/types/field_mapping_api_instance.py +++ b/src/merge/resources/hris/types/field_mapping_api_instance.py @@ -9,10 +9,10 @@ class FieldMappingApiInstance(UniversalBaseModel): - id: typing.Optional[str] - is_integration_wide: typing.Optional[bool] - target_field: typing.Optional[FieldMappingApiInstanceTargetField] - remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] + id: typing.Optional[str] = None + is_integration_wide: typing.Optional[bool] = None + target_field: typing.Optional[FieldMappingApiInstanceTargetField] = None + remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py b/src/merge/resources/hris/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py index 14c37c76..9eeb4fbf 100644 --- a/src/merge/resources/hris/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py +++ b/src/merge/resources/hris/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py @@ -7,9 +7,9 @@ class FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo(UniversalBaseModel): - method: typing.Optional[str] - url_path: typing.Optional[str] - field_traversal_path: typing.Optional[typing.List[str]] + 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 diff --git a/src/merge/resources/hris/types/field_mapping_api_instance_response.py b/src/merge/resources/hris/types/field_mapping_api_instance_response.py index 0a6a02d9..0a346732 100644 --- a/src/merge/resources/hris/types/field_mapping_api_instance_response.py +++ b/src/merge/resources/hris/types/field_mapping_api_instance_response.py @@ -8,24 +8,32 @@ class FieldMappingApiInstanceResponse(UniversalBaseModel): - benefit: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Benefit") - employer_benefit: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="EmployerBenefit") - company: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Company") + benefit: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Benefit", default=None) + employer_benefit: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="EmployerBenefit", default=None + ) + company: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Company", default=None) employee_payroll_run: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( - alias="EmployeePayrollRun" + alias="EmployeePayrollRun", default=None + ) + employee: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Employee", default=None) + employment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Employment", default=None) + location: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Location", default=None) + payroll_run: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="PayrollRun", default=None + ) + team: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Team", default=None) + time_off: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="TimeOff", default=None) + time_off_balance: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="TimeOffBalance", default=None + ) + bank_info: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="BankInfo", default=None) + pay_group: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="PayGroup", default=None) + group: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Group", default=None) + dependent: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Dependent", default=None) + timesheet_entry: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field( + alias="TimesheetEntry", default=None ) - employee: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Employee") - employment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Employment") - location: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Location") - payroll_run: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="PayrollRun") - team: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Team") - time_off: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="TimeOff") - time_off_balance: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="TimeOffBalance") - bank_info: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="BankInfo") - pay_group: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="PayGroup") - group: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Group") - dependent: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Dependent") - timesheet_entry: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="TimesheetEntry") if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/field_mapping_instance_response.py b/src/merge/resources/hris/types/field_mapping_instance_response.py index a56aeb93..2123f4d3 100644 --- a/src/merge/resources/hris/types/field_mapping_instance_response.py +++ b/src/merge/resources/hris/types/field_mapping_instance_response.py @@ -14,7 +14,7 @@ class FieldMappingInstanceResponse(UniversalBaseModel): model: FieldMappingApiInstance warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/hris/types/field_permission_deserializer.py b/src/merge/resources/hris/types/field_permission_deserializer.py index 9670537a..ea7cc235 100644 --- a/src/merge/resources/hris/types/field_permission_deserializer.py +++ b/src/merge/resources/hris/types/field_permission_deserializer.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializer(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/hris/types/field_permission_deserializer_request.py b/src/merge/resources/hris/types/field_permission_deserializer_request.py index 04e14608..e5617ad6 100644 --- a/src/merge/resources/hris/types/field_permission_deserializer_request.py +++ b/src/merge/resources/hris/types/field_permission_deserializer_request.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializerRequest(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/hris/types/group.py b/src/merge/resources/hris/types/group.py index 2960406f..58f925ae 100644 --- a/src/merge/resources/hris/types/group.py +++ b/src/merge/resources/hris/types/group.py @@ -22,33 +22,33 @@ class Group(UniversalBaseModel): Fetch from the `LIST Employee` endpoint and expand groups to view an employee's groups. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - parent_group: typing.Optional[str] = pydantic.Field() + parent_group: typing.Optional[str] = pydantic.Field(default=None) """ The parent group for this group. """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The group name. """ - type: typing.Optional[GroupType] = pydantic.Field() + type: typing.Optional[GroupType] = pydantic.Field(default=None) """ The Group type returned directly from the third-party. @@ -59,18 +59,18 @@ class Group(UniversalBaseModel): - `GROUP` - GROUP """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ - is_commonly_used_as_team: typing.Optional[bool] = pydantic.Field() + is_commonly_used_as_team: typing.Optional[bool] = pydantic.Field(default=None) """ Indicates whether the Group refers to a team in the third party platform. Note that this is an opinionated view based on how Merge observes most organizations representing teams in each third party platform. If your customer uses a platform different from most, there is a chance this will not be correct. """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/individual_common_model_scope_deserializer.py b/src/merge/resources/hris/types/individual_common_model_scope_deserializer.py index 122df11c..70704314 100644 --- a/src/merge/resources/hris/types/individual_common_model_scope_deserializer.py +++ b/src/merge/resources/hris/types/individual_common_model_scope_deserializer.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializer(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializer]] - field_permissions: typing.Optional[FieldPermissionDeserializer] + 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 diff --git a/src/merge/resources/hris/types/individual_common_model_scope_deserializer_request.py b/src/merge/resources/hris/types/individual_common_model_scope_deserializer_request.py index a1a80902..d42dd53a 100644 --- a/src/merge/resources/hris/types/individual_common_model_scope_deserializer_request.py +++ b/src/merge/resources/hris/types/individual_common_model_scope_deserializer_request.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializerRequest(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializerRequest]] - field_permissions: typing.Optional[FieldPermissionDeserializerRequest] + 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 diff --git a/src/merge/resources/hris/types/issue.py b/src/merge/resources/hris/types/issue.py index 5a584515..7adc1f31 100644 --- a/src/merge/resources/hris/types/issue.py +++ b/src/merge/resources/hris/types/issue.py @@ -9,8 +9,8 @@ class Issue(UniversalBaseModel): - id: typing.Optional[str] - status: typing.Optional[IssueStatus] = pydantic.Field() + id: typing.Optional[str] = None + status: typing.Optional[IssueStatus] = pydantic.Field(default=None) """ Status of the issue. Options: ('ONGOING', 'RESOLVED') @@ -19,11 +19,11 @@ class Issue(UniversalBaseModel): """ error_description: str - end_user: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - first_incident_time: typing.Optional[dt.datetime] - last_incident_time: typing.Optional[dt.datetime] - is_muted: typing.Optional[bool] - error_details: typing.Optional[typing.List[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 diff --git a/src/merge/resources/hris/types/link_token.py b/src/merge/resources/hris/types/link_token.py index 1d25dddb..ac916d14 100644 --- a/src/merge/resources/hris/types/link_token.py +++ b/src/merge/resources/hris/types/link_token.py @@ -8,8 +8,8 @@ class LinkToken(UniversalBaseModel): link_token: str - integration_name: typing.Optional[str] - magic_link_url: typing.Optional[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 diff --git a/src/merge/resources/hris/types/location.py b/src/merge/resources/hris/types/location.py index 61359746..2a0f6b30 100644 --- a/src/merge/resources/hris/types/location.py +++ b/src/merge/resources/hris/types/location.py @@ -23,58 +23,58 @@ class Location(UniversalBaseModel): Fetch from the `LIST Locations` endpoint and filter by `ID` to show all office locations. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The location's name. """ - phone_number: typing.Optional[str] = pydantic.Field() + phone_number: typing.Optional[str] = pydantic.Field(default=None) """ The location's phone number. """ - street_1: typing.Optional[str] = pydantic.Field() + street_1: typing.Optional[str] = pydantic.Field(default=None) """ Line 1 of the location's street address. """ - street_2: typing.Optional[str] = pydantic.Field() + street_2: typing.Optional[str] = pydantic.Field(default=None) """ Line 2 of the location's street address. """ - city: typing.Optional[str] = pydantic.Field() + city: typing.Optional[str] = pydantic.Field(default=None) """ The location's city. """ - state: typing.Optional[str] = pydantic.Field() + state: typing.Optional[str] = pydantic.Field(default=None) """ The location's state. Represents a region if outside of the US. """ - zip_code: typing.Optional[str] = pydantic.Field() + zip_code: typing.Optional[str] = pydantic.Field(default=None) """ The location's zip code or postal code. """ - country: typing.Optional[LocationCountry] = pydantic.Field() + country: typing.Optional[LocationCountry] = pydantic.Field(default=None) """ The location's country. @@ -329,7 +329,7 @@ class Location(UniversalBaseModel): - `ZW` - Zimbabwe """ - location_type: typing.Optional[LocationLocationType] = pydantic.Field() + location_type: typing.Optional[LocationLocationType] = pydantic.Field(default=None) """ The location's type. Can be either WORK or HOME @@ -337,13 +337,13 @@ class Location(UniversalBaseModel): - `WORK` - WORK """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/meta_response.py b/src/merge/resources/hris/types/meta_response.py index 44e57fde..272535f0 100644 --- a/src/merge/resources/hris/types/meta_response.py +++ b/src/merge/resources/hris/types/meta_response.py @@ -9,8 +9,8 @@ class MetaResponse(UniversalBaseModel): request_schema: typing.Dict[str, typing.Optional[typing.Any]] - remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - status: typing.Optional[LinkedAccountStatus] + remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + status: typing.Optional[LinkedAccountStatus] = None has_conditional_params: bool has_required_linked_account_params: bool diff --git a/src/merge/resources/hris/types/model_permission_deserializer.py b/src/merge/resources/hris/types/model_permission_deserializer.py index b6d813e4..96f39e63 100644 --- a/src/merge/resources/hris/types/model_permission_deserializer.py +++ b/src/merge/resources/hris/types/model_permission_deserializer.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializer(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/hris/types/model_permission_deserializer_request.py b/src/merge/resources/hris/types/model_permission_deserializer_request.py index 5885627b..2619fb6a 100644 --- a/src/merge/resources/hris/types/model_permission_deserializer_request.py +++ b/src/merge/resources/hris/types/model_permission_deserializer_request.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializerRequest(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/hris/types/multipart_form_field_request.py b/src/merge/resources/hris/types/multipart_form_field_request.py index 80099016..507fa8c6 100644 --- a/src/merge/resources/hris/types/multipart_form_field_request.py +++ b/src/merge/resources/hris/types/multipart_form_field_request.py @@ -30,7 +30,7 @@ class MultipartFormFieldRequest(UniversalBaseModel): The data for the form field. """ - encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field() + encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field(default=None) """ The encoding of the value of `data`. Defaults to `RAW` if not defined. @@ -39,12 +39,12 @@ class MultipartFormFieldRequest(UniversalBaseModel): - `GZIP_BASE64` - GZIP_BASE64 """ - file_name: typing.Optional[str] = pydantic.Field() + 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() + content_type: typing.Optional[str] = pydantic.Field(default=None) """ The MIME type of the file, if the field is for a file. """ diff --git a/src/merge/resources/hris/types/paginated_account_details_and_actions_list.py b/src/merge/resources/hris/types/paginated_account_details_and_actions_list.py index a9128c76..00ceeda5 100644 --- a/src/merge/resources/hris/types/paginated_account_details_and_actions_list.py +++ b/src/merge/resources/hris/types/paginated_account_details_and_actions_list.py @@ -8,9 +8,9 @@ class PaginatedAccountDetailsAndActionsList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AccountDetailsAndActions]] + 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 diff --git a/src/merge/resources/hris/types/paginated_audit_log_event_list.py b/src/merge/resources/hris/types/paginated_audit_log_event_list.py index a50b7c75..450de68c 100644 --- a/src/merge/resources/hris/types/paginated_audit_log_event_list.py +++ b/src/merge/resources/hris/types/paginated_audit_log_event_list.py @@ -8,9 +8,9 @@ class PaginatedAuditLogEventList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AuditLogEvent]] + 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 diff --git a/src/merge/resources/hris/types/paginated_bank_info_list.py b/src/merge/resources/hris/types/paginated_bank_info_list.py index fa3f1b55..9028cefd 100644 --- a/src/merge/resources/hris/types/paginated_bank_info_list.py +++ b/src/merge/resources/hris/types/paginated_bank_info_list.py @@ -13,9 +13,9 @@ class PaginatedBankInfoList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[BankInfo]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[BankInfo]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_benefit_list.py b/src/merge/resources/hris/types/paginated_benefit_list.py index 870f427f..9b2374b7 100644 --- a/src/merge/resources/hris/types/paginated_benefit_list.py +++ b/src/merge/resources/hris/types/paginated_benefit_list.py @@ -13,9 +13,9 @@ class PaginatedBenefitList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Benefit]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Benefit]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_company_list.py b/src/merge/resources/hris/types/paginated_company_list.py index 50d74736..96a71f48 100644 --- a/src/merge/resources/hris/types/paginated_company_list.py +++ b/src/merge/resources/hris/types/paginated_company_list.py @@ -8,9 +8,9 @@ class PaginatedCompanyList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Company]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Company]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_dependent_list.py b/src/merge/resources/hris/types/paginated_dependent_list.py index a94519fd..f6f0f186 100644 --- a/src/merge/resources/hris/types/paginated_dependent_list.py +++ b/src/merge/resources/hris/types/paginated_dependent_list.py @@ -8,9 +8,9 @@ class PaginatedDependentList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Dependent]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Dependent]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_employee_list.py b/src/merge/resources/hris/types/paginated_employee_list.py index 4a0ffcc7..43344996 100644 --- a/src/merge/resources/hris/types/paginated_employee_list.py +++ b/src/merge/resources/hris/types/paginated_employee_list.py @@ -12,9 +12,9 @@ class PaginatedEmployeeList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Employee]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Employee]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_employee_payroll_run_list.py b/src/merge/resources/hris/types/paginated_employee_payroll_run_list.py index 8bc6e867..6db4a0ae 100644 --- a/src/merge/resources/hris/types/paginated_employee_payroll_run_list.py +++ b/src/merge/resources/hris/types/paginated_employee_payroll_run_list.py @@ -13,9 +13,9 @@ class PaginatedEmployeePayrollRunList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[EmployeePayrollRun]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[EmployeePayrollRun]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_employer_benefit_list.py b/src/merge/resources/hris/types/paginated_employer_benefit_list.py index 5c256281..f7f494d4 100644 --- a/src/merge/resources/hris/types/paginated_employer_benefit_list.py +++ b/src/merge/resources/hris/types/paginated_employer_benefit_list.py @@ -8,9 +8,9 @@ class PaginatedEmployerBenefitList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[EmployerBenefit]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[EmployerBenefit]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_employment_list.py b/src/merge/resources/hris/types/paginated_employment_list.py index ce1fbc5f..baf262a2 100644 --- a/src/merge/resources/hris/types/paginated_employment_list.py +++ b/src/merge/resources/hris/types/paginated_employment_list.py @@ -12,9 +12,9 @@ class PaginatedEmploymentList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Employment]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Employment]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_group_list.py b/src/merge/resources/hris/types/paginated_group_list.py index 72413a02..fbe99b23 100644 --- a/src/merge/resources/hris/types/paginated_group_list.py +++ b/src/merge/resources/hris/types/paginated_group_list.py @@ -8,9 +8,9 @@ class PaginatedGroupList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Group]] + 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 diff --git a/src/merge/resources/hris/types/paginated_issue_list.py b/src/merge/resources/hris/types/paginated_issue_list.py index 12b866d9..758e6dc3 100644 --- a/src/merge/resources/hris/types/paginated_issue_list.py +++ b/src/merge/resources/hris/types/paginated_issue_list.py @@ -8,9 +8,9 @@ class PaginatedIssueList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Issue]] + 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 diff --git a/src/merge/resources/hris/types/paginated_location_list.py b/src/merge/resources/hris/types/paginated_location_list.py index b18f4377..f030dbda 100644 --- a/src/merge/resources/hris/types/paginated_location_list.py +++ b/src/merge/resources/hris/types/paginated_location_list.py @@ -8,9 +8,9 @@ class PaginatedLocationList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Location]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Location]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_pay_group_list.py b/src/merge/resources/hris/types/paginated_pay_group_list.py index d3bd0428..966590be 100644 --- a/src/merge/resources/hris/types/paginated_pay_group_list.py +++ b/src/merge/resources/hris/types/paginated_pay_group_list.py @@ -8,9 +8,9 @@ class PaginatedPayGroupList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[PayGroup]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[PayGroup]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_payroll_run_list.py b/src/merge/resources/hris/types/paginated_payroll_run_list.py index 53813ecb..b63fd430 100644 --- a/src/merge/resources/hris/types/paginated_payroll_run_list.py +++ b/src/merge/resources/hris/types/paginated_payroll_run_list.py @@ -8,9 +8,9 @@ class PaginatedPayrollRunList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[PayrollRun]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[PayrollRun]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_sync_status_list.py b/src/merge/resources/hris/types/paginated_sync_status_list.py index f59f2c9a..f4f09ed1 100644 --- a/src/merge/resources/hris/types/paginated_sync_status_list.py +++ b/src/merge/resources/hris/types/paginated_sync_status_list.py @@ -8,9 +8,9 @@ class PaginatedSyncStatusList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[SyncStatus]] + 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 diff --git a/src/merge/resources/hris/types/paginated_team_list.py b/src/merge/resources/hris/types/paginated_team_list.py index 45435d16..b0b61610 100644 --- a/src/merge/resources/hris/types/paginated_team_list.py +++ b/src/merge/resources/hris/types/paginated_team_list.py @@ -10,9 +10,9 @@ class PaginatedTeamList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Team]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Team]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_time_off_balance_list.py b/src/merge/resources/hris/types/paginated_time_off_balance_list.py index d14fb360..df31d862 100644 --- a/src/merge/resources/hris/types/paginated_time_off_balance_list.py +++ b/src/merge/resources/hris/types/paginated_time_off_balance_list.py @@ -13,9 +13,9 @@ class PaginatedTimeOffBalanceList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[TimeOffBalance]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[TimeOffBalance]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_time_off_list.py b/src/merge/resources/hris/types/paginated_time_off_list.py index 227265ac..4bb35e28 100644 --- a/src/merge/resources/hris/types/paginated_time_off_list.py +++ b/src/merge/resources/hris/types/paginated_time_off_list.py @@ -13,9 +13,9 @@ class PaginatedTimeOffList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[TimeOff]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[TimeOff]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/paginated_timesheet_entry_list.py b/src/merge/resources/hris/types/paginated_timesheet_entry_list.py index df50bc37..c359471e 100644 --- a/src/merge/resources/hris/types/paginated_timesheet_entry_list.py +++ b/src/merge/resources/hris/types/paginated_timesheet_entry_list.py @@ -8,9 +8,9 @@ class PaginatedTimesheetEntryList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[TimesheetEntry]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[TimesheetEntry]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/pay_group.py b/src/merge/resources/hris/types/pay_group.py index 469464fb..7fa2fb24 100644 --- a/src/merge/resources/hris/types/pay_group.py +++ b/src/merge/resources/hris/types/pay_group.py @@ -21,34 +21,34 @@ class PayGroup(UniversalBaseModel): Fetch from the `LIST PayGroup` endpoint and filter by `ID` to show all pay group information. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - pay_group_name: typing.Optional[str] = pydantic.Field() + pay_group_name: typing.Optional[str] = pydantic.Field(default=None) """ The pay group name. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/payroll_run.py b/src/merge/resources/hris/types/payroll_run.py index 295fa29f..f52b6eda 100644 --- a/src/merge/resources/hris/types/payroll_run.py +++ b/src/merge/resources/hris/types/payroll_run.py @@ -23,23 +23,23 @@ class PayrollRun(UniversalBaseModel): Fetch from the `LIST PayrollRuns` endpoint and filter by `ID` to show all payroll runs. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - run_state: typing.Optional[PayrollRunRunState] = pydantic.Field() + run_state: typing.Optional[PayrollRunRunState] = pydantic.Field(default=None) """ The state of the payroll run @@ -50,7 +50,7 @@ class PayrollRun(UniversalBaseModel): - `CLOSED` - CLOSED """ - run_type: typing.Optional[PayrollRunRunType] = pydantic.Field() + run_type: typing.Optional[PayrollRunRunType] = pydantic.Field(default=None) """ The type of the payroll run @@ -61,28 +61,28 @@ class PayrollRun(UniversalBaseModel): - `SIGN_ON_BONUS` - SIGN_ON_BONUS """ - start_date: typing.Optional[dt.datetime] = pydantic.Field() + start_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time the payroll run started. """ - end_date: typing.Optional[dt.datetime] = pydantic.Field() + end_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time the payroll run ended. """ - check_date: typing.Optional[dt.datetime] = pydantic.Field() + check_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time the payroll run was checked. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/remote_data.py b/src/merge/resources/hris/types/remote_data.py index 27c2a5f2..09a6b50b 100644 --- a/src/merge/resources/hris/types/remote_data.py +++ b/src/merge/resources/hris/types/remote_data.py @@ -8,7 +8,7 @@ class RemoteData(UniversalBaseModel): path: str - data: typing.Optional[typing.Optional[typing.Any]] + data: typing.Optional[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 diff --git a/src/merge/resources/hris/types/remote_field_api.py b/src/merge/resources/hris/types/remote_field_api.py index 18f2421d..82495d75 100644 --- a/src/merge/resources/hris/types/remote_field_api.py +++ b/src/merge/resources/hris/types/remote_field_api.py @@ -13,9 +13,9 @@ class RemoteFieldApi(UniversalBaseModel): 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]]] - advanced_metadata: typing.Optional[AdvancedMetadata] - coverage: typing.Optional[RemoteFieldApiCoverage] + example_values: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + advanced_metadata: typing.Optional[AdvancedMetadata] = 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 diff --git a/src/merge/resources/hris/types/remote_field_api_response.py b/src/merge/resources/hris/types/remote_field_api_response.py index 5ecb4ff5..42e7706f 100644 --- a/src/merge/resources/hris/types/remote_field_api_response.py +++ b/src/merge/resources/hris/types/remote_field_api_response.py @@ -8,22 +8,28 @@ class RemoteFieldApiResponse(UniversalBaseModel): - benefit: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Benefit") - employer_benefit: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="EmployerBenefit") - company: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Company") - employee_payroll_run: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="EmployeePayrollRun") - employee: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Employee") - employment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Employment") - location: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Location") - payroll_run: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="PayrollRun") - team: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Team") - time_off: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="TimeOff") - time_off_balance: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="TimeOffBalance") - bank_info: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="BankInfo") - pay_group: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="PayGroup") - group: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Group") - dependent: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Dependent") - timesheet_entry: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="TimesheetEntry") + benefit: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Benefit", default=None) + employer_benefit: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="EmployerBenefit", default=None + ) + company: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Company", default=None) + employee_payroll_run: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="EmployeePayrollRun", default=None + ) + employee: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Employee", default=None) + employment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Employment", default=None) + location: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Location", default=None) + payroll_run: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="PayrollRun", default=None) + team: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Team", default=None) + time_off: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="TimeOff", default=None) + time_off_balance: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field( + alias="TimeOffBalance", default=None + ) + bank_info: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="BankInfo", default=None) + pay_group: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="PayGroup", default=None) + group: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Group", default=None) + dependent: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Dependent", default=None) + timesheet_entry: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="TimesheetEntry", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/hris/types/remote_response.py b/src/merge/resources/hris/types/remote_response.py index 4c9da086..a109efce 100644 --- a/src/merge/resources/hris/types/remote_response.py +++ b/src/merge/resources/hris/types/remote_response.py @@ -23,10 +23,10 @@ class RemoteResponse(UniversalBaseModel): method: str path: str status: int - response: typing.Optional[typing.Any] - response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - response_type: typing.Optional[RemoteResponseResponseType] - headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + 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 diff --git a/src/merge/resources/hris/types/sync_status.py b/src/merge/resources/hris/types/sync_status.py index f9a62229..c1a01c18 100644 --- a/src/merge/resources/hris/types/sync_status.py +++ b/src/merge/resources/hris/types/sync_status.py @@ -24,11 +24,11 @@ class SyncStatus(UniversalBaseModel): model_name: str model_id: str - last_sync_start: typing.Optional[dt.datetime] - next_sync_start: typing.Optional[dt.datetime] + last_sync_start: typing.Optional[dt.datetime] = None + next_sync_start: typing.Optional[dt.datetime] = None status: SyncStatusStatusEnum is_initial_sync: bool - selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] + 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 diff --git a/src/merge/resources/hris/types/tax.py b/src/merge/resources/hris/types/tax.py index 965c5297..9a838b73 100644 --- a/src/merge/resources/hris/types/tax.py +++ b/src/merge/resources/hris/types/tax.py @@ -21,45 +21,45 @@ class Tax(UniversalBaseModel): Fetch from the `LIST Taxes` endpoint and filter by `ID` to show all taxes. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee_payroll_run: typing.Optional[str] - name: typing.Optional[str] = pydantic.Field() + employee_payroll_run: typing.Optional[str] = None + name: typing.Optional[str] = pydantic.Field(default=None) """ The tax's name. """ - amount: typing.Optional[float] = pydantic.Field() + amount: typing.Optional[float] = pydantic.Field(default=None) """ The tax amount. """ - employer_tax: typing.Optional[bool] = pydantic.Field() + employer_tax: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the employer is responsible for paying the tax. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/team.py b/src/merge/resources/hris/types/team.py index 3ef0efb4..ea30d96e 100644 --- a/src/merge/resources/hris/types/team.py +++ b/src/merge/resources/hris/types/team.py @@ -23,39 +23,39 @@ class Team(UniversalBaseModel): If you're building a way to filter by `Team`, you'd hit the `GET Teams` endpoint to fetch the `Teams`, and then use the `ID` of the team your user selects to filter the `GET Employees` endpoint. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The team's name. """ - parent_team: typing.Optional["TeamParentTeam"] = pydantic.Field() + parent_team: typing.Optional["TeamParentTeam"] = pydantic.Field(default=None) """ The team's parent team. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/time_off.py b/src/merge/resources/hris/types/time_off.py index ea268fef..5ff12b51 100644 --- a/src/merge/resources/hris/types/time_off.py +++ b/src/merge/resources/hris/types/time_off.py @@ -31,33 +31,33 @@ class TimeOff(UniversalBaseModel): Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee: typing.Optional[TimeOffEmployee] = pydantic.Field() + employee: typing.Optional[TimeOffEmployee] = pydantic.Field(default=None) """ The employee requesting time off. """ - approver: typing.Optional[TimeOffApprover] = pydantic.Field() + approver: typing.Optional[TimeOffApprover] = pydantic.Field(default=None) """ The Merge ID of the employee with the ability to approve the time off request. """ - status: typing.Optional[TimeOffStatus] = pydantic.Field() + status: typing.Optional[TimeOffStatus] = pydantic.Field(default=None) """ The status of this time off request. @@ -68,12 +68,12 @@ class TimeOff(UniversalBaseModel): - `DELETED` - DELETED """ - employee_note: typing.Optional[str] = pydantic.Field() + employee_note: typing.Optional[str] = pydantic.Field(default=None) """ The employee note for this time off request. """ - units: typing.Optional[TimeOffUnits] = pydantic.Field() + units: typing.Optional[TimeOffUnits] = pydantic.Field(default=None) """ The measurement that the third-party integration uses to count time requested. @@ -81,12 +81,12 @@ class TimeOff(UniversalBaseModel): - `DAYS` - DAYS """ - amount: typing.Optional[float] = pydantic.Field() + amount: typing.Optional[float] = pydantic.Field(default=None) """ The time off quantity measured by the prescribed β€œunits”. """ - request_type: typing.Optional[TimeOffRequestType] = pydantic.Field() + request_type: typing.Optional[TimeOffRequestType] = pydantic.Field(default=None) """ The type of time off request. @@ -98,23 +98,23 @@ class TimeOff(UniversalBaseModel): - `BEREAVEMENT` - BEREAVEMENT """ - start_time: typing.Optional[dt.datetime] = pydantic.Field() + start_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time of the start of the time requested off. """ - end_time: typing.Optional[dt.datetime] = pydantic.Field() + end_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time of the end of the time requested off. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/time_off_balance.py b/src/merge/resources/hris/types/time_off_balance.py index 8a9aa9ab..19469194 100644 --- a/src/merge/resources/hris/types/time_off_balance.py +++ b/src/merge/resources/hris/types/time_off_balance.py @@ -28,38 +28,38 @@ class TimeOffBalance(UniversalBaseModel): Fetch from the `LIST TimeOffBalances` endpoint and filter by `ID` to show all time off balances. """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee: typing.Optional[TimeOffBalanceEmployee] = pydantic.Field() + employee: typing.Optional[TimeOffBalanceEmployee] = pydantic.Field(default=None) """ The employee the balance belongs to. """ - balance: typing.Optional[float] = pydantic.Field() + balance: typing.Optional[float] = pydantic.Field(default=None) """ The current remaining PTO balance, measured in hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours. """ - used: typing.Optional[float] = pydantic.Field() + used: typing.Optional[float] = pydantic.Field(default=None) """ The amount of PTO used in terms of hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours. """ - policy_type: typing.Optional[TimeOffBalancePolicyType] = pydantic.Field() + policy_type: typing.Optional[TimeOffBalancePolicyType] = pydantic.Field(default=None) """ The policy type of this time off balance. @@ -71,13 +71,13 @@ class TimeOffBalance(UniversalBaseModel): - `BEREAVEMENT` - BEREAVEMENT """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/hris/types/time_off_request.py b/src/merge/resources/hris/types/time_off_request.py index ef6380cc..eacd0d4b 100644 --- a/src/merge/resources/hris/types/time_off_request.py +++ b/src/merge/resources/hris/types/time_off_request.py @@ -30,17 +30,17 @@ class TimeOffRequest(UniversalBaseModel): Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests. """ - employee: typing.Optional[TimeOffRequestEmployee] = pydantic.Field() + employee: typing.Optional[TimeOffRequestEmployee] = pydantic.Field(default=None) """ The employee requesting time off. """ - approver: typing.Optional[TimeOffRequestApprover] = pydantic.Field() + approver: typing.Optional[TimeOffRequestApprover] = pydantic.Field(default=None) """ The Merge ID of the employee with the ability to approve the time off request. """ - status: typing.Optional[TimeOffRequestStatus] = pydantic.Field() + status: typing.Optional[TimeOffRequestStatus] = pydantic.Field(default=None) """ The status of this time off request. @@ -51,12 +51,12 @@ class TimeOffRequest(UniversalBaseModel): - `DELETED` - DELETED """ - employee_note: typing.Optional[str] = pydantic.Field() + employee_note: typing.Optional[str] = pydantic.Field(default=None) """ The employee note for this time off request. """ - units: typing.Optional[TimeOffRequestUnits] = pydantic.Field() + units: typing.Optional[TimeOffRequestUnits] = pydantic.Field(default=None) """ The measurement that the third-party integration uses to count time requested. @@ -64,12 +64,12 @@ class TimeOffRequest(UniversalBaseModel): - `DAYS` - DAYS """ - amount: typing.Optional[float] = pydantic.Field() + amount: typing.Optional[float] = pydantic.Field(default=None) """ The time off quantity measured by the prescribed β€œunits”. """ - request_type: typing.Optional[TimeOffRequestRequestType] = pydantic.Field() + request_type: typing.Optional[TimeOffRequestRequestType] = pydantic.Field(default=None) """ The type of time off request. @@ -81,18 +81,18 @@ class TimeOffRequest(UniversalBaseModel): - `BEREAVEMENT` - BEREAVEMENT """ - start_time: typing.Optional[dt.datetime] = pydantic.Field() + start_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time of the start of the time requested off. """ - end_time: typing.Optional[dt.datetime] = pydantic.Field() + end_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The day and time of the end of the time requested off. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/hris/types/time_off_response.py b/src/merge/resources/hris/types/time_off_response.py index 5962cafa..1964c356 100644 --- a/src/merge/resources/hris/types/time_off_response.py +++ b/src/merge/resources/hris/types/time_off_response.py @@ -19,7 +19,7 @@ class TimeOffResponse(UniversalBaseModel): model: TimeOff warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/hris/types/timesheet_entry.py b/src/merge/resources/hris/types/timesheet_entry.py index d0235f45..9c319bd8 100644 --- a/src/merge/resources/hris/types/timesheet_entry.py +++ b/src/merge/resources/hris/types/timesheet_entry.py @@ -20,49 +20,49 @@ class TimesheetEntry(UniversalBaseModel): GET and POST Timesheet Entries """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - employee: typing.Optional[str] = pydantic.Field() + employee: typing.Optional[str] = pydantic.Field(default=None) """ The employee the timesheet entry is for. """ - hours_worked: typing.Optional[float] = pydantic.Field() + hours_worked: typing.Optional[float] = pydantic.Field(default=None) """ The number of hours logged by the employee. """ - start_time: typing.Optional[dt.datetime] = pydantic.Field() + start_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which the employee started work. """ - end_time: typing.Optional[dt.datetime] = pydantic.Field() + end_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which the employee ended work. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[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 diff --git a/src/merge/resources/hris/types/timesheet_entry_request.py b/src/merge/resources/hris/types/timesheet_entry_request.py index 1f250186..2a2e1fba 100644 --- a/src/merge/resources/hris/types/timesheet_entry_request.py +++ b/src/merge/resources/hris/types/timesheet_entry_request.py @@ -20,28 +20,28 @@ class TimesheetEntryRequest(UniversalBaseModel): GET and POST Timesheet Entries """ - employee: typing.Optional[str] = pydantic.Field() + employee: typing.Optional[str] = pydantic.Field(default=None) """ The employee the timesheet entry is for. """ - hours_worked: typing.Optional[float] = pydantic.Field() + hours_worked: typing.Optional[float] = pydantic.Field(default=None) """ The number of hours logged by the employee. """ - start_time: typing.Optional[dt.datetime] = pydantic.Field() + start_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which the employee started work. """ - end_time: typing.Optional[dt.datetime] = pydantic.Field() + end_time: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which the employee ended work. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/hris/types/timesheet_entry_response.py b/src/merge/resources/hris/types/timesheet_entry_response.py index d9c1e3dc..60f5da87 100644 --- a/src/merge/resources/hris/types/timesheet_entry_response.py +++ b/src/merge/resources/hris/types/timesheet_entry_response.py @@ -14,7 +14,7 @@ class TimesheetEntryResponse(UniversalBaseModel): model: TimesheetEntry warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/hris/types/warning_validation_problem.py b/src/merge/resources/hris/types/warning_validation_problem.py index d508bb6d..140199ca 100644 --- a/src/merge/resources/hris/types/warning_validation_problem.py +++ b/src/merge/resources/hris/types/warning_validation_problem.py @@ -8,7 +8,7 @@ class WarningValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/hris/types/webhook_receiver.py b/src/merge/resources/hris/types/webhook_receiver.py index e8cd17aa..ac8573be 100644 --- a/src/merge/resources/hris/types/webhook_receiver.py +++ b/src/merge/resources/hris/types/webhook_receiver.py @@ -9,7 +9,7 @@ class WebhookReceiver(UniversalBaseModel): event: str is_active: bool - key: typing.Optional[str] + 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 diff --git a/src/merge/resources/ticketing/types/account.py b/src/merge/resources/ticketing/types/account.py index 161a5805..613f28db 100644 --- a/src/merge/resources/ticketing/types/account.py +++ b/src/merge/resources/ticketing/types/account.py @@ -23,39 +23,39 @@ class Account(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The account's name. """ - domains: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field() + domains: typing.Optional[typing.List[typing.Optional[str]]] = pydantic.Field(default=None) """ The account's domain names. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ticketing/types/account_details.py b/src/merge/resources/ticketing/types/account_details.py index dc91a6f3..aaf3c5e4 100644 --- a/src/merge/resources/ticketing/types/account_details.py +++ b/src/merge/resources/ticketing/types/account_details.py @@ -9,22 +9,22 @@ class AccountDetails(UniversalBaseModel): - id: typing.Optional[str] - integration: typing.Optional[str] - integration_slug: typing.Optional[str] - category: typing.Optional[CategoryEnum] - end_user_origin_id: typing.Optional[str] - end_user_organization_name: typing.Optional[str] - end_user_email_address: typing.Optional[str] - status: typing.Optional[str] - webhook_listener_url: typing.Optional[str] - is_duplicate: typing.Optional[bool] = pydantic.Field() + id: typing.Optional[str] = None + integration: typing.Optional[str] = None + integration_slug: typing.Optional[str] = None + category: typing.Optional[CategoryEnum] = None + end_user_origin_id: typing.Optional[str] = None + end_user_organization_name: typing.Optional[str] = None + end_user_email_address: typing.Optional[str] = None + status: typing.Optional[str] = None + webhook_listener_url: typing.Optional[str] = None + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - account_type: typing.Optional[str] - completed_at: typing.Optional[dt.datetime] = pydantic.Field() + account_type: typing.Optional[str] = None + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The time at which account completes the linking flow. """ diff --git a/src/merge/resources/ticketing/types/account_details_and_actions.py b/src/merge/resources/ticketing/types/account_details_and_actions.py index 30e78b61..4c96905f 100644 --- a/src/merge/resources/ticketing/types/account_details_and_actions.py +++ b/src/merge/resources/ticketing/types/account_details_and_actions.py @@ -24,24 +24,24 @@ class AccountDetailsAndActions(UniversalBaseModel): """ id: str - category: typing.Optional[CategoryEnum] + category: typing.Optional[CategoryEnum] = None status: AccountDetailsAndActionsStatusEnum - status_detail: typing.Optional[str] - end_user_origin_id: typing.Optional[str] + status_detail: typing.Optional[str] = None + end_user_origin_id: typing.Optional[str] = None end_user_organization_name: str end_user_email_address: str - subdomain: typing.Optional[str] = pydantic.Field() + subdomain: typing.Optional[str] = pydantic.Field(default=None) """ The tenant or domain the customer has provided access to. """ webhook_listener_url: str - is_duplicate: typing.Optional[bool] = pydantic.Field() + is_duplicate: typing.Optional[bool] = pydantic.Field(default=None) """ Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. """ - integration: typing.Optional[AccountDetailsAndActionsIntegration] + integration: typing.Optional[AccountDetailsAndActionsIntegration] = None account_type: str completed_at: dt.datetime diff --git a/src/merge/resources/ticketing/types/account_details_and_actions_integration.py b/src/merge/resources/ticketing/types/account_details_and_actions_integration.py index 5779ac5b..8e47dbc4 100644 --- a/src/merge/resources/ticketing/types/account_details_and_actions_integration.py +++ b/src/merge/resources/ticketing/types/account_details_and_actions_integration.py @@ -11,12 +11,12 @@ class AccountDetailsAndActionsIntegration(UniversalBaseModel): name: str categories: typing.List[CategoriesEnum] - image: typing.Optional[str] - square_image: typing.Optional[str] + image: typing.Optional[str] = None + square_image: typing.Optional[str] = None color: str slug: str passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/ticketing/types/account_integration.py b/src/merge/resources/ticketing/types/account_integration.py index 2d18dedb..1dad1594 100644 --- a/src/merge/resources/ticketing/types/account_integration.py +++ b/src/merge/resources/ticketing/types/account_integration.py @@ -13,45 +13,45 @@ class AccountIntegration(UniversalBaseModel): Company name. """ - abbreviated_name: typing.Optional[str] = pydantic.Field() + abbreviated_name: typing.Optional[str] = pydantic.Field(default=None) """ Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).

Example: Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors) """ - categories: typing.Optional[typing.List[CategoriesEnum]] = pydantic.Field() + 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() + image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in rectangular shape. """ - square_image: typing.Optional[str] = pydantic.Field() + square_image: typing.Optional[str] = pydantic.Field(default=None) """ Company logo in square shape. """ - color: typing.Optional[str] = pydantic.Field() + 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] + slug: typing.Optional[str] = None api_endpoints_to_documentation_urls: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = ( - pydantic.Field() + 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() + 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() + 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. """ diff --git a/src/merge/resources/ticketing/types/advanced_metadata.py b/src/merge/resources/ticketing/types/advanced_metadata.py index 6287a842..e570d69f 100644 --- a/src/merge/resources/ticketing/types/advanced_metadata.py +++ b/src/merge/resources/ticketing/types/advanced_metadata.py @@ -8,11 +8,11 @@ class AdvancedMetadata(UniversalBaseModel): id: str - display_name: typing.Optional[str] - description: typing.Optional[str] - is_required: typing.Optional[bool] - is_custom: typing.Optional[bool] - field_choices: typing.Optional[typing.List[typing.Optional[typing.Any]]] + 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 diff --git a/src/merge/resources/ticketing/types/attachment.py b/src/merge/resources/ticketing/types/attachment.py index 48df62ed..432651c1 100644 --- a/src/merge/resources/ticketing/types/attachment.py +++ b/src/merge/resources/ticketing/types/attachment.py @@ -24,59 +24,59 @@ class Attachment(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - file_name: typing.Optional[str] = pydantic.Field() + file_name: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's name. It is required to include the file extension in the attachment's name. """ - ticket: typing.Optional["AttachmentTicket"] = pydantic.Field() + ticket: typing.Optional["AttachmentTicket"] = pydantic.Field(default=None) """ The ticket associated with the attachment. """ - file_url: typing.Optional[str] = pydantic.Field() + file_url: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's url. It is required to include the file extension in the file's URL. """ - content_type: typing.Optional[str] = pydantic.Field() + content_type: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's file format. """ - uploaded_by: typing.Optional[str] = pydantic.Field() + uploaded_by: typing.Optional[str] = pydantic.Field(default=None) """ The user who uploaded the attachment. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's attachment was created. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ticketing/types/attachment_request.py b/src/merge/resources/ticketing/types/attachment_request.py index bb831e5d..263adc95 100644 --- a/src/merge/resources/ticketing/types/attachment_request.py +++ b/src/merge/resources/ticketing/types/attachment_request.py @@ -25,33 +25,33 @@ class AttachmentRequest(UniversalBaseModel): TODO """ - file_name: typing.Optional[str] = pydantic.Field() + file_name: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's name. It is required to include the file extension in the attachment's name. """ - ticket: typing.Optional[AttachmentRequestTicket] = pydantic.Field() + ticket: typing.Optional[AttachmentRequestTicket] = pydantic.Field(default=None) """ The ticket associated with the attachment. """ - file_url: typing.Optional[str] = pydantic.Field() + file_url: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's url. It is required to include the file extension in the file's URL. """ - content_type: typing.Optional[str] = pydantic.Field() + content_type: typing.Optional[str] = pydantic.Field(default=None) """ The attachment's file format. """ - uploaded_by: typing.Optional[str] = pydantic.Field() + uploaded_by: typing.Optional[str] = pydantic.Field(default=None) """ The user who uploaded the attachment. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ticketing/types/audit_log_event.py b/src/merge/resources/ticketing/types/audit_log_event.py index b57101fc..1c32586b 100644 --- a/src/merge/resources/ticketing/types/audit_log_event.py +++ b/src/merge/resources/ticketing/types/audit_log_event.py @@ -10,13 +10,13 @@ class AuditLogEvent(UniversalBaseModel): - id: typing.Optional[str] - user_name: typing.Optional[str] = pydantic.Field() + 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() + user_email: typing.Optional[str] = pydantic.Field(default=None) """ The User's email at the time of this Event occurring. """ @@ -79,7 +79,7 @@ class AuditLogEvent(UniversalBaseModel): """ event_description: str - created_at: typing.Optional[dt.datetime] + 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 diff --git a/src/merge/resources/ticketing/types/available_actions.py b/src/merge/resources/ticketing/types/available_actions.py index 5f164db6..57cee06d 100644 --- a/src/merge/resources/ticketing/types/available_actions.py +++ b/src/merge/resources/ticketing/types/available_actions.py @@ -23,7 +23,7 @@ class AvailableActions(UniversalBaseModel): integration: AccountIntegration passthrough_available: bool - available_model_operations: typing.Optional[typing.List[ModelOperation]] + 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 diff --git a/src/merge/resources/ticketing/types/collection.py b/src/merge/resources/ticketing/types/collection.py index dc88d50a..58d2a9d5 100644 --- a/src/merge/resources/ticketing/types/collection.py +++ b/src/merge/resources/ticketing/types/collection.py @@ -26,33 +26,33 @@ class Collection(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The collection's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The collection's description. """ - collection_type: typing.Optional[CollectionCollectionType] = pydantic.Field() + collection_type: typing.Optional[CollectionCollectionType] = pydantic.Field(default=None) """ The collection's type. @@ -60,17 +60,17 @@ class Collection(UniversalBaseModel): - `PROJECT` - PROJECT """ - parent_collection: typing.Optional["CollectionParentCollection"] = pydantic.Field() + parent_collection: typing.Optional["CollectionParentCollection"] = pydantic.Field(default=None) """ The parent collection for this collection. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ - access_level: typing.Optional[CollectionAccessLevel] = pydantic.Field() + access_level: typing.Optional[CollectionAccessLevel] = pydantic.Field(default=None) """ The level of access a User has to the Collection and its sub-objects. @@ -79,8 +79,8 @@ class Collection(UniversalBaseModel): - `PUBLIC` - PUBLIC """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ticketing/types/comment.py b/src/merge/resources/ticketing/types/comment.py index 824a1f3c..9fbcc4cc 100644 --- a/src/merge/resources/ticketing/types/comment.py +++ b/src/merge/resources/ticketing/types/comment.py @@ -29,64 +29,64 @@ class Comment(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - user: typing.Optional[CommentUser] = pydantic.Field() + user: typing.Optional[CommentUser] = pydantic.Field(default=None) """ The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append "[Posted on behalf of {name}]" to the comment. """ - contact: typing.Optional[CommentContact] = pydantic.Field() + contact: typing.Optional[CommentContact] = pydantic.Field(default=None) """ The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append "[Posted on behalf of {name}]" to the comment. """ - body: typing.Optional[str] = pydantic.Field() + body: typing.Optional[str] = pydantic.Field(default=None) """ The comment's text body. """ - html_body: typing.Optional[str] = pydantic.Field() + html_body: typing.Optional[str] = pydantic.Field(default=None) """ The comment's text body formatted as html. """ - ticket: typing.Optional[CommentTicket] = pydantic.Field() + ticket: typing.Optional[CommentTicket] = pydantic.Field(default=None) """ The ticket associated with the comment. """ - is_private: typing.Optional[bool] = pydantic.Field() + is_private: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the comment is internal. """ - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's comment was created. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ticketing/types/comment_request.py b/src/merge/resources/ticketing/types/comment_request.py index 16232d11..8eec33dd 100644 --- a/src/merge/resources/ticketing/types/comment_request.py +++ b/src/merge/resources/ticketing/types/comment_request.py @@ -27,38 +27,38 @@ class CommentRequest(UniversalBaseModel): TODO """ - user: typing.Optional[CommentRequestUser] = pydantic.Field() + user: typing.Optional[CommentRequestUser] = pydantic.Field(default=None) """ The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append "[Posted on behalf of {name}]" to the comment. """ - contact: typing.Optional[CommentRequestContact] = pydantic.Field() + contact: typing.Optional[CommentRequestContact] = pydantic.Field(default=None) """ The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append "[Posted on behalf of {name}]" to the comment. """ - body: typing.Optional[str] = pydantic.Field() + body: typing.Optional[str] = pydantic.Field(default=None) """ The comment's text body. """ - html_body: typing.Optional[str] = pydantic.Field() + html_body: typing.Optional[str] = pydantic.Field(default=None) """ The comment's text body formatted as html. """ - ticket: typing.Optional[CommentRequestTicket] = pydantic.Field() + ticket: typing.Optional[CommentRequestTicket] = pydantic.Field(default=None) """ The ticket associated with the comment. """ - is_private: typing.Optional[bool] = pydantic.Field() + is_private: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the comment is internal. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ticketing/types/comment_response.py b/src/merge/resources/ticketing/types/comment_response.py index f871949b..c29728df 100644 --- a/src/merge/resources/ticketing/types/comment_response.py +++ b/src/merge/resources/ticketing/types/comment_response.py @@ -19,7 +19,7 @@ class CommentResponse(UniversalBaseModel): model: Comment warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ticketing/types/contact.py b/src/merge/resources/ticketing/types/contact.py index 9347c292..62fc6503 100644 --- a/src/merge/resources/ticketing/types/contact.py +++ b/src/merge/resources/ticketing/types/contact.py @@ -22,54 +22,54 @@ class Contact(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The contact's name. """ - email_address: typing.Optional[str] = pydantic.Field() + email_address: typing.Optional[str] = pydantic.Field(default=None) """ The contact's email address. """ - phone_number: typing.Optional[str] = pydantic.Field() + phone_number: typing.Optional[str] = pydantic.Field(default=None) """ The contact's phone number. """ - details: typing.Optional[str] = pydantic.Field() + details: typing.Optional[str] = pydantic.Field(default=None) """ The contact's details. """ - account: typing.Optional[ContactAccount] = pydantic.Field() + account: typing.Optional[ContactAccount] = pydantic.Field(default=None) """ The contact's account. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ticketing/types/contact_request.py b/src/merge/resources/ticketing/types/contact_request.py index de2ced7e..e5a43260 100644 --- a/src/merge/resources/ticketing/types/contact_request.py +++ b/src/merge/resources/ticketing/types/contact_request.py @@ -20,33 +20,33 @@ class ContactRequest(UniversalBaseModel): TODO """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The contact's name. """ - email_address: typing.Optional[str] = pydantic.Field() + email_address: typing.Optional[str] = pydantic.Field(default=None) """ The contact's email address. """ - phone_number: typing.Optional[str] = pydantic.Field() + phone_number: typing.Optional[str] = pydantic.Field(default=None) """ The contact's phone number. """ - details: typing.Optional[str] = pydantic.Field() + details: typing.Optional[str] = pydantic.Field(default=None) """ The contact's details. """ - account: typing.Optional[ContactRequestAccount] = pydantic.Field() + account: typing.Optional[ContactRequestAccount] = pydantic.Field(default=None) """ The contact's account. """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: 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 diff --git a/src/merge/resources/ticketing/types/data_passthrough_request.py b/src/merge/resources/ticketing/types/data_passthrough_request.py index f2718105..2b0595cf 100644 --- a/src/merge/resources/ticketing/types/data_passthrough_request.py +++ b/src/merge/resources/ticketing/types/data_passthrough_request.py @@ -28,28 +28,28 @@ class DataPassthroughRequest(UniversalBaseModel): The path of the request in the third party's platform. """ - base_url_override: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + 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[RequestFormatEnum] - normalize_response: typing.Optional[bool] = pydantic.Field() + request_format: typing.Optional[RequestFormatEnum] = 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`. """ diff --git a/src/merge/resources/ticketing/types/error_validation_problem.py b/src/merge/resources/ticketing/types/error_validation_problem.py index 58ea87e6..91565918 100644 --- a/src/merge/resources/ticketing/types/error_validation_problem.py +++ b/src/merge/resources/ticketing/types/error_validation_problem.py @@ -8,7 +8,7 @@ class ErrorValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/ticketing/types/external_target_field_api.py b/src/merge/resources/ticketing/types/external_target_field_api.py index 18988d44..1ed19a99 100644 --- a/src/merge/resources/ticketing/types/external_target_field_api.py +++ b/src/merge/resources/ticketing/types/external_target_field_api.py @@ -7,9 +7,9 @@ class ExternalTargetFieldApi(UniversalBaseModel): - name: typing.Optional[str] - description: typing.Optional[str] - is_mapped: typing.Optional[str] + 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 diff --git a/src/merge/resources/ticketing/types/external_target_field_api_response.py b/src/merge/resources/ticketing/types/external_target_field_api_response.py index 09c7f0e6..9a7e8c27 100644 --- a/src/merge/resources/ticketing/types/external_target_field_api_response.py +++ b/src/merge/resources/ticketing/types/external_target_field_api_response.py @@ -8,17 +8,17 @@ class ExternalTargetFieldApiResponse(UniversalBaseModel): - ticket: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Ticket") - comment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Comment") - project: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Project") - collection: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Collection") - user: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="User") - role: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Role") - account: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Account") - team: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Team") - attachment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Attachment") - tag: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Tag") - contact: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Contact") + ticket: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Ticket", default=None) + comment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Comment", default=None) + project: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Project", default=None) + collection: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Collection", default=None) + user: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="User", default=None) + role: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Role", default=None) + account: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Account", default=None) + team: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Team", default=None) + attachment: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Attachment", default=None) + tag: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Tag", default=None) + contact: typing.Optional[typing.List[ExternalTargetFieldApi]] = pydantic.Field(alias="Contact", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/field_mapping_api_instance.py b/src/merge/resources/ticketing/types/field_mapping_api_instance.py index ef4d9c48..1cc2f4a2 100644 --- a/src/merge/resources/ticketing/types/field_mapping_api_instance.py +++ b/src/merge/resources/ticketing/types/field_mapping_api_instance.py @@ -9,10 +9,10 @@ class FieldMappingApiInstance(UniversalBaseModel): - id: typing.Optional[str] - is_integration_wide: typing.Optional[bool] - target_field: typing.Optional[FieldMappingApiInstanceTargetField] - remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] + id: typing.Optional[str] = None + is_integration_wide: typing.Optional[bool] = None + target_field: typing.Optional[FieldMappingApiInstanceTargetField] = None + remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py b/src/merge/resources/ticketing/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py index 14c37c76..9eeb4fbf 100644 --- a/src/merge/resources/ticketing/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py +++ b/src/merge/resources/ticketing/types/field_mapping_api_instance_remote_field_remote_endpoint_info.py @@ -7,9 +7,9 @@ class FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo(UniversalBaseModel): - method: typing.Optional[str] - url_path: typing.Optional[str] - field_traversal_path: typing.Optional[typing.List[str]] + 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 diff --git a/src/merge/resources/ticketing/types/field_mapping_api_instance_response.py b/src/merge/resources/ticketing/types/field_mapping_api_instance_response.py index 36d1bcc5..2c4a773d 100644 --- a/src/merge/resources/ticketing/types/field_mapping_api_instance_response.py +++ b/src/merge/resources/ticketing/types/field_mapping_api_instance_response.py @@ -8,17 +8,17 @@ class FieldMappingApiInstanceResponse(UniversalBaseModel): - ticket: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Ticket") - comment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Comment") - project: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Project") - collection: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Collection") - user: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="User") - role: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Role") - account: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Account") - team: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Team") - attachment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Attachment") - tag: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Tag") - contact: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Contact") + ticket: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Ticket", default=None) + comment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Comment", default=None) + project: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Project", default=None) + collection: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Collection", default=None) + user: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="User", default=None) + role: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Role", default=None) + account: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Account", default=None) + team: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Team", default=None) + attachment: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Attachment", default=None) + tag: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Tag", default=None) + contact: typing.Optional[typing.List[FieldMappingApiInstance]] = pydantic.Field(alias="Contact", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/field_mapping_instance_response.py b/src/merge/resources/ticketing/types/field_mapping_instance_response.py index a56aeb93..2123f4d3 100644 --- a/src/merge/resources/ticketing/types/field_mapping_instance_response.py +++ b/src/merge/resources/ticketing/types/field_mapping_instance_response.py @@ -14,7 +14,7 @@ class FieldMappingInstanceResponse(UniversalBaseModel): model: FieldMappingApiInstance warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ticketing/types/field_permission_deserializer.py b/src/merge/resources/ticketing/types/field_permission_deserializer.py index 9670537a..ea7cc235 100644 --- a/src/merge/resources/ticketing/types/field_permission_deserializer.py +++ b/src/merge/resources/ticketing/types/field_permission_deserializer.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializer(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/ticketing/types/field_permission_deserializer_request.py b/src/merge/resources/ticketing/types/field_permission_deserializer_request.py index 04e14608..e5617ad6 100644 --- a/src/merge/resources/ticketing/types/field_permission_deserializer_request.py +++ b/src/merge/resources/ticketing/types/field_permission_deserializer_request.py @@ -7,8 +7,8 @@ class FieldPermissionDeserializerRequest(UniversalBaseModel): - enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] - disabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] + enabled: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + disabled: 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 diff --git a/src/merge/resources/ticketing/types/individual_common_model_scope_deserializer.py b/src/merge/resources/ticketing/types/individual_common_model_scope_deserializer.py index 122df11c..70704314 100644 --- a/src/merge/resources/ticketing/types/individual_common_model_scope_deserializer.py +++ b/src/merge/resources/ticketing/types/individual_common_model_scope_deserializer.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializer(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializer]] - field_permissions: typing.Optional[FieldPermissionDeserializer] + 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 diff --git a/src/merge/resources/ticketing/types/individual_common_model_scope_deserializer_request.py b/src/merge/resources/ticketing/types/individual_common_model_scope_deserializer_request.py index a1a80902..d42dd53a 100644 --- a/src/merge/resources/ticketing/types/individual_common_model_scope_deserializer_request.py +++ b/src/merge/resources/ticketing/types/individual_common_model_scope_deserializer_request.py @@ -10,8 +10,8 @@ class IndividualCommonModelScopeDeserializerRequest(UniversalBaseModel): model_name: str - model_permissions: typing.Optional[typing.Dict[str, ModelPermissionDeserializerRequest]] - field_permissions: typing.Optional[FieldPermissionDeserializerRequest] + 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 diff --git a/src/merge/resources/ticketing/types/issue.py b/src/merge/resources/ticketing/types/issue.py index 5a584515..7adc1f31 100644 --- a/src/merge/resources/ticketing/types/issue.py +++ b/src/merge/resources/ticketing/types/issue.py @@ -9,8 +9,8 @@ class Issue(UniversalBaseModel): - id: typing.Optional[str] - status: typing.Optional[IssueStatus] = pydantic.Field() + id: typing.Optional[str] = None + status: typing.Optional[IssueStatus] = pydantic.Field(default=None) """ Status of the issue. Options: ('ONGOING', 'RESOLVED') @@ -19,11 +19,11 @@ class Issue(UniversalBaseModel): """ error_description: str - end_user: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - first_incident_time: typing.Optional[dt.datetime] - last_incident_time: typing.Optional[dt.datetime] - is_muted: typing.Optional[bool] - error_details: typing.Optional[typing.List[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 diff --git a/src/merge/resources/ticketing/types/item_schema.py b/src/merge/resources/ticketing/types/item_schema.py index cfe24209..7f82ffbb 100644 --- a/src/merge/resources/ticketing/types/item_schema.py +++ b/src/merge/resources/ticketing/types/item_schema.py @@ -9,9 +9,9 @@ class ItemSchema(UniversalBaseModel): - item_type: typing.Optional[ItemTypeEnum] - item_format: typing.Optional[ItemFormatEnum] - item_choices: typing.Optional[typing.List[str]] + item_type: typing.Optional[ItemTypeEnum] = None + item_format: typing.Optional[ItemFormatEnum] = None + item_choices: 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 diff --git a/src/merge/resources/ticketing/types/link_token.py b/src/merge/resources/ticketing/types/link_token.py index 1d25dddb..ac916d14 100644 --- a/src/merge/resources/ticketing/types/link_token.py +++ b/src/merge/resources/ticketing/types/link_token.py @@ -8,8 +8,8 @@ class LinkToken(UniversalBaseModel): link_token: str - integration_name: typing.Optional[str] - magic_link_url: typing.Optional[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 diff --git a/src/merge/resources/ticketing/types/meta_response.py b/src/merge/resources/ticketing/types/meta_response.py index 44e57fde..272535f0 100644 --- a/src/merge/resources/ticketing/types/meta_response.py +++ b/src/merge/resources/ticketing/types/meta_response.py @@ -9,8 +9,8 @@ class MetaResponse(UniversalBaseModel): request_schema: typing.Dict[str, typing.Optional[typing.Any]] - remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - status: typing.Optional[LinkedAccountStatus] + remote_field_classes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + status: typing.Optional[LinkedAccountStatus] = None has_conditional_params: bool has_required_linked_account_params: bool diff --git a/src/merge/resources/ticketing/types/model_permission_deserializer.py b/src/merge/resources/ticketing/types/model_permission_deserializer.py index b6d813e4..96f39e63 100644 --- a/src/merge/resources/ticketing/types/model_permission_deserializer.py +++ b/src/merge/resources/ticketing/types/model_permission_deserializer.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializer(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/ticketing/types/model_permission_deserializer_request.py b/src/merge/resources/ticketing/types/model_permission_deserializer_request.py index 5885627b..2619fb6a 100644 --- a/src/merge/resources/ticketing/types/model_permission_deserializer_request.py +++ b/src/merge/resources/ticketing/types/model_permission_deserializer_request.py @@ -7,7 +7,7 @@ class ModelPermissionDeserializerRequest(UniversalBaseModel): - is_enabled: typing.Optional[bool] + 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 diff --git a/src/merge/resources/ticketing/types/multipart_form_field_request.py b/src/merge/resources/ticketing/types/multipart_form_field_request.py index 80099016..507fa8c6 100644 --- a/src/merge/resources/ticketing/types/multipart_form_field_request.py +++ b/src/merge/resources/ticketing/types/multipart_form_field_request.py @@ -30,7 +30,7 @@ class MultipartFormFieldRequest(UniversalBaseModel): The data for the form field. """ - encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field() + encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field(default=None) """ The encoding of the value of `data`. Defaults to `RAW` if not defined. @@ -39,12 +39,12 @@ class MultipartFormFieldRequest(UniversalBaseModel): - `GZIP_BASE64` - GZIP_BASE64 """ - file_name: typing.Optional[str] = pydantic.Field() + 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() + content_type: typing.Optional[str] = pydantic.Field(default=None) """ The MIME type of the file, if the field is for a file. """ diff --git a/src/merge/resources/ticketing/types/paginated_account_details_and_actions_list.py b/src/merge/resources/ticketing/types/paginated_account_details_and_actions_list.py index a9128c76..00ceeda5 100644 --- a/src/merge/resources/ticketing/types/paginated_account_details_and_actions_list.py +++ b/src/merge/resources/ticketing/types/paginated_account_details_and_actions_list.py @@ -8,9 +8,9 @@ class PaginatedAccountDetailsAndActionsList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AccountDetailsAndActions]] + 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 diff --git a/src/merge/resources/ticketing/types/paginated_account_list.py b/src/merge/resources/ticketing/types/paginated_account_list.py index b49c8fba..dcabf6cb 100644 --- a/src/merge/resources/ticketing/types/paginated_account_list.py +++ b/src/merge/resources/ticketing/types/paginated_account_list.py @@ -8,9 +8,9 @@ class PaginatedAccountList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Account]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Account]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_attachment_list.py b/src/merge/resources/ticketing/types/paginated_attachment_list.py index 88a4d9cd..ad47e8cc 100644 --- a/src/merge/resources/ticketing/types/paginated_attachment_list.py +++ b/src/merge/resources/ticketing/types/paginated_attachment_list.py @@ -12,9 +12,9 @@ class PaginatedAttachmentList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Attachment]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Attachment]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_audit_log_event_list.py b/src/merge/resources/ticketing/types/paginated_audit_log_event_list.py index a50b7c75..450de68c 100644 --- a/src/merge/resources/ticketing/types/paginated_audit_log_event_list.py +++ b/src/merge/resources/ticketing/types/paginated_audit_log_event_list.py @@ -8,9 +8,9 @@ class PaginatedAuditLogEventList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[AuditLogEvent]] + 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 diff --git a/src/merge/resources/ticketing/types/paginated_collection_list.py b/src/merge/resources/ticketing/types/paginated_collection_list.py index 1a5fd591..230a4df0 100644 --- a/src/merge/resources/ticketing/types/paginated_collection_list.py +++ b/src/merge/resources/ticketing/types/paginated_collection_list.py @@ -10,9 +10,9 @@ class PaginatedCollectionList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Collection]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Collection]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_comment_list.py b/src/merge/resources/ticketing/types/paginated_comment_list.py index 6fb104d0..80c3e89d 100644 --- a/src/merge/resources/ticketing/types/paginated_comment_list.py +++ b/src/merge/resources/ticketing/types/paginated_comment_list.py @@ -13,9 +13,9 @@ class PaginatedCommentList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Comment]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Comment]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_contact_list.py b/src/merge/resources/ticketing/types/paginated_contact_list.py index 07c47744..c711818a 100644 --- a/src/merge/resources/ticketing/types/paginated_contact_list.py +++ b/src/merge/resources/ticketing/types/paginated_contact_list.py @@ -8,9 +8,9 @@ class PaginatedContactList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Contact]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Contact]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_issue_list.py b/src/merge/resources/ticketing/types/paginated_issue_list.py index 12b866d9..758e6dc3 100644 --- a/src/merge/resources/ticketing/types/paginated_issue_list.py +++ b/src/merge/resources/ticketing/types/paginated_issue_list.py @@ -8,9 +8,9 @@ class PaginatedIssueList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Issue]] + 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 diff --git a/src/merge/resources/ticketing/types/paginated_project_list.py b/src/merge/resources/ticketing/types/paginated_project_list.py index 2b4f6480..bb3b7306 100644 --- a/src/merge/resources/ticketing/types/paginated_project_list.py +++ b/src/merge/resources/ticketing/types/paginated_project_list.py @@ -8,9 +8,9 @@ class PaginatedProjectList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Project]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Project]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_remote_field_class_list.py b/src/merge/resources/ticketing/types/paginated_remote_field_class_list.py index 1f51ab63..65c907cc 100644 --- a/src/merge/resources/ticketing/types/paginated_remote_field_class_list.py +++ b/src/merge/resources/ticketing/types/paginated_remote_field_class_list.py @@ -8,9 +8,9 @@ class PaginatedRemoteFieldClassList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[RemoteFieldClass]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[RemoteFieldClass]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_role_list.py b/src/merge/resources/ticketing/types/paginated_role_list.py index c69e65ca..34b4fa65 100644 --- a/src/merge/resources/ticketing/types/paginated_role_list.py +++ b/src/merge/resources/ticketing/types/paginated_role_list.py @@ -8,9 +8,9 @@ class PaginatedRoleList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Role]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Role]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_sync_status_list.py b/src/merge/resources/ticketing/types/paginated_sync_status_list.py index f59f2c9a..f4f09ed1 100644 --- a/src/merge/resources/ticketing/types/paginated_sync_status_list.py +++ b/src/merge/resources/ticketing/types/paginated_sync_status_list.py @@ -8,9 +8,9 @@ class PaginatedSyncStatusList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[SyncStatus]] + 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 diff --git a/src/merge/resources/ticketing/types/paginated_tag_list.py b/src/merge/resources/ticketing/types/paginated_tag_list.py index 9c632ec6..7557bbd5 100644 --- a/src/merge/resources/ticketing/types/paginated_tag_list.py +++ b/src/merge/resources/ticketing/types/paginated_tag_list.py @@ -8,9 +8,9 @@ class PaginatedTagList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Tag]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Tag]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_team_list.py b/src/merge/resources/ticketing/types/paginated_team_list.py index 50c12445..2ff7ee70 100644 --- a/src/merge/resources/ticketing/types/paginated_team_list.py +++ b/src/merge/resources/ticketing/types/paginated_team_list.py @@ -8,9 +8,9 @@ class PaginatedTeamList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Team]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Team]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_ticket_list.py b/src/merge/resources/ticketing/types/paginated_ticket_list.py index c499fc45..e554b33f 100644 --- a/src/merge/resources/ticketing/types/paginated_ticket_list.py +++ b/src/merge/resources/ticketing/types/paginated_ticket_list.py @@ -12,9 +12,9 @@ class PaginatedTicketList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[Ticket]] + next: typing.Optional[str] = None + previous: typing.Optional[str] = None + results: typing.Optional[typing.List[Ticket]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/paginated_user_list.py b/src/merge/resources/ticketing/types/paginated_user_list.py index 98e9b7e5..397d4664 100644 --- a/src/merge/resources/ticketing/types/paginated_user_list.py +++ b/src/merge/resources/ticketing/types/paginated_user_list.py @@ -8,9 +8,9 @@ class PaginatedUserList(UniversalBaseModel): - next: typing.Optional[str] - previous: typing.Optional[str] - results: typing.Optional[typing.List[User]] + 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 diff --git a/src/merge/resources/ticketing/types/patched_ticket_request.py b/src/merge/resources/ticketing/types/patched_ticket_request.py index d3cd3037..721df4ab 100644 --- a/src/merge/resources/ticketing/types/patched_ticket_request.py +++ b/src/merge/resources/ticketing/types/patched_ticket_request.py @@ -23,23 +23,23 @@ class PatchedTicketRequest(UniversalBaseModel): TODO """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The ticket's name. """ - assignees: typing.Optional[typing.List[typing.Optional[str]]] - creator: typing.Optional[str] = pydantic.Field() + assignees: typing.Optional[typing.List[typing.Optional[str]]] = None + creator: typing.Optional[str] = pydantic.Field(default=None) """ The user who created this ticket. """ - due_date: typing.Optional[dt.datetime] = pydantic.Field() + due_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The ticket's due date. """ - status: typing.Optional[PatchedTicketRequestStatus] = pydantic.Field() + status: typing.Optional[PatchedTicketRequestStatus] = pydantic.Field(default=None) """ The current status of the ticket. @@ -49,44 +49,44 @@ class PatchedTicketRequest(UniversalBaseModel): - `ON_HOLD` - ON_HOLD """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The ticket’s description. HTML version of description is mapped if supported by the third-party platform. """ - collections: typing.Optional[typing.List[typing.Optional[str]]] - ticket_type: typing.Optional[str] = pydantic.Field() + collections: typing.Optional[typing.List[typing.Optional[str]]] = None + ticket_type: typing.Optional[str] = pydantic.Field(default=None) """ The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do. """ - account: typing.Optional[str] = pydantic.Field() + account: typing.Optional[str] = pydantic.Field(default=None) """ The account associated with the ticket. """ - contact: typing.Optional[str] = pydantic.Field() + contact: typing.Optional[str] = pydantic.Field(default=None) """ The contact associated with the ticket. """ - parent_ticket: typing.Optional[str] = pydantic.Field() + parent_ticket: typing.Optional[str] = pydantic.Field(default=None) """ The ticket's parent ticket. """ - tags: typing.Optional[typing.List[typing.Optional[str]]] - completed_at: typing.Optional[dt.datetime] = pydantic.Field() + tags: typing.Optional[typing.List[typing.Optional[str]]] = None + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the ticket was completed. """ - ticket_url: typing.Optional[str] = pydantic.Field() + ticket_url: typing.Optional[str] = pydantic.Field(default=None) """ The 3rd party url of the Ticket. """ - priority: typing.Optional[PatchedTicketRequestPriority] = pydantic.Field() + priority: typing.Optional[PatchedTicketRequestPriority] = pydantic.Field(default=None) """ The priority or urgency of the Ticket. @@ -96,9 +96,9 @@ class PatchedTicketRequest(UniversalBaseModel): - `LOW` - LOW """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/project.py b/src/merge/resources/ticketing/types/project.py index c358c08c..a7971538 100644 --- a/src/merge/resources/ticketing/types/project.py +++ b/src/merge/resources/ticketing/types/project.py @@ -21,39 +21,39 @@ class Project(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The project's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The project's description. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ticketing/types/remote_data.py b/src/merge/resources/ticketing/types/remote_data.py index 27c2a5f2..09a6b50b 100644 --- a/src/merge/resources/ticketing/types/remote_data.py +++ b/src/merge/resources/ticketing/types/remote_data.py @@ -8,7 +8,7 @@ class RemoteData(UniversalBaseModel): path: str - data: typing.Optional[typing.Optional[typing.Any]] + data: typing.Optional[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 diff --git a/src/merge/resources/ticketing/types/remote_field.py b/src/merge/resources/ticketing/types/remote_field.py index 0d50d6c8..8b30e1a9 100644 --- a/src/merge/resources/ticketing/types/remote_field.py +++ b/src/merge/resources/ticketing/types/remote_field.py @@ -9,7 +9,7 @@ class RemoteField(UniversalBaseModel): remote_field_class: RemoteFieldRemoteFieldClass - value: typing.Optional[typing.Optional[typing.Any]] + value: typing.Optional[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 diff --git a/src/merge/resources/ticketing/types/remote_field_api.py b/src/merge/resources/ticketing/types/remote_field_api.py index 18f2421d..82495d75 100644 --- a/src/merge/resources/ticketing/types/remote_field_api.py +++ b/src/merge/resources/ticketing/types/remote_field_api.py @@ -13,9 +13,9 @@ class RemoteFieldApi(UniversalBaseModel): 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]]] - advanced_metadata: typing.Optional[AdvancedMetadata] - coverage: typing.Optional[RemoteFieldApiCoverage] + example_values: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None + advanced_metadata: typing.Optional[AdvancedMetadata] = 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 diff --git a/src/merge/resources/ticketing/types/remote_field_api_response.py b/src/merge/resources/ticketing/types/remote_field_api_response.py index d4f76a3e..c048d6bd 100644 --- a/src/merge/resources/ticketing/types/remote_field_api_response.py +++ b/src/merge/resources/ticketing/types/remote_field_api_response.py @@ -8,17 +8,17 @@ class RemoteFieldApiResponse(UniversalBaseModel): - ticket: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Ticket") - comment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Comment") - project: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Project") - collection: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Collection") - user: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="User") - role: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Role") - account: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Account") - team: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Team") - attachment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Attachment") - tag: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Tag") - contact: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Contact") + ticket: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Ticket", default=None) + comment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Comment", default=None) + project: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Project", default=None) + collection: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Collection", default=None) + user: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="User", default=None) + role: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Role", default=None) + account: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Account", default=None) + team: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Team", default=None) + attachment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Attachment", default=None) + tag: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Tag", default=None) + contact: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Contact", default=None) if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/remote_field_class.py b/src/merge/resources/ticketing/types/remote_field_class.py index 7abfc779..90072f8e 100644 --- a/src/merge/resources/ticketing/types/remote_field_class.py +++ b/src/merge/resources/ticketing/types/remote_field_class.py @@ -11,16 +11,16 @@ class RemoteFieldClass(UniversalBaseModel): - id: typing.Optional[str] - display_name: typing.Optional[str] - remote_key_name: typing.Optional[str] - description: typing.Optional[str] - is_custom: typing.Optional[bool] - is_required: typing.Optional[bool] - field_type: typing.Optional[RemoteFieldClassFieldType] - field_format: typing.Optional[RemoteFieldClassFieldFormat] - field_choices: typing.Optional[typing.List[RemoteFieldClassFieldChoicesItem]] - item_schema: typing.Optional[ItemSchema] + id: typing.Optional[str] = None + display_name: typing.Optional[str] = None + remote_key_name: typing.Optional[str] = None + description: typing.Optional[str] = None + is_custom: typing.Optional[bool] = None + is_required: typing.Optional[bool] = None + field_type: typing.Optional[RemoteFieldClassFieldType] = None + field_format: typing.Optional[RemoteFieldClassFieldFormat] = None + field_choices: typing.Optional[typing.List[RemoteFieldClassFieldChoicesItem]] = None + item_schema: typing.Optional[ItemSchema] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/remote_field_class_field_choices_item.py b/src/merge/resources/ticketing/types/remote_field_class_field_choices_item.py index 8ae991ae..0778af8b 100644 --- a/src/merge/resources/ticketing/types/remote_field_class_field_choices_item.py +++ b/src/merge/resources/ticketing/types/remote_field_class_field_choices_item.py @@ -7,8 +7,8 @@ class RemoteFieldClassFieldChoicesItem(UniversalBaseModel): - value: typing.Optional[typing.Optional[typing.Any]] - display_name: typing.Optional[str] + value: typing.Optional[typing.Optional[typing.Any]] = None + display_name: typing.Optional[str] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/remote_field_request.py b/src/merge/resources/ticketing/types/remote_field_request.py index 6483b16a..2056f566 100644 --- a/src/merge/resources/ticketing/types/remote_field_request.py +++ b/src/merge/resources/ticketing/types/remote_field_request.py @@ -9,7 +9,7 @@ class RemoteFieldRequest(UniversalBaseModel): remote_field_class: RemoteFieldRequestRemoteFieldClass - value: typing.Optional[str] + value: typing.Optional[str] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/remote_response.py b/src/merge/resources/ticketing/types/remote_response.py index e2d1620d..49988647 100644 --- a/src/merge/resources/ticketing/types/remote_response.py +++ b/src/merge/resources/ticketing/types/remote_response.py @@ -23,10 +23,10 @@ class RemoteResponse(UniversalBaseModel): method: str path: str status: int - response: typing.Optional[typing.Any] - response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - response_type: typing.Optional[ResponseTypeEnum] - headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + response: typing.Optional[typing.Any] = None + response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + response_type: typing.Optional[ResponseTypeEnum] = 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 diff --git a/src/merge/resources/ticketing/types/role.py b/src/merge/resources/ticketing/types/role.py index 0e5ce38e..87a4ba0a 100644 --- a/src/merge/resources/ticketing/types/role.py +++ b/src/merge/resources/ticketing/types/role.py @@ -23,33 +23,33 @@ class Role(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The name of the Role. """ - ticket_actions: typing.Optional[typing.List[typing.Optional[RoleTicketActionsItem]]] = pydantic.Field() + ticket_actions: typing.Optional[typing.List[typing.Optional[RoleTicketActionsItem]]] = pydantic.Field(default=None) """ The set of actions that a User with this Role can perform. Possible enum values include: `VIEW`, `CREATE`, `EDIT`, `DELETE`, `CLOSE`, and `ASSIGN`. """ - ticket_access: typing.Optional[RoleTicketAccess] = pydantic.Field() + ticket_access: typing.Optional[RoleTicketAccess] = pydantic.Field(default=None) """ The level of Ticket access that a User with this Role can perform. @@ -58,13 +58,13 @@ class Role(UniversalBaseModel): - `TEAM_ONLY` - TEAM_ONLY """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ticketing/types/sync_status.py b/src/merge/resources/ticketing/types/sync_status.py index f9a62229..c1a01c18 100644 --- a/src/merge/resources/ticketing/types/sync_status.py +++ b/src/merge/resources/ticketing/types/sync_status.py @@ -24,11 +24,11 @@ class SyncStatus(UniversalBaseModel): model_name: str model_id: str - last_sync_start: typing.Optional[dt.datetime] - next_sync_start: typing.Optional[dt.datetime] + last_sync_start: typing.Optional[dt.datetime] = None + next_sync_start: typing.Optional[dt.datetime] = None status: SyncStatusStatusEnum is_initial_sync: bool - selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] + 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 diff --git a/src/merge/resources/ticketing/types/tag.py b/src/merge/resources/ticketing/types/tag.py index 303dad8d..d3b15d15 100644 --- a/src/merge/resources/ticketing/types/tag.py +++ b/src/merge/resources/ticketing/types/tag.py @@ -21,34 +21,34 @@ class Tag(UniversalBaseModel): TODO """ - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The datetime that this object was modified by Merge. """ - id: typing.Optional[str] - name: typing.Optional[str] = pydantic.Field() + id: typing.Optional[str] = None + name: typing.Optional[str] = pydantic.Field(default=None) """ The tag's name. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ticketing/types/team.py b/src/merge/resources/ticketing/types/team.py index 28055471..6fbd95f5 100644 --- a/src/merge/resources/ticketing/types/team.py +++ b/src/merge/resources/ticketing/types/team.py @@ -21,39 +21,39 @@ class Team(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The team's name. """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The team's description. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ticketing/types/ticket.py b/src/merge/resources/ticketing/types/ticket.py index 08a1550f..c04b3af0 100644 --- a/src/merge/resources/ticketing/types/ticket.py +++ b/src/merge/resources/ticketing/types/ticket.py @@ -32,39 +32,39 @@ class Ticket(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The ticket's name. """ - assignees: typing.Optional[typing.List[typing.Optional[TicketAssigneesItem]]] - creator: typing.Optional[TicketCreator] = pydantic.Field() + assignees: typing.Optional[typing.List[typing.Optional[TicketAssigneesItem]]] = None + creator: typing.Optional[TicketCreator] = pydantic.Field(default=None) """ The user who created this ticket. """ - due_date: typing.Optional[dt.datetime] = pydantic.Field() + due_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The ticket's due date. """ - status: typing.Optional[TicketStatus] = pydantic.Field() + status: typing.Optional[TicketStatus] = pydantic.Field(default=None) """ The current status of the ticket. @@ -74,60 +74,60 @@ class Ticket(UniversalBaseModel): - `ON_HOLD` - ON_HOLD """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The ticket’s description. HTML version of description is mapped if supported by the third-party platform. """ - collections: typing.Optional[typing.List[typing.Optional[TicketCollectionsItem]]] - ticket_type: typing.Optional[str] = pydantic.Field() + collections: typing.Optional[typing.List[typing.Optional[TicketCollectionsItem]]] = None + ticket_type: typing.Optional[str] = pydantic.Field(default=None) """ The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do. """ - account: typing.Optional[TicketAccount] = pydantic.Field() + account: typing.Optional[TicketAccount] = pydantic.Field(default=None) """ The account associated with the ticket. """ - contact: typing.Optional[TicketContact] = pydantic.Field() + contact: typing.Optional[TicketContact] = pydantic.Field(default=None) """ The contact associated with the ticket. """ - parent_ticket: typing.Optional["TicketParentTicket"] = pydantic.Field() + parent_ticket: typing.Optional["TicketParentTicket"] = pydantic.Field(default=None) """ The ticket's parent ticket. """ - attachments: typing.Optional[typing.List[typing.Optional["TicketAttachmentsItem"]]] - tags: typing.Optional[typing.List[typing.Optional[str]]] - remote_created_at: typing.Optional[dt.datetime] = pydantic.Field() + attachments: typing.Optional[typing.List[typing.Optional["TicketAttachmentsItem"]]] = None + tags: typing.Optional[typing.List[typing.Optional[str]]] = None + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's ticket was created. """ - remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field() + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's ticket was updated. """ - completed_at: typing.Optional[dt.datetime] = pydantic.Field() + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the ticket was completed. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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/). """ - ticket_url: typing.Optional[str] = pydantic.Field() + ticket_url: typing.Optional[str] = pydantic.Field(default=None) """ The 3rd party url of the Ticket. """ - priority: typing.Optional[TicketPriority] = pydantic.Field() + priority: typing.Optional[TicketPriority] = pydantic.Field(default=None) """ The priority or urgency of the Ticket. @@ -137,9 +137,9 @@ class Ticket(UniversalBaseModel): - `LOW` - LOW """ - field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] - remote_fields: typing.Optional[typing.List[RemoteField]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_data: typing.Optional[typing.List[RemoteData]] = None + remote_fields: typing.Optional[typing.List[RemoteField]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/ticket_request.py b/src/merge/resources/ticketing/types/ticket_request.py index 2e69d361..047538e9 100644 --- a/src/merge/resources/ticketing/types/ticket_request.py +++ b/src/merge/resources/ticketing/types/ticket_request.py @@ -35,23 +35,23 @@ class TicketRequest(UniversalBaseModel): TODO """ - name: typing.Optional[str] = pydantic.Field() + name: typing.Optional[str] = pydantic.Field(default=None) """ The ticket's name. """ - assignees: typing.Optional[typing.List[typing.Optional[TicketRequestAssigneesItem]]] - creator: typing.Optional[TicketRequestCreator] = pydantic.Field() + assignees: typing.Optional[typing.List[typing.Optional[TicketRequestAssigneesItem]]] = None + creator: typing.Optional[TicketRequestCreator] = pydantic.Field(default=None) """ The user who created this ticket. """ - due_date: typing.Optional[dt.datetime] = pydantic.Field() + due_date: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ The ticket's due date. """ - status: typing.Optional[TicketRequestStatus] = pydantic.Field() + status: typing.Optional[TicketRequestStatus] = pydantic.Field(default=None) """ The current status of the ticket. @@ -61,45 +61,45 @@ class TicketRequest(UniversalBaseModel): - `ON_HOLD` - ON_HOLD """ - description: typing.Optional[str] = pydantic.Field() + description: typing.Optional[str] = pydantic.Field(default=None) """ The ticket’s description. HTML version of description is mapped if supported by the third-party platform. """ - collections: typing.Optional[typing.List[typing.Optional[TicketRequestCollectionsItem]]] - ticket_type: typing.Optional[str] = pydantic.Field() + collections: typing.Optional[typing.List[typing.Optional[TicketRequestCollectionsItem]]] = None + ticket_type: typing.Optional[str] = pydantic.Field(default=None) """ The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do. """ - account: typing.Optional[TicketRequestAccount] = pydantic.Field() + account: typing.Optional[TicketRequestAccount] = pydantic.Field(default=None) """ The account associated with the ticket. """ - contact: typing.Optional[TicketRequestContact] = pydantic.Field() + contact: typing.Optional[TicketRequestContact] = pydantic.Field(default=None) """ The contact associated with the ticket. """ - parent_ticket: typing.Optional[TicketRequestParentTicket] = pydantic.Field() + parent_ticket: typing.Optional[TicketRequestParentTicket] = pydantic.Field(default=None) """ The ticket's parent ticket. """ - attachments: typing.Optional[typing.List[typing.Optional[TicketRequestAttachmentsItem]]] - tags: typing.Optional[typing.List[typing.Optional[str]]] - completed_at: typing.Optional[dt.datetime] = pydantic.Field() + attachments: typing.Optional[typing.List[typing.Optional[TicketRequestAttachmentsItem]]] = None + tags: typing.Optional[typing.List[typing.Optional[str]]] = None + completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the ticket was completed. """ - ticket_url: typing.Optional[str] = pydantic.Field() + ticket_url: typing.Optional[str] = pydantic.Field(default=None) """ The 3rd party url of the Ticket. """ - priority: typing.Optional[TicketRequestPriority] = pydantic.Field() + priority: typing.Optional[TicketRequestPriority] = pydantic.Field(default=None) """ The priority or urgency of the Ticket. @@ -109,9 +109,9 @@ class TicketRequest(UniversalBaseModel): - `LOW` - LOW """ - integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] - remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] + integration_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + linked_account_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + remote_fields: typing.Optional[typing.List[RemoteFieldRequest]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/merge/resources/ticketing/types/ticket_response.py b/src/merge/resources/ticketing/types/ticket_response.py index 90156ddd..ae7fe36d 100644 --- a/src/merge/resources/ticketing/types/ticket_response.py +++ b/src/merge/resources/ticketing/types/ticket_response.py @@ -18,7 +18,7 @@ class TicketResponse(UniversalBaseModel): model: Ticket warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ticketing/types/ticketing_attachment_response.py b/src/merge/resources/ticketing/types/ticketing_attachment_response.py index 8d218cb4..a2a2ed11 100644 --- a/src/merge/resources/ticketing/types/ticketing_attachment_response.py +++ b/src/merge/resources/ticketing/types/ticketing_attachment_response.py @@ -18,7 +18,7 @@ class TicketingAttachmentResponse(UniversalBaseModel): model: Attachment warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ticketing/types/ticketing_contact_response.py b/src/merge/resources/ticketing/types/ticketing_contact_response.py index 59be72d9..5c7ec9b3 100644 --- a/src/merge/resources/ticketing/types/ticketing_contact_response.py +++ b/src/merge/resources/ticketing/types/ticketing_contact_response.py @@ -14,7 +14,7 @@ class TicketingContactResponse(UniversalBaseModel): model: Contact warnings: typing.List[WarningValidationProblem] errors: typing.List[ErrorValidationProblem] - logs: typing.Optional[typing.List[DebugModeLog]] + 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 diff --git a/src/merge/resources/ticketing/types/user.py b/src/merge/resources/ticketing/types/user.py index 54e066de..c305bfba 100644 --- a/src/merge/resources/ticketing/types/user.py +++ b/src/merge/resources/ticketing/types/user.py @@ -23,51 +23,51 @@ class User(UniversalBaseModel): TODO """ - id: typing.Optional[str] - remote_id: typing.Optional[str] = pydantic.Field() + 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() + 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() + 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() + name: typing.Optional[str] = pydantic.Field(default=None) """ The user's name. """ - email_address: typing.Optional[str] = pydantic.Field() + email_address: typing.Optional[str] = pydantic.Field(default=None) """ The user's email address. """ - is_active: typing.Optional[bool] = pydantic.Field() + is_active: typing.Optional[bool] = pydantic.Field(default=None) """ Whether or not the user is active. """ - teams: typing.Optional[typing.List[typing.Optional[UserTeamsItem]]] - roles: typing.Optional[typing.List[typing.Optional[UserRolesItem]]] - avatar: typing.Optional[str] = pydantic.Field() + teams: typing.Optional[typing.List[typing.Optional[UserTeamsItem]]] = None + roles: typing.Optional[typing.List[typing.Optional[UserRolesItem]]] = None + avatar: typing.Optional[str] = pydantic.Field(default=None) """ The user's avatar picture. """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field() + 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[typing.Dict[str, typing.Optional[typing.Any]]] - remote_data: typing.Optional[typing.List[RemoteData]] + field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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 diff --git a/src/merge/resources/ticketing/types/warning_validation_problem.py b/src/merge/resources/ticketing/types/warning_validation_problem.py index d508bb6d..140199ca 100644 --- a/src/merge/resources/ticketing/types/warning_validation_problem.py +++ b/src/merge/resources/ticketing/types/warning_validation_problem.py @@ -8,7 +8,7 @@ class WarningValidationProblem(UniversalBaseModel): - source: typing.Optional[ValidationProblemSource] + source: typing.Optional[ValidationProblemSource] = None title: str detail: str problem_type: str diff --git a/src/merge/resources/ticketing/types/webhook_receiver.py b/src/merge/resources/ticketing/types/webhook_receiver.py index e8cd17aa..ac8573be 100644 --- a/src/merge/resources/ticketing/types/webhook_receiver.py +++ b/src/merge/resources/ticketing/types/webhook_receiver.py @@ -9,7 +9,7 @@ class WebhookReceiver(UniversalBaseModel): event: str is_active: bool - key: typing.Optional[str] + 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