diff --git a/.mock/definition/accounting/employees.yml b/.mock/definition/accounting/employees.yml index 3ccf25f68..bc9f9fdb4 100644 --- a/.mock/definition/accounting/employees.yml +++ b/.mock/definition/accounting/employees.yml @@ -14,6 +14,17 @@ service: request: name: EmployeesListRequest query-parameters: + company_id: + type: optional + docs: If provided, will only return employees for this company. + created_after: + type: optional + docs: If provided, will only return objects created after this datetime. + created_before: + type: optional + docs: >- + If provided, will only return objects created before this + datetime. cursor: type: optional docs: The pagination cursor value. @@ -40,9 +51,22 @@ service: docs: >- Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + modified_after: + type: optional + docs: >- + If provided, only objects synced by Merge after this date time + will be returned. + modified_before: + type: optional + docs: >- + If provided, only objects synced by Merge before this date time + will be returned. page_size: type: optional docs: Number of results to return per page. + remote_id: + type: optional + docs: The API provider's ID for the given object. response: docs: '' type: root.PaginatedEmployeeList diff --git a/.mock/definition/accounting/projects.yml b/.mock/definition/accounting/projects.yml index 097c0ff20..c83c66268 100644 --- a/.mock/definition/accounting/projects.yml +++ b/.mock/definition/accounting/projects.yml @@ -31,6 +31,17 @@ service: request: name: ProjectsListRequest query-parameters: + company_id: + type: optional + docs: If provided, will only return projects for this company. + created_after: + type: optional + docs: If provided, will only return objects created after this datetime. + created_before: + type: optional + docs: >- + If provided, will only return objects created before this + datetime. cursor: type: optional docs: The pagination cursor value. @@ -57,9 +68,22 @@ service: docs: >- Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + modified_after: + type: optional + docs: >- + If provided, only objects synced by Merge after this date time + will be returned. + modified_before: + type: optional + docs: >- + If provided, only objects synced by Merge before this date time + will be returned. page_size: type: optional docs: Number of results to return per page. + remote_id: + type: optional + docs: The API provider's ID for the given object. response: docs: '' type: root.PaginatedProjectList diff --git a/package.json b/package.json index 62bc1c558..d5da4dde5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@mergeapi/merge-node-client", - "version": "2.0.0", + "version": "2.0.1", "private": false, "repository": "https://github.com/merge-api/merge-node-client", "main": "./index.js", diff --git a/reference.md b/reference.md index dea183a1e..fcd0ba3fa 100644 --- a/reference.md +++ b/reference.md @@ -1,8 +1,8 @@ # Reference -## Ats AccountDetails +## Filestorage AccountDetails -
client.ats.accountDetails.retrieve() -> Merge.AccountDetails +
client.filestorage.accountDetails.retrieve() -> Merge.AccountDetails
@@ -30,7 +30,7 @@ Get details for a linked account.
```typescript -await client.ats.accountDetails.retrieve(); +await client.filestorage.accountDetails.retrieve(); ```
@@ -57,9 +57,9 @@ await client.ats.accountDetails.retrieve();
-## Ats AccountToken +## Filestorage AccountToken -
client.ats.accountToken.retrieve(publicToken) -> Merge.AccountToken +
client.filestorage.accountToken.retrieve(publicToken) -> Merge.AccountToken
@@ -87,7 +87,7 @@ Returns the account token for the end user with the provided public token.
```typescript -await client.ats.accountToken.retrieve("public_token"); +await client.filestorage.accountToken.retrieve("public_token"); ```
@@ -122,9 +122,9 @@ await client.ats.accountToken.retrieve("public_token");
-## Ats Activities +## Filestorage AsyncPassthrough -
client.ats.activities.list({ ...params }) -> Merge.PaginatedActivityList +
client.filestorage.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
@@ -136,7 +136,7 @@ await client.ats.accountToken.retrieve("public_token");
-Returns a list of `Activity` objects. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -152,7 +152,10 @@ Returns a list of `Activity` objects.
```typescript -await client.ats.activities.list(); +await client.filestorage.asyncPassthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -168,7 +171,7 @@ await client.ats.activities.list();
-**request:** `Merge.ats.ActivitiesListRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -176,7 +179,7 @@ await client.ats.activities.list();
-**requestOptions:** `Activities.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -187,7 +190,7 @@ await client.ats.activities.list();
-
client.ats.activities.create({ ...params }) -> Merge.ActivityResponse +
client.filestorage.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
@@ -199,7 +202,7 @@ await client.ats.activities.list();
-Creates an `Activity` object with the given values. +Retrieves data from earlier async-passthrough POST request
@@ -215,10 +218,7 @@ Creates an `Activity` object with the given values.
```typescript -await client.ats.activities.create({ - model: {}, - remoteUserId: "remote_user_id", -}); +await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
@@ -234,7 +234,7 @@ await client.ats.activities.create({
-**request:** `Merge.ats.ActivityEndpointRequest` +**asyncPassthroughReceiptId:** `string`
@@ -242,7 +242,7 @@ await client.ats.activities.create({
-**requestOptions:** `Activities.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -253,7 +253,9 @@ await client.ats.activities.create({
-
client.ats.activities.retrieve(id, { ...params }) -> Merge.Activity +## Filestorage AuditTrail + +
client.filestorage.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
@@ -265,7 +267,7 @@ await client.ats.activities.create({
-Returns an `Activity` object with the given `id`. +Gets a list of audit trail events.
@@ -281,7 +283,7 @@ Returns an `Activity` object with the given `id`.
```typescript -await client.ats.activities.retrieve("id"); +await client.filestorage.auditTrail.list(); ```
@@ -297,15 +299,7 @@ await client.ats.activities.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.ActivitiesRetrieveRequest` +**request:** `Merge.filestorage.AuditTrailListRequest`
@@ -313,7 +307,7 @@ await client.ats.activities.retrieve("id");
-**requestOptions:** `Activities.RequestOptions` +**requestOptions:** `AuditTrail.RequestOptions`
@@ -324,7 +318,9 @@ await client.ats.activities.retrieve("id");
-
client.ats.activities.metaPostRetrieve() -> Merge.MetaResponse +## Filestorage AvailableActions + +
client.filestorage.availableActions.retrieve() -> Merge.AvailableActions
@@ -336,7 +332,7 @@ await client.ats.activities.retrieve("id");
-Returns metadata for `Activity` POSTs. +Returns a list of models and actions available for an account.
@@ -352,7 +348,7 @@ Returns metadata for `Activity` POSTs.
```typescript -await client.ats.activities.metaPostRetrieve(); +await client.filestorage.availableActions.retrieve(); ```
@@ -368,7 +364,7 @@ await client.ats.activities.metaPostRetrieve();
-**requestOptions:** `Activities.RequestOptions` +**requestOptions:** `AvailableActions.RequestOptions`
@@ -379,9 +375,9 @@ await client.ats.activities.metaPostRetrieve();
-## Ats Applications +## Filestorage Scopes -
client.ats.applications.list({ ...params }) -> Merge.PaginatedApplicationList +
client.filestorage.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -393,7 +389,7 @@ await client.ats.activities.metaPostRetrieve();
-Returns a list of `Application` objects. +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).
@@ -409,7 +405,7 @@ Returns a list of `Application` objects.
```typescript -await client.ats.applications.list(); +await client.filestorage.scopes.defaultScopesRetrieve(); ```
@@ -425,15 +421,7 @@ await client.ats.applications.list();
-**request:** `Merge.ats.ApplicationsListRequest` - -
-
- -
-
- -**requestOptions:** `Applications.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -444,7 +432,7 @@ await client.ats.applications.list();
-
client.ats.applications.create({ ...params }) -> Merge.ApplicationResponse +
client.filestorage.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -456,10 +444,7 @@ await client.ats.applications.list();
-Creates an `Application` object with the given values. -For certain integrations, but not all, our API detects duplicate candidates and will associate applications with existing records in the third-party. New candidates are created and automatically linked to the application. - -See our [Help Center article](https://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024) for detailed support per integration. +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).
@@ -475,10 +460,7 @@ See our [Help Center article](https://help.merge.dev/en/articles/10012366-update
```typescript -await client.ats.applications.create({ - model: {}, - remoteUserId: "remote_user_id", -}); +await client.filestorage.scopes.linkedAccountScopesRetrieve(); ```
@@ -494,15 +476,7 @@ await client.ats.applications.create({
-**request:** `Merge.ats.ApplicationEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Applications.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -513,7 +487,7 @@ await client.ats.applications.create({
-
client.ats.applications.retrieve(id, { ...params }) -> Merge.Application +
client.filestorage.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
@@ -525,7 +499,7 @@ await client.ats.applications.create({
-Returns an `Application` object with the given `id`. +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)
@@ -541,7 +515,33 @@ Returns an `Application` object with the given `id`.
```typescript -await client.ats.applications.retrieve("id"); +await client.filestorage.scopes.linkedAccountScopesCreate({ + commonModels: [ + { + modelName: "Employee", + modelPermissions: { + READ: { + isEnabled: true, + }, + WRITE: { + isEnabled: false, + }, + }, + fieldPermissions: { + enabledFields: ["avatar", "home_location"], + disabledFields: ["work_location"], + }, + }, + { + modelName: "Benefit", + modelPermissions: { + WRITE: { + isEnabled: false, + }, + }, + }, + ], +}); ```
@@ -557,15 +557,7 @@ await client.ats.applications.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.ApplicationsRetrieveRequest` +**request:** `Merge.filestorage.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -573,7 +565,7 @@ await client.ats.applications.retrieve("id");
-**requestOptions:** `Applications.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -584,7 +576,9 @@ await client.ats.applications.retrieve("id");
-
client.ats.applications.changeStageCreate(id, { ...params }) -> Merge.ApplicationResponse +## Filestorage DeleteAccount + +
client.filestorage.deleteAccount.delete() -> void
@@ -596,7 +590,7 @@ await client.ats.applications.retrieve("id");
-Updates the `current_stage` field of an `Application` object +Delete a linked account.
@@ -612,7 +606,7 @@ Updates the `current_stage` field of an `Application` object
```typescript -await client.ats.applications.changeStageCreate("id"); +await client.filestorage.deleteAccount.delete(); ```
@@ -628,23 +622,7 @@ await client.ats.applications.changeStageCreate("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.UpdateApplicationStageRequest` - -
-
- -
-
- -**requestOptions:** `Applications.RequestOptions` +**requestOptions:** `DeleteAccount.RequestOptions`
@@ -655,7 +633,9 @@ await client.ats.applications.changeStageCreate("id");
-
client.ats.applications.metaPostRetrieve({ ...params }) -> Merge.MetaResponse +## Filestorage Drives + +
client.filestorage.drives.list({ ...params }) -> Merge.PaginatedDriveList
@@ -667,7 +647,7 @@ await client.ats.applications.changeStageCreate("id");
-Returns metadata for `Application` POSTs. +Returns a list of `Drive` objects.
@@ -683,7 +663,7 @@ Returns metadata for `Application` POSTs.
```typescript -await client.ats.applications.metaPostRetrieve(); +await client.filestorage.drives.list(); ```
@@ -699,7 +679,7 @@ await client.ats.applications.metaPostRetrieve();
-**request:** `Merge.ats.ApplicationsMetaPostRetrieveRequest` +**request:** `Merge.filestorage.DrivesListRequest`
@@ -707,7 +687,7 @@ await client.ats.applications.metaPostRetrieve();
-**requestOptions:** `Applications.RequestOptions` +**requestOptions:** `Drives.RequestOptions`
@@ -718,9 +698,7 @@ await client.ats.applications.metaPostRetrieve();
-## Ats AsyncPassthrough - -
client.ats.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept +
client.filestorage.drives.retrieve(id, { ...params }) -> Merge.Drive
@@ -732,7 +710,7 @@ await client.ats.applications.metaPostRetrieve();
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a `Drive` object with the given `id`.
@@ -748,10 +726,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```typescript -await client.ats.asyncPassthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.filestorage.drives.retrieve("id"); ```
@@ -767,7 +742,7 @@ await client.ats.asyncPassthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**id:** `string`
@@ -775,7 +750,15 @@ await client.ats.asyncPassthrough.create({
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**request:** `Merge.filestorage.DrivesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Drives.RequestOptions`
@@ -786,7 +769,9 @@ await client.ats.asyncPassthrough.create({
-
client.ats.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse +## Filestorage FieldMapping + +
client.filestorage.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
@@ -798,7 +783,7 @@ await client.ats.asyncPassthrough.create({
-Retrieves data from earlier async-passthrough POST request +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/).
@@ -814,7 +799,7 @@ Retrieves data from earlier async-passthrough POST request
```typescript -await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id"); +await client.filestorage.fieldMapping.fieldMappingsRetrieve(); ```
@@ -830,7 +815,7 @@ await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**asyncPassthroughReceiptId:** `string` +**request:** `Merge.filestorage.FieldMappingsRetrieveRequest`
@@ -838,7 +823,7 @@ await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -849,9 +834,7 @@ await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-## Ats Attachments - -
client.ats.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList +
client.filestorage.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
@@ -863,7 +846,7 @@ await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-Returns a list of `Attachment` 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.
@@ -879,7 +862,14 @@ Returns a list of `Attachment` objects.
```typescript -await client.ats.attachments.list(); +await client.filestorage.fieldMapping.fieldMappingsCreate({ + targetFieldName: "example_target_field_name", + targetFieldDescription: "this is a example description of the target field", + remoteFieldTraversalPath: ["example_remote_field"], + remoteMethod: "GET", + remoteUrlPath: "/example-url-path", + commonModelName: "ExampleCommonModel", +}); ```
@@ -895,7 +885,7 @@ await client.ats.attachments.list();
-**request:** `Merge.ats.AttachmentsListRequest` +**request:** `Merge.filestorage.CreateFieldMappingRequest`
@@ -903,7 +893,7 @@ await client.ats.attachments.list();
-**requestOptions:** `Attachments.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -914,7 +904,7 @@ await client.ats.attachments.list();
-
client.ats.attachments.create({ ...params }) -> Merge.AttachmentResponse +
client.filestorage.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
@@ -926,7 +916,7 @@ await client.ats.attachments.list();
-Creates an `Attachment` object with the given values. +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.
@@ -942,10 +932,7 @@ Creates an `Attachment` object with the given values.
```typescript -await client.ats.attachments.create({ - model: {}, - remoteUserId: "remote_user_id", -}); +await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
@@ -961,7 +948,7 @@ await client.ats.attachments.create({
-**request:** `Merge.ats.AttachmentEndpointRequest` +**fieldMappingId:** `string`
@@ -969,7 +956,7 @@ await client.ats.attachments.create({
-**requestOptions:** `Attachments.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -980,7 +967,7 @@ await client.ats.attachments.create({
-
client.ats.attachments.retrieve(id, { ...params }) -> Merge.Attachment +
client.filestorage.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
@@ -992,7 +979,7 @@ await client.ats.attachments.create({
-Returns an `Attachment` object with the given `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.
@@ -1008,7 +995,7 @@ Returns an `Attachment` object with the given `id`.
```typescript -await client.ats.attachments.retrieve("id"); +await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); ```
@@ -1024,7 +1011,7 @@ await client.ats.attachments.retrieve("id");
-**id:** `string` +**fieldMappingId:** `string`
@@ -1032,7 +1019,7 @@ await client.ats.attachments.retrieve("id");
-**request:** `Merge.ats.AttachmentsRetrieveRequest` +**request:** `Merge.filestorage.PatchedEditFieldMappingRequest`
@@ -1040,7 +1027,7 @@ await client.ats.attachments.retrieve("id");
-**requestOptions:** `Attachments.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -1051,7 +1038,7 @@ await client.ats.attachments.retrieve("id");
-
client.ats.attachments.metaPostRetrieve() -> Merge.MetaResponse +
client.filestorage.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
@@ -1063,7 +1050,7 @@ await client.ats.attachments.retrieve("id");
-Returns metadata for `Attachment` POSTs. +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/).
@@ -1079,7 +1066,7 @@ Returns metadata for `Attachment` POSTs.
```typescript -await client.ats.attachments.metaPostRetrieve(); +await client.filestorage.fieldMapping.remoteFieldsRetrieve(); ```
@@ -1095,7 +1082,15 @@ await client.ats.attachments.metaPostRetrieve();
-**requestOptions:** `Attachments.RequestOptions` +**request:** `Merge.filestorage.RemoteFieldsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -1106,9 +1101,7 @@ await client.ats.attachments.metaPostRetrieve();
-## Ats AuditTrail - -
client.ats.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList +
client.filestorage.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
@@ -1120,7 +1113,7 @@ await client.ats.attachments.metaPostRetrieve();
-Gets a list of audit trail events. +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/).
@@ -1136,7 +1129,7 @@ Gets a list of audit trail events.
```typescript -await client.ats.auditTrail.list(); +await client.filestorage.fieldMapping.targetFieldsRetrieve(); ```
@@ -1152,15 +1145,7 @@ await client.ats.auditTrail.list();
-**request:** `Merge.ats.AuditTrailListRequest` - -
-
- -
-
- -**requestOptions:** `AuditTrail.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -1171,9 +1156,9 @@ await client.ats.auditTrail.list();
-## Ats AvailableActions +## Filestorage Files -
client.ats.availableActions.retrieve() -> Merge.AvailableActions +
client.filestorage.files.list({ ...params }) -> Merge.PaginatedFileList
@@ -1185,7 +1170,7 @@ await client.ats.auditTrail.list();
-Returns a list of models and actions available for an account. +Returns a list of `File` objects.
@@ -1201,7 +1186,7 @@ Returns a list of models and actions available for an account.
```typescript -await client.ats.availableActions.retrieve(); +await client.filestorage.files.list(); ```
@@ -1217,7 +1202,15 @@ await client.ats.availableActions.retrieve();
-**requestOptions:** `AvailableActions.RequestOptions` +**request:** `Merge.filestorage.FilesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Files.RequestOptions`
@@ -1228,9 +1221,7 @@ await client.ats.availableActions.retrieve();
-## Ats Candidates - -
client.ats.candidates.list({ ...params }) -> Merge.PaginatedCandidateList +
client.filestorage.files.create({ ...params }) -> Merge.FileStorageFileResponse
@@ -1242,7 +1233,7 @@ await client.ats.availableActions.retrieve();
-Returns a list of `Candidate` objects. +Creates a `File` object with the given values.
@@ -1258,7 +1249,9 @@ Returns a list of `Candidate` objects.
```typescript -await client.ats.candidates.list(); +await client.filestorage.files.create({ + model: {}, +}); ```
@@ -1274,7 +1267,7 @@ await client.ats.candidates.list();
-**request:** `Merge.ats.CandidatesListRequest` +**request:** `Merge.filestorage.FileStorageFileEndpointRequest`
@@ -1282,7 +1275,7 @@ await client.ats.candidates.list();
-**requestOptions:** `Candidates.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -1293,7 +1286,7 @@ await client.ats.candidates.list();
-
client.ats.candidates.create({ ...params }) -> Merge.CandidateResponse +
client.filestorage.files.retrieve(id, { ...params }) -> Merge.File_
@@ -1305,7 +1298,7 @@ await client.ats.candidates.list();
-Creates a `Candidate` object with the given values. +Returns a `File` object with the given `id`.
@@ -1321,10 +1314,7 @@ Creates a `Candidate` object with the given values.
```typescript -await client.ats.candidates.create({ - model: {}, - remoteUserId: "remote_user_id", -}); +await client.filestorage.files.retrieve("id"); ```
@@ -1340,7 +1330,7 @@ await client.ats.candidates.create({
-**request:** `Merge.ats.CandidateEndpointRequest` +**id:** `string`
@@ -1348,7 +1338,15 @@ await client.ats.candidates.create({
-**requestOptions:** `Candidates.RequestOptions` +**request:** `Merge.filestorage.FilesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Files.RequestOptions`
@@ -1359,7 +1357,7 @@ await client.ats.candidates.create({
-
client.ats.candidates.retrieve(id, { ...params }) -> Merge.Candidate +
client.filestorage.files.downloadRequestMetaRetrieve(id, { ...params }) -> Merge.DownloadRequestMeta
@@ -1371,7 +1369,7 @@ await client.ats.candidates.create({
-Returns a `Candidate` object with the given `id`. +Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -1387,7 +1385,7 @@ Returns a `Candidate` object with the given `id`.
```typescript -await client.ats.candidates.retrieve("id"); +await client.filestorage.files.downloadRequestMetaRetrieve("id"); ```
@@ -1411,7 +1409,7 @@ await client.ats.candidates.retrieve("id");
-**request:** `Merge.ats.CandidatesRetrieveRequest` +**request:** `Merge.filestorage.FilesDownloadRequestMetaRetrieveRequest`
@@ -1419,7 +1417,7 @@ await client.ats.candidates.retrieve("id");
-**requestOptions:** `Candidates.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -1430,7 +1428,7 @@ await client.ats.candidates.retrieve("id");
-
client.ats.candidates.partialUpdate(id, { ...params }) -> Merge.CandidateResponse +
client.filestorage.files.downloadRequestMetaList({ ...params }) -> Merge.PaginatedDownloadRequestMetaList
@@ -1442,7 +1440,7 @@ await client.ats.candidates.retrieve("id");
-Updates a `Candidate` object with the given `id`. +Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -1458,10 +1456,7 @@ Updates a `Candidate` object with the given `id`.
```typescript -await client.ats.candidates.partialUpdate("id", { - model: {}, - remoteUserId: "remote_user_id", -}); +await client.filestorage.files.downloadRequestMetaList(); ```
@@ -1477,15 +1472,7 @@ await client.ats.candidates.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.PatchedCandidateEndpointRequest` +**request:** `Merge.filestorage.FilesDownloadRequestMetaListRequest`
@@ -1493,7 +1480,7 @@ await client.ats.candidates.partialUpdate("id", {
-**requestOptions:** `Candidates.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -1504,7 +1491,7 @@ await client.ats.candidates.partialUpdate("id", {
-
client.ats.candidates.ignoreCreate(modelId, { ...params }) -> void +
client.filestorage.files.metaPostRetrieve() -> Merge.MetaResponse
@@ -1516,7 +1503,7 @@ await client.ats.candidates.partialUpdate("id", {
-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 metadata for `FileStorageFile` POSTs.
@@ -1532,9 +1519,7 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```typescript -await client.ats.candidates.ignoreCreate("model_id", { - reason: "GENERAL_CUSTOMER_REQUEST", -}); +await client.filestorage.files.metaPostRetrieve(); ```
@@ -1550,23 +1535,7 @@ await client.ats.candidates.ignoreCreate("model_id", {
-**modelId:** `string` - -
-
- -
-
- -**request:** `Merge.ats.IgnoreCommonModelRequest` - -
-
- -
-
- -**requestOptions:** `Candidates.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -1577,7 +1546,9 @@ await client.ats.candidates.ignoreCreate("model_id", {
-
client.ats.candidates.metaPatchRetrieve(id) -> Merge.MetaResponse +## Filestorage Folders + +
client.filestorage.folders.list({ ...params }) -> Merge.PaginatedFolderList
@@ -1589,7 +1560,7 @@ await client.ats.candidates.ignoreCreate("model_id", {
-Returns metadata for `Candidate` PATCHs. +Returns a list of `Folder` objects.
@@ -1605,7 +1576,7 @@ Returns metadata for `Candidate` PATCHs.
```typescript -await client.ats.candidates.metaPatchRetrieve("id"); +await client.filestorage.folders.list(); ```
@@ -1621,7 +1592,7 @@ await client.ats.candidates.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.filestorage.FoldersListRequest`
@@ -1629,7 +1600,7 @@ await client.ats.candidates.metaPatchRetrieve("id");
-**requestOptions:** `Candidates.RequestOptions` +**requestOptions:** `Folders.RequestOptions`
@@ -1640,7 +1611,7 @@ await client.ats.candidates.metaPatchRetrieve("id");
-
client.ats.candidates.metaPostRetrieve() -> Merge.MetaResponse +
client.filestorage.folders.create({ ...params }) -> Merge.FileStorageFolderResponse
@@ -1652,7 +1623,7 @@ await client.ats.candidates.metaPatchRetrieve("id");
-Returns metadata for `Candidate` POSTs. +Creates a `Folder` object with the given values.
@@ -1668,7 +1639,9 @@ Returns metadata for `Candidate` POSTs.
```typescript -await client.ats.candidates.metaPostRetrieve(); +await client.filestorage.folders.create({ + model: {}, +}); ```
@@ -1684,7 +1657,15 @@ await client.ats.candidates.metaPostRetrieve();
-**requestOptions:** `Candidates.RequestOptions` +**request:** `Merge.filestorage.FileStorageFolderEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Folders.RequestOptions`
@@ -1695,9 +1676,7 @@ await client.ats.candidates.metaPostRetrieve();
-## Ats Scopes - -
client.ats.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi +
client.filestorage.folders.retrieve(id, { ...params }) -> Merge.Folder
@@ -1709,7 +1688,7 @@ await client.ats.candidates.metaPostRetrieve();
-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 `Folder` object with the given `id`.
@@ -1725,7 +1704,7 @@ Get the default permissions for Merge Common Models and fields across all Linked
```typescript -await client.ats.scopes.defaultScopesRetrieve(); +await client.filestorage.folders.retrieve("id"); ```
@@ -1741,7 +1720,23 @@ await client.ats.scopes.defaultScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.filestorage.FoldersRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Folders.RequestOptions`
@@ -1752,7 +1747,7 @@ await client.ats.scopes.defaultScopesRetrieve();
-
client.ats.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi +
client.filestorage.folders.metaPostRetrieve() -> Merge.MetaResponse
@@ -1764,7 +1759,7 @@ await client.ats.scopes.defaultScopesRetrieve();
-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 metadata for `FileStorageFolder` POSTs.
@@ -1780,7 +1775,7 @@ Get all available permissions for Merge Common Models and fields for a single Li
```typescript -await client.ats.scopes.linkedAccountScopesRetrieve(); +await client.filestorage.folders.metaPostRetrieve(); ```
@@ -1796,7 +1791,7 @@ await client.ats.scopes.linkedAccountScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `Folders.RequestOptions`
@@ -1807,7 +1802,9 @@ await client.ats.scopes.linkedAccountScopesRetrieve();
-
client.ats.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi +## Filestorage GenerateKey + +
client.filestorage.generateKey.create({ ...params }) -> Merge.RemoteKey
@@ -1819,7 +1816,7 @@ await client.ats.scopes.linkedAccountScopesRetrieve();
-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 a remote key.
@@ -1835,33 +1832,9 @@ Update permissions for any Common Model or field for a single Linked Account. An
```typescript -await client.ats.scopes.linkedAccountScopesCreate({ - commonModels: [ - { - modelName: "Employee", - modelPermissions: { - READ: { - isEnabled: true, - }, - WRITE: { - isEnabled: false, - }, - }, - fieldPermissions: { - enabledFields: ["avatar", "home_location"], - disabledFields: ["work_location"], - }, - }, - { - modelName: "Benefit", - modelPermissions: { - WRITE: { - isEnabled: false, - }, - }, - }, - ], -}); +await client.filestorage.generateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -1877,7 +1850,7 @@ await client.ats.scopes.linkedAccountScopesCreate({
-**request:** `Merge.ats.LinkedAccountCommonModelScopeDeserializerRequest` +**request:** `Merge.filestorage.GenerateRemoteKeyRequest`
@@ -1885,7 +1858,7 @@ await client.ats.scopes.linkedAccountScopesCreate({
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `GenerateKey.RequestOptions`
@@ -1896,9 +1869,9 @@ await client.ats.scopes.linkedAccountScopesCreate({
-## Ats DeleteAccount +## Filestorage Groups -
client.ats.deleteAccount.delete() -> void +
client.filestorage.groups.list({ ...params }) -> Merge.PaginatedGroupList
@@ -1910,7 +1883,7 @@ await client.ats.scopes.linkedAccountScopesCreate({
-Delete a linked account. +Returns a list of `Group` objects.
@@ -1926,7 +1899,7 @@ Delete a linked account.
```typescript -await client.ats.deleteAccount.delete(); +await client.filestorage.groups.list(); ```
@@ -1942,7 +1915,15 @@ await client.ats.deleteAccount.delete();
-**requestOptions:** `DeleteAccount.RequestOptions` +**request:** `Merge.filestorage.GroupsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Groups.RequestOptions`
@@ -1953,9 +1934,7 @@ await client.ats.deleteAccount.delete();
-## Ats Departments - -
client.ats.departments.list({ ...params }) -> Merge.PaginatedDepartmentList +
client.filestorage.groups.retrieve(id, { ...params }) -> Merge.Group
@@ -1967,7 +1946,7 @@ await client.ats.deleteAccount.delete();
-Returns a list of `Department` objects. +Returns a `Group` object with the given `id`.
@@ -1983,7 +1962,7 @@ Returns a list of `Department` objects.
```typescript -await client.ats.departments.list(); +await client.filestorage.groups.retrieve("id"); ```
@@ -1999,7 +1978,7 @@ await client.ats.departments.list();
-**request:** `Merge.ats.DepartmentsListRequest` +**id:** `string`
@@ -2007,7 +1986,15 @@ await client.ats.departments.list();
-**requestOptions:** `Departments.RequestOptions` +**request:** `Merge.filestorage.GroupsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Groups.RequestOptions`
@@ -2018,7 +2005,9 @@ await client.ats.departments.list();
-
client.ats.departments.retrieve(id, { ...params }) -> Merge.Department +## Filestorage Issues + +
client.filestorage.issues.list({ ...params }) -> Merge.PaginatedIssueList
@@ -2030,7 +2019,7 @@ await client.ats.departments.list();
-Returns a `Department` object with the given `id`. +Gets all issues for Organization.
@@ -2046,7 +2035,7 @@ Returns a `Department` object with the given `id`.
```typescript -await client.ats.departments.retrieve("id"); +await client.filestorage.issues.list(); ```
@@ -2062,15 +2051,7 @@ await client.ats.departments.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.DepartmentsRetrieveRequest` +**request:** `Merge.filestorage.IssuesListRequest`
@@ -2078,7 +2059,7 @@ await client.ats.departments.retrieve("id");
-**requestOptions:** `Departments.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -2089,9 +2070,7 @@ await client.ats.departments.retrieve("id");
-## Ats Eeocs - -
client.ats.eeocs.list({ ...params }) -> Merge.PaginatedEeocList +
client.filestorage.issues.retrieve(id) -> Merge.Issue
@@ -2103,7 +2082,7 @@ await client.ats.departments.retrieve("id");
-Returns a list of `EEOC` objects. +Get a specific issue.
@@ -2119,7 +2098,7 @@ Returns a list of `EEOC` objects.
```typescript -await client.ats.eeocs.list(); +await client.filestorage.issues.retrieve("id"); ```
@@ -2135,7 +2114,7 @@ await client.ats.eeocs.list();
-**request:** `Merge.ats.EeocsListRequest` +**id:** `string`
@@ -2143,7 +2122,7 @@ await client.ats.eeocs.list();
-**requestOptions:** `Eeocs.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -2154,7 +2133,9 @@ await client.ats.eeocs.list();
-
client.ats.eeocs.retrieve(id, { ...params }) -> Merge.Eeoc +## Filestorage LinkToken + +
client.filestorage.linkToken.create({ ...params }) -> Merge.LinkToken
@@ -2166,7 +2147,7 @@ await client.ats.eeocs.list();
-Returns an `EEOC` object with the given `id`. +Creates a link token to be used when linking a new end user.
@@ -2182,7 +2163,12 @@ Returns an `EEOC` object with the given `id`.
```typescript -await client.ats.eeocs.retrieve("id"); +await client.filestorage.linkToken.create({ + endUserEmailAddress: "example@gmail.com", + endUserOrganizationName: "Test Organization", + endUserOriginId: "12345", + categories: ["hris", "ats"], +}); ```
@@ -2198,15 +2184,7 @@ await client.ats.eeocs.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.EeocsRetrieveRequest` +**request:** `Merge.filestorage.EndUserDetailsRequest`
@@ -2214,7 +2192,7 @@ await client.ats.eeocs.retrieve("id");
-**requestOptions:** `Eeocs.RequestOptions` +**requestOptions:** `LinkToken.RequestOptions`
@@ -2225,9 +2203,9 @@ await client.ats.eeocs.retrieve("id");
-## Ats FieldMapping +## Filestorage LinkedAccounts -
client.ats.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse +
client.filestorage.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
@@ -2239,7 +2217,7 @@ await client.ats.eeocs.retrieve("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/). +List linked accounts for your organization.
@@ -2255,7 +2233,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```typescript -await client.ats.fieldMapping.fieldMappingsRetrieve(); +await client.filestorage.linkedAccounts.list(); ```
@@ -2271,7 +2249,7 @@ await client.ats.fieldMapping.fieldMappingsRetrieve();
-**request:** `Merge.ats.FieldMappingsRetrieveRequest` +**request:** `Merge.filestorage.LinkedAccountsListRequest`
@@ -2279,7 +2257,7 @@ await client.ats.fieldMapping.fieldMappingsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -2290,7 +2268,9 @@ await client.ats.fieldMapping.fieldMappingsRetrieve();
-
client.ats.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse +## Filestorage Passthrough + +
client.filestorage.passthrough.create({ ...params }) -> Merge.RemoteResponse
@@ -2302,7 +2282,7 @@ await client.ats.fieldMapping.fieldMappingsRetrieve();
-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. +Pull data from an endpoint not currently supported by Merge.
@@ -2318,13 +2298,9 @@ Create new Field Mappings that will be available after the next scheduled sync.
```typescript -await client.ats.fieldMapping.fieldMappingsCreate({ - targetFieldName: "example_target_field_name", - targetFieldDescription: "this is a example description of the target field", - remoteFieldTraversalPath: ["example_remote_field"], - remoteMethod: "GET", - remoteUrlPath: "/example-url-path", - commonModelName: "ExampleCommonModel", +await client.filestorage.passthrough.create({ + method: "GET", + path: "/scooters", }); ``` @@ -2341,7 +2317,7 @@ await client.ats.fieldMapping.fieldMappingsCreate({
-**request:** `Merge.ats.CreateFieldMappingRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -2349,7 +2325,7 @@ await client.ats.fieldMapping.fieldMappingsCreate({
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Passthrough.RequestOptions`
@@ -2360,7 +2336,9 @@ await client.ats.fieldMapping.fieldMappingsCreate({
-
client.ats.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse +## Filestorage RegenerateKey + +
client.filestorage.regenerateKey.create({ ...params }) -> Merge.RemoteKey
@@ -2372,7 +2350,7 @@ await client.ats.fieldMapping.fieldMappingsCreate({
-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. +Exchange remote keys.
@@ -2388,7 +2366,9 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
```typescript -await client.ats.fieldMapping.fieldMappingsDestroy("field_mapping_id"); +await client.filestorage.regenerateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -2404,7 +2384,7 @@ await client.ats.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**fieldMappingId:** `string` +**request:** `Merge.filestorage.RemoteKeyForRegenerationRequest`
@@ -2412,7 +2392,7 @@ await client.ats.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `RegenerateKey.RequestOptions`
@@ -2423,7 +2403,9 @@ await client.ats.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
client.ats.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse +## Filestorage SyncStatus + +
client.filestorage.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
@@ -2435,7 +2417,7 @@ await client.ats.fieldMapping.fieldMappingsDestroy("field_mapping_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. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -2451,7 +2433,7 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```typescript -await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); +await client.filestorage.syncStatus.list(); ```
@@ -2467,15 +2449,7 @@ await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**fieldMappingId:** `string` - -
-
- -
-
- -**request:** `Merge.ats.PatchedEditFieldMappingRequest` +**request:** `Merge.filestorage.SyncStatusListRequest`
@@ -2483,7 +2457,7 @@ await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `SyncStatus.RequestOptions`
@@ -2494,7 +2468,9 @@ await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
client.ats.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse +## Filestorage ForceResync + +
client.filestorage.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
@@ -2506,7 +2482,7 @@ await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_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/). +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -2522,7 +2498,7 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```typescript -await client.ats.fieldMapping.remoteFieldsRetrieve(); +await client.filestorage.forceResync.syncStatusResyncCreate(); ```
@@ -2538,15 +2514,7 @@ await client.ats.fieldMapping.remoteFieldsRetrieve();
-**request:** `Merge.ats.RemoteFieldsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `ForceResync.RequestOptions`
@@ -2557,7 +2525,9 @@ await client.ats.fieldMapping.remoteFieldsRetrieve();
-
client.ats.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse +## Filestorage Users + +
client.filestorage.users.list({ ...params }) -> Merge.PaginatedUserList
@@ -2569,7 +2539,7 @@ await client.ats.fieldMapping.remoteFieldsRetrieve();
-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 `User` objects.
@@ -2585,7 +2555,7 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```typescript -await client.ats.fieldMapping.targetFieldsRetrieve(); +await client.filestorage.users.list(); ```
@@ -2601,7 +2571,15 @@ await client.ats.fieldMapping.targetFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.filestorage.UsersListRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions`
@@ -2612,9 +2590,7 @@ await client.ats.fieldMapping.targetFieldsRetrieve();
-## Ats GenerateKey - -
client.ats.generateKey.create({ ...params }) -> Merge.RemoteKey +
client.filestorage.users.retrieve(id, { ...params }) -> Merge.User
@@ -2626,7 +2602,7 @@ await client.ats.fieldMapping.targetFieldsRetrieve();
-Create a remote key. +Returns a `User` object with the given `id`.
@@ -2642,9 +2618,7 @@ Create a remote key.
```typescript -await client.ats.generateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.filestorage.users.retrieve("id"); ```
@@ -2660,7 +2634,7 @@ await client.ats.generateKey.create({
-**request:** `Merge.ats.GenerateRemoteKeyRequest` +**id:** `string`
@@ -2668,7 +2642,15 @@ await client.ats.generateKey.create({
-**requestOptions:** `GenerateKey.RequestOptions` +**request:** `Merge.filestorage.UsersRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions`
@@ -2679,9 +2661,9 @@ await client.ats.generateKey.create({
-## Ats Interviews +## Filestorage WebhookReceivers -
client.ats.interviews.list({ ...params }) -> Merge.PaginatedScheduledInterviewList +
client.filestorage.webhookReceivers.list() -> Merge.WebhookReceiver[]
@@ -2693,7 +2675,7 @@ await client.ats.generateKey.create({
-Returns a list of `ScheduledInterview` objects. +Returns a list of `WebhookReceiver` objects.
@@ -2709,7 +2691,7 @@ Returns a list of `ScheduledInterview` objects.
```typescript -await client.ats.interviews.list(); +await client.filestorage.webhookReceivers.list(); ```
@@ -2725,15 +2707,7 @@ await client.ats.interviews.list();
-**request:** `Merge.ats.InterviewsListRequest` - -
-
- -
-
- -**requestOptions:** `Interviews.RequestOptions` +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -2744,7 +2718,7 @@ await client.ats.interviews.list();
-
client.ats.interviews.create({ ...params }) -> Merge.ScheduledInterviewResponse +
client.filestorage.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
@@ -2756,7 +2730,7 @@ await client.ats.interviews.list();
-Creates a `ScheduledInterview` object with the given values. +Creates a `WebhookReceiver` object with the given values.
@@ -2772,9 +2746,9 @@ Creates a `ScheduledInterview` object with the given values.
```typescript -await client.ats.interviews.create({ - model: {}, - remoteUserId: "remote_user_id", +await client.filestorage.webhookReceivers.create({ + event: "event", + isActive: true, }); ``` @@ -2791,7 +2765,7 @@ await client.ats.interviews.create({
-**request:** `Merge.ats.ScheduledInterviewEndpointRequest` +**request:** `Merge.filestorage.WebhookReceiverRequest`
@@ -2799,7 +2773,7 @@ await client.ats.interviews.create({
-**requestOptions:** `Interviews.RequestOptions` +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -2810,7 +2784,9 @@ await client.ats.interviews.create({
-
client.ats.interviews.retrieve(id, { ...params }) -> Merge.ScheduledInterview +## Hris AccountDetails + +
client.hris.accountDetails.retrieve() -> Merge.AccountDetails
@@ -2822,7 +2798,7 @@ await client.ats.interviews.create({
-Returns a `ScheduledInterview` object with the given `id`. +Get details for a linked account.
@@ -2838,7 +2814,7 @@ Returns a `ScheduledInterview` object with the given `id`.
```typescript -await client.ats.interviews.retrieve("id"); +await client.hris.accountDetails.retrieve(); ```
@@ -2854,23 +2830,7 @@ await client.ats.interviews.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.InterviewsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Interviews.RequestOptions` +**requestOptions:** `AccountDetails.RequestOptions`
@@ -2881,7 +2841,9 @@ await client.ats.interviews.retrieve("id");
-
client.ats.interviews.metaPostRetrieve() -> Merge.MetaResponse +## Hris AccountToken + +
client.hris.accountToken.retrieve(publicToken) -> Merge.AccountToken
@@ -2893,7 +2855,7 @@ await client.ats.interviews.retrieve("id");
-Returns metadata for `ScheduledInterview` POSTs. +Returns the account token for the end user with the provided public token.
@@ -2909,7 +2871,7 @@ Returns metadata for `ScheduledInterview` POSTs.
```typescript -await client.ats.interviews.metaPostRetrieve(); +await client.hris.accountToken.retrieve("public_token"); ```
@@ -2925,7 +2887,15 @@ await client.ats.interviews.metaPostRetrieve();
-**requestOptions:** `Interviews.RequestOptions` +**publicToken:** `string` + +
+
+ +
+
+ +**requestOptions:** `AccountToken.RequestOptions`
@@ -2936,9 +2906,9 @@ await client.ats.interviews.metaPostRetrieve();
-## Ats Issues +## Hris AsyncPassthrough -
client.ats.issues.list({ ...params }) -> Merge.PaginatedIssueList +
client.hris.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
@@ -2950,7 +2920,7 @@ await client.ats.interviews.metaPostRetrieve();
-Gets all issues for Organization. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -2966,7 +2936,10 @@ Gets all issues for Organization.
```typescript -await client.ats.issues.list(); +await client.hris.asyncPassthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -2982,7 +2955,7 @@ await client.ats.issues.list();
-**request:** `Merge.ats.IssuesListRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -2990,7 +2963,7 @@ await client.ats.issues.list();
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -3001,7 +2974,7 @@ await client.ats.issues.list();
-
client.ats.issues.retrieve(id) -> Merge.Issue +
client.hris.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
@@ -3013,7 +2986,7 @@ await client.ats.issues.list();
-Get a specific issue. +Retrieves data from earlier async-passthrough POST request
@@ -3029,7 +3002,7 @@ Get a specific issue.
```typescript -await client.ats.issues.retrieve("id"); +await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
@@ -3045,7 +3018,7 @@ await client.ats.issues.retrieve("id");
-**id:** `string` +**asyncPassthroughReceiptId:** `string`
@@ -3053,7 +3026,7 @@ await client.ats.issues.retrieve("id");
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -3064,9 +3037,9 @@ await client.ats.issues.retrieve("id");
-## Ats JobInterviewStages +## Hris AuditTrail -
client.ats.jobInterviewStages.list({ ...params }) -> Merge.PaginatedJobInterviewStageList +
client.hris.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
@@ -3078,7 +3051,7 @@ await client.ats.issues.retrieve("id");
-Returns a list of `JobInterviewStage` objects. +Gets a list of audit trail events.
@@ -3094,7 +3067,7 @@ Returns a list of `JobInterviewStage` objects.
```typescript -await client.ats.jobInterviewStages.list(); +await client.hris.auditTrail.list(); ```
@@ -3110,7 +3083,7 @@ await client.ats.jobInterviewStages.list();
-**request:** `Merge.ats.JobInterviewStagesListRequest` +**request:** `Merge.hris.AuditTrailListRequest`
@@ -3118,7 +3091,7 @@ await client.ats.jobInterviewStages.list();
-**requestOptions:** `JobInterviewStages.RequestOptions` +**requestOptions:** `AuditTrail.RequestOptions`
@@ -3129,7 +3102,9 @@ await client.ats.jobInterviewStages.list();
-
client.ats.jobInterviewStages.retrieve(id, { ...params }) -> Merge.JobInterviewStage +## Hris AvailableActions + +
client.hris.availableActions.retrieve() -> Merge.AvailableActions
@@ -3141,7 +3116,7 @@ await client.ats.jobInterviewStages.list();
-Returns a `JobInterviewStage` object with the given `id`. +Returns a list of models and actions available for an account.
@@ -3157,7 +3132,7 @@ Returns a `JobInterviewStage` object with the given `id`.
```typescript -await client.ats.jobInterviewStages.retrieve("id"); +await client.hris.availableActions.retrieve(); ```
@@ -3173,23 +3148,7 @@ await client.ats.jobInterviewStages.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.JobInterviewStagesRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `JobInterviewStages.RequestOptions` +**requestOptions:** `AvailableActions.RequestOptions`
@@ -3200,9 +3159,9 @@ await client.ats.jobInterviewStages.retrieve("id");
-## Ats JobPostings +## Hris BankInfo -
client.ats.jobPostings.list({ ...params }) -> Merge.PaginatedJobPostingList +
client.hris.bankInfo.list({ ...params }) -> Merge.PaginatedBankInfoList
@@ -3214,7 +3173,7 @@ await client.ats.jobInterviewStages.retrieve("id");
-Returns a list of `JobPosting` objects. +Returns a list of `BankInfo` objects.
@@ -3230,7 +3189,7 @@ Returns a list of `JobPosting` objects.
```typescript -await client.ats.jobPostings.list(); +await client.hris.bankInfo.list(); ```
@@ -3246,7 +3205,7 @@ await client.ats.jobPostings.list();
-**request:** `Merge.ats.JobPostingsListRequest` +**request:** `Merge.hris.BankInfoListRequest`
@@ -3254,7 +3213,7 @@ await client.ats.jobPostings.list();
-**requestOptions:** `JobPostings.RequestOptions` +**requestOptions:** `BankInfo.RequestOptions`
@@ -3265,7 +3224,7 @@ await client.ats.jobPostings.list();
-
client.ats.jobPostings.retrieve(id, { ...params }) -> Merge.JobPosting +
client.hris.bankInfo.retrieve(id, { ...params }) -> Merge.BankInfo
@@ -3277,7 +3236,7 @@ await client.ats.jobPostings.list();
-Returns a `JobPosting` object with the given `id`. +Returns a `BankInfo` object with the given `id`.
@@ -3293,7 +3252,7 @@ Returns a `JobPosting` object with the given `id`.
```typescript -await client.ats.jobPostings.retrieve("id"); +await client.hris.bankInfo.retrieve("id"); ```
@@ -3317,7 +3276,7 @@ await client.ats.jobPostings.retrieve("id");
-**request:** `Merge.ats.JobPostingsRetrieveRequest` +**request:** `Merge.hris.BankInfoRetrieveRequest`
@@ -3325,7 +3284,7 @@ await client.ats.jobPostings.retrieve("id");
-**requestOptions:** `JobPostings.RequestOptions` +**requestOptions:** `BankInfo.RequestOptions`
@@ -3336,9 +3295,9 @@ await client.ats.jobPostings.retrieve("id");
-## Ats Jobs +## Hris Benefits -
client.ats.jobs.list({ ...params }) -> Merge.PaginatedJobList +
client.hris.benefits.list({ ...params }) -> Merge.PaginatedBenefitList
@@ -3350,7 +3309,7 @@ await client.ats.jobPostings.retrieve("id");
-Returns a list of `Job` objects. +Returns a list of `Benefit` objects.
@@ -3366,7 +3325,7 @@ Returns a list of `Job` objects.
```typescript -await client.ats.jobs.list(); +await client.hris.benefits.list(); ```
@@ -3382,7 +3341,7 @@ await client.ats.jobs.list();
-**request:** `Merge.ats.JobsListRequest` +**request:** `Merge.hris.BenefitsListRequest`
@@ -3390,7 +3349,7 @@ await client.ats.jobs.list();
-**requestOptions:** `Jobs.RequestOptions` +**requestOptions:** `Benefits.RequestOptions`
@@ -3401,7 +3360,7 @@ await client.ats.jobs.list();
-
client.ats.jobs.retrieve(id, { ...params }) -> Merge.Job +
client.hris.benefits.retrieve(id, { ...params }) -> Merge.Benefit
@@ -3413,7 +3372,7 @@ await client.ats.jobs.list();
-Returns a `Job` object with the given `id`. +Returns a `Benefit` object with the given `id`.
@@ -3429,7 +3388,7 @@ Returns a `Job` object with the given `id`.
```typescript -await client.ats.jobs.retrieve("id"); +await client.hris.benefits.retrieve("id"); ```
@@ -3453,7 +3412,7 @@ await client.ats.jobs.retrieve("id");
-**request:** `Merge.ats.JobsRetrieveRequest` +**request:** `Merge.hris.BenefitsRetrieveRequest`
@@ -3461,7 +3420,7 @@ await client.ats.jobs.retrieve("id");
-**requestOptions:** `Jobs.RequestOptions` +**requestOptions:** `Benefits.RequestOptions`
@@ -3472,7 +3431,9 @@ await client.ats.jobs.retrieve("id");
-
client.ats.jobs.screeningQuestionsList(jobId, { ...params }) -> Merge.PaginatedScreeningQuestionList +## Hris Companies + +
client.hris.companies.list({ ...params }) -> Merge.PaginatedCompanyList
@@ -3484,7 +3445,7 @@ await client.ats.jobs.retrieve("id");
-Returns a list of `ScreeningQuestion` objects. +Returns a list of `Company` objects.
@@ -3500,7 +3461,7 @@ Returns a list of `ScreeningQuestion` objects.
```typescript -await client.ats.jobs.screeningQuestionsList("job_id"); +await client.hris.companies.list(); ```
@@ -3516,15 +3477,7 @@ await client.ats.jobs.screeningQuestionsList("job_id");
-**jobId:** `string` - -
-
- -
-
- -**request:** `Merge.ats.JobsScreeningQuestionsListRequest` +**request:** `Merge.hris.CompaniesListRequest`
@@ -3532,7 +3485,7 @@ await client.ats.jobs.screeningQuestionsList("job_id");
-**requestOptions:** `Jobs.RequestOptions` +**requestOptions:** `Companies.RequestOptions`
@@ -3543,9 +3496,7 @@ await client.ats.jobs.screeningQuestionsList("job_id");
-## Ats LinkToken - -
client.ats.linkToken.create({ ...params }) -> Merge.LinkToken +
client.hris.companies.retrieve(id, { ...params }) -> Merge.Company
@@ -3557,7 +3508,7 @@ await client.ats.jobs.screeningQuestionsList("job_id");
-Creates a link token to be used when linking a new end user. +Returns a `Company` object with the given `id`.
@@ -3573,12 +3524,7 @@ Creates a link token to be used when linking a new end user.
```typescript -await client.ats.linkToken.create({ - endUserEmailAddress: "example@gmail.com", - endUserOrganizationName: "Test Organization", - endUserOriginId: "12345", - categories: ["hris", "ats"], -}); +await client.hris.companies.retrieve("id"); ```
@@ -3594,7 +3540,7 @@ await client.ats.linkToken.create({
-**request:** `Merge.ats.EndUserDetailsRequest` +**id:** `string`
@@ -3602,7 +3548,15 @@ await client.ats.linkToken.create({
-**requestOptions:** `LinkToken.RequestOptions` +**request:** `Merge.hris.CompaniesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Companies.RequestOptions`
@@ -3613,9 +3567,9 @@ await client.ats.linkToken.create({
-## Ats LinkedAccounts +## Hris Scopes -
client.ats.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList +
client.hris.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -3627,7 +3581,7 @@ await client.ats.linkToken.create({
-List linked accounts for your organization. +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).
@@ -3643,7 +3597,7 @@ List linked accounts for your organization.
```typescript -await client.ats.linkedAccounts.list(); +await client.hris.scopes.defaultScopesRetrieve(); ```
@@ -3659,15 +3613,7 @@ await client.ats.linkedAccounts.list();
-**request:** `Merge.ats.LinkedAccountsListRequest` - -
-
- -
-
- -**requestOptions:** `LinkedAccounts.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -3678,9 +3624,7 @@ await client.ats.linkedAccounts.list();
-## Ats Offers - -
client.ats.offers.list({ ...params }) -> Merge.PaginatedOfferList +
client.hris.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -3692,7 +3636,7 @@ await client.ats.linkedAccounts.list();
-Returns a list of `Offer` objects. +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).
@@ -3708,7 +3652,7 @@ Returns a list of `Offer` objects.
```typescript -await client.ats.offers.list(); +await client.hris.scopes.linkedAccountScopesRetrieve(); ```
@@ -3724,15 +3668,7 @@ await client.ats.offers.list();
-**request:** `Merge.ats.OffersListRequest` - -
-
- -
-
- -**requestOptions:** `Offers.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -3743,7 +3679,7 @@ await client.ats.offers.list();
-
client.ats.offers.retrieve(id, { ...params }) -> Merge.Offer +
client.hris.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
@@ -3755,7 +3691,7 @@ await client.ats.offers.list();
-Returns an `Offer` object with the given `id`. +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)
@@ -3771,31 +3707,49 @@ Returns an `Offer` object with the given `id`.
```typescript -await client.ats.offers.retrieve("id"); -``` - -
-
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `string` - +await client.hris.scopes.linkedAccountScopesCreate({ + commonModels: [ + { + modelName: "Employee", + modelPermissions: { + READ: { + isEnabled: true, + }, + WRITE: { + isEnabled: false, + }, + }, + fieldPermissions: { + enabledFields: ["avatar", "home_location"], + disabledFields: ["work_location"], + }, + }, + { + modelName: "Benefit", + modelPermissions: { + WRITE: { + isEnabled: false, + }, + }, + }, + ], +}); +``` + +
+
+#### ⚙️ Parameters +
-**request:** `Merge.ats.OffersRetrieveRequest` +
+
+ +**request:** `Merge.hris.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -3803,7 +3757,7 @@ await client.ats.offers.retrieve("id");
-**requestOptions:** `Offers.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -3814,9 +3768,9 @@ await client.ats.offers.retrieve("id");
-## Ats Offices +## Hris DeleteAccount -
client.ats.offices.list({ ...params }) -> Merge.PaginatedOfficeList +
client.hris.deleteAccount.delete() -> void
@@ -3828,7 +3782,7 @@ await client.ats.offers.retrieve("id");
-Returns a list of `Office` objects. +Delete a linked account.
@@ -3844,7 +3798,7 @@ Returns a list of `Office` objects.
```typescript -await client.ats.offices.list(); +await client.hris.deleteAccount.delete(); ```
@@ -3860,15 +3814,7 @@ await client.ats.offices.list();
-**request:** `Merge.ats.OfficesListRequest` - -
-
- -
-
- -**requestOptions:** `Offices.RequestOptions` +**requestOptions:** `DeleteAccount.RequestOptions`
@@ -3879,7 +3825,9 @@ await client.ats.offices.list();
-
client.ats.offices.retrieve(id, { ...params }) -> Merge.Office +## Hris Dependents + +
client.hris.dependents.list({ ...params }) -> Merge.PaginatedDependentList
@@ -3891,7 +3839,7 @@ await client.ats.offices.list();
-Returns an `Office` object with the given `id`. +Returns a list of `Dependent` objects.
@@ -3907,7 +3855,7 @@ Returns an `Office` object with the given `id`.
```typescript -await client.ats.offices.retrieve("id"); +await client.hris.dependents.list(); ```
@@ -3923,15 +3871,7 @@ await client.ats.offices.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.OfficesRetrieveRequest` +**request:** `Merge.hris.DependentsListRequest`
@@ -3939,7 +3879,7 @@ await client.ats.offices.retrieve("id");
-**requestOptions:** `Offices.RequestOptions` +**requestOptions:** `Dependents.RequestOptions`
@@ -3950,9 +3890,7 @@ await client.ats.offices.retrieve("id");
-## Ats Passthrough - -
client.ats.passthrough.create({ ...params }) -> Merge.RemoteResponse +
client.hris.dependents.retrieve(id, { ...params }) -> Merge.Dependent
@@ -3964,7 +3902,7 @@ await client.ats.offices.retrieve("id");
-Pull data from an endpoint not currently supported by Merge. +Returns a `Dependent` object with the given `id`.
@@ -3980,10 +3918,7 @@ Pull data from an endpoint not currently supported by Merge.
```typescript -await client.ats.passthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.hris.dependents.retrieve("id"); ```
@@ -3999,7 +3934,7 @@ await client.ats.passthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**id:** `string`
@@ -4007,7 +3942,15 @@ await client.ats.passthrough.create({
-**requestOptions:** `Passthrough.RequestOptions` +**request:** `Merge.hris.DependentsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Dependents.RequestOptions`
@@ -4018,9 +3961,9 @@ await client.ats.passthrough.create({
-## Ats RegenerateKey +## Hris EmployeePayrollRuns -
client.ats.regenerateKey.create({ ...params }) -> Merge.RemoteKey +
client.hris.employeePayrollRuns.list({ ...params }) -> Merge.PaginatedEmployeePayrollRunList
@@ -4032,7 +3975,7 @@ await client.ats.passthrough.create({
-Exchange remote keys. +Returns a list of `EmployeePayrollRun` objects.
@@ -4048,9 +3991,7 @@ Exchange remote keys.
```typescript -await client.ats.regenerateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.hris.employeePayrollRuns.list(); ```
@@ -4066,7 +4007,7 @@ await client.ats.regenerateKey.create({
-**request:** `Merge.ats.RemoteKeyForRegenerationRequest` +**request:** `Merge.hris.EmployeePayrollRunsListRequest`
@@ -4074,7 +4015,7 @@ await client.ats.regenerateKey.create({
-**requestOptions:** `RegenerateKey.RequestOptions` +**requestOptions:** `EmployeePayrollRuns.RequestOptions`
@@ -4085,9 +4026,7 @@ await client.ats.regenerateKey.create({
-## Ats RejectReasons - -
client.ats.rejectReasons.list({ ...params }) -> Merge.PaginatedRejectReasonList +
client.hris.employeePayrollRuns.retrieve(id, { ...params }) -> Merge.EmployeePayrollRun
@@ -4099,7 +4038,7 @@ await client.ats.regenerateKey.create({
-Returns a list of `RejectReason` objects. +Returns an `EmployeePayrollRun` object with the given `id`.
@@ -4115,7 +4054,7 @@ Returns a list of `RejectReason` objects.
```typescript -await client.ats.rejectReasons.list(); +await client.hris.employeePayrollRuns.retrieve("id"); ```
@@ -4131,7 +4070,7 @@ await client.ats.rejectReasons.list();
-**request:** `Merge.ats.RejectReasonsListRequest` +**id:** `string`
@@ -4139,7 +4078,15 @@ await client.ats.rejectReasons.list();
-**requestOptions:** `RejectReasons.RequestOptions` +**request:** `Merge.hris.EmployeePayrollRunsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `EmployeePayrollRuns.RequestOptions`
@@ -4150,7 +4097,9 @@ await client.ats.rejectReasons.list();
-
client.ats.rejectReasons.retrieve(id, { ...params }) -> Merge.RejectReason +## Hris Employees + +
client.hris.employees.list({ ...params }) -> Merge.PaginatedEmployeeList
@@ -4162,7 +4111,7 @@ await client.ats.rejectReasons.list();
-Returns a `RejectReason` object with the given `id`. +Returns a list of `Employee` objects.
@@ -4178,7 +4127,7 @@ Returns a `RejectReason` object with the given `id`.
```typescript -await client.ats.rejectReasons.retrieve("id"); +await client.hris.employees.list(); ```
@@ -4194,15 +4143,7 @@ await client.ats.rejectReasons.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.RejectReasonsRetrieveRequest` +**request:** `Merge.hris.EmployeesListRequest`
@@ -4210,7 +4151,7 @@ await client.ats.rejectReasons.retrieve("id");
-**requestOptions:** `RejectReasons.RequestOptions` +**requestOptions:** `Employees.RequestOptions`
@@ -4221,9 +4162,7 @@ await client.ats.rejectReasons.retrieve("id");
-## Ats Scorecards - -
client.ats.scorecards.list({ ...params }) -> Merge.PaginatedScorecardList +
client.hris.employees.create({ ...params }) -> Merge.EmployeeResponse
@@ -4235,7 +4174,7 @@ await client.ats.rejectReasons.retrieve("id");
-Returns a list of `Scorecard` objects. +Creates an `Employee` object with the given values.
@@ -4251,7 +4190,9 @@ Returns a list of `Scorecard` objects.
```typescript -await client.ats.scorecards.list(); +await client.hris.employees.create({ + model: {}, +}); ```
@@ -4267,7 +4208,7 @@ await client.ats.scorecards.list();
-**request:** `Merge.ats.ScorecardsListRequest` +**request:** `Merge.hris.EmployeeEndpointRequest`
@@ -4275,7 +4216,7 @@ await client.ats.scorecards.list();
-**requestOptions:** `Scorecards.RequestOptions` +**requestOptions:** `Employees.RequestOptions`
@@ -4286,7 +4227,7 @@ await client.ats.scorecards.list();
-
client.ats.scorecards.retrieve(id, { ...params }) -> Merge.Scorecard +
client.hris.employees.retrieve(id, { ...params }) -> Merge.Employee
@@ -4298,7 +4239,7 @@ await client.ats.scorecards.list();
-Returns a `Scorecard` object with the given `id`. +Returns an `Employee` object with the given `id`.
@@ -4314,7 +4255,7 @@ Returns a `Scorecard` object with the given `id`.
```typescript -await client.ats.scorecards.retrieve("id"); +await client.hris.employees.retrieve("id"); ```
@@ -4338,7 +4279,7 @@ await client.ats.scorecards.retrieve("id");
-**request:** `Merge.ats.ScorecardsRetrieveRequest` +**request:** `Merge.hris.EmployeesRetrieveRequest`
@@ -4346,7 +4287,7 @@ await client.ats.scorecards.retrieve("id");
-**requestOptions:** `Scorecards.RequestOptions` +**requestOptions:** `Employees.RequestOptions`
@@ -4357,9 +4298,7 @@ await client.ats.scorecards.retrieve("id");
-## Ats SyncStatus - -
client.ats.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList +
client.hris.employees.ignoreCreate(modelId, { ...params }) -> void
@@ -4371,7 +4310,7 @@ await client.ats.scorecards.retrieve("id");
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +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.
@@ -4387,7 +4326,9 @@ Get sync status for the current sync and the most recently finished sync. `last_
```typescript -await client.ats.syncStatus.list(); +await client.hris.employees.ignoreCreate("model_id", { + reason: "GENERAL_CUSTOMER_REQUEST", +}); ```
@@ -4403,7 +4344,7 @@ await client.ats.syncStatus.list();
-**request:** `Merge.ats.SyncStatusListRequest` +**modelId:** `string`
@@ -4411,7 +4352,15 @@ await client.ats.syncStatus.list();
-**requestOptions:** `SyncStatus.RequestOptions` +**request:** `Merge.hris.IgnoreCommonModelRequest` + +
+
+ +
+
+ +**requestOptions:** `Employees.RequestOptions`
@@ -4422,9 +4371,7 @@ await client.ats.syncStatus.list();
-## Ats ForceResync - -
client.ats.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[] +
client.hris.employees.metaPostRetrieve() -> Merge.MetaResponse
@@ -4436,7 +4383,7 @@ await client.ats.syncStatus.list();
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Returns metadata for `Employee` POSTs.
@@ -4452,7 +4399,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```typescript -await client.ats.forceResync.syncStatusResyncCreate(); +await client.hris.employees.metaPostRetrieve(); ```
@@ -4468,7 +4415,7 @@ await client.ats.forceResync.syncStatusResyncCreate();
-**requestOptions:** `ForceResync.RequestOptions` +**requestOptions:** `Employees.RequestOptions`
@@ -4479,9 +4426,9 @@ await client.ats.forceResync.syncStatusResyncCreate();
-## Ats Tags +## Hris EmployerBenefits -
client.ats.tags.list({ ...params }) -> Merge.PaginatedTagList +
client.hris.employerBenefits.list({ ...params }) -> Merge.PaginatedEmployerBenefitList
@@ -4493,7 +4440,7 @@ await client.ats.forceResync.syncStatusResyncCreate();
-Returns a list of `Tag` objects. +Returns a list of `EmployerBenefit` objects.
@@ -4509,7 +4456,7 @@ Returns a list of `Tag` objects.
```typescript -await client.ats.tags.list(); +await client.hris.employerBenefits.list(); ```
@@ -4525,7 +4472,7 @@ await client.ats.tags.list();
-**request:** `Merge.ats.TagsListRequest` +**request:** `Merge.hris.EmployerBenefitsListRequest`
@@ -4533,7 +4480,7 @@ await client.ats.tags.list();
-**requestOptions:** `Tags.RequestOptions` +**requestOptions:** `EmployerBenefits.RequestOptions`
@@ -4544,9 +4491,7 @@ await client.ats.tags.list();
-## Ats Users - -
client.ats.users.list({ ...params }) -> Merge.PaginatedRemoteUserList +
client.hris.employerBenefits.retrieve(id, { ...params }) -> Merge.EmployerBenefit
@@ -4558,7 +4503,7 @@ await client.ats.tags.list();
-Returns a list of `RemoteUser` objects. +Returns an `EmployerBenefit` object with the given `id`.
@@ -4574,7 +4519,7 @@ Returns a list of `RemoteUser` objects.
```typescript -await client.ats.users.list(); +await client.hris.employerBenefits.retrieve("id"); ```
@@ -4590,7 +4535,7 @@ await client.ats.users.list();
-**request:** `Merge.ats.UsersListRequest` +**id:** `string`
@@ -4598,7 +4543,15 @@ await client.ats.users.list();
-**requestOptions:** `Users.RequestOptions` +**request:** `Merge.hris.EmployerBenefitsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `EmployerBenefits.RequestOptions`
@@ -4609,7 +4562,9 @@ await client.ats.users.list();
-
client.ats.users.retrieve(id, { ...params }) -> Merge.RemoteUser +## Hris Employments + +
client.hris.employments.list({ ...params }) -> Merge.PaginatedEmploymentList
@@ -4621,7 +4576,7 @@ await client.ats.users.list();
-Returns a `RemoteUser` object with the given `id`. +Returns a list of `Employment` objects.
@@ -4637,7 +4592,7 @@ Returns a `RemoteUser` object with the given `id`.
```typescript -await client.ats.users.retrieve("id"); +await client.hris.employments.list(); ```
@@ -4653,7 +4608,7 @@ await client.ats.users.retrieve("id");
-**id:** `string` +**request:** `Merge.hris.EmploymentsListRequest`
@@ -4661,15 +4616,7 @@ await client.ats.users.retrieve("id");
-**request:** `Merge.ats.UsersRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Users.RequestOptions` +**requestOptions:** `Employments.RequestOptions`
@@ -4680,9 +4627,7 @@ await client.ats.users.retrieve("id");
-## Ats WebhookReceivers - -
client.ats.webhookReceivers.list() -> Merge.WebhookReceiver[] +
client.hris.employments.retrieve(id, { ...params }) -> Merge.Employment
@@ -4694,7 +4639,7 @@ await client.ats.users.retrieve("id");
-Returns a list of `WebhookReceiver` objects. +Returns an `Employment` object with the given `id`.
@@ -4710,7 +4655,7 @@ Returns a list of `WebhookReceiver` objects.
```typescript -await client.ats.webhookReceivers.list(); +await client.hris.employments.retrieve("id"); ```
@@ -4726,7 +4671,23 @@ await client.ats.webhookReceivers.list();
-**requestOptions:** `WebhookReceivers.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.hris.EmploymentsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Employments.RequestOptions`
@@ -4737,7 +4698,9 @@ await client.ats.webhookReceivers.list();
-
client.ats.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver +## Hris FieldMapping + +
client.hris.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
@@ -4749,7 +4712,7 @@ await client.ats.webhookReceivers.list();
-Creates a `WebhookReceiver` object with the given values. +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/).
@@ -4765,10 +4728,7 @@ Creates a `WebhookReceiver` object with the given values.
```typescript -await client.ats.webhookReceivers.create({ - event: "event", - isActive: true, -}); +await client.hris.fieldMapping.fieldMappingsRetrieve(); ```
@@ -4784,7 +4744,7 @@ await client.ats.webhookReceivers.create({
-**request:** `Merge.ats.WebhookReceiverRequest` +**request:** `Merge.hris.FieldMappingsRetrieveRequest`
@@ -4792,7 +4752,7 @@ await client.ats.webhookReceivers.create({
-**requestOptions:** `WebhookReceivers.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -4803,9 +4763,7 @@ await client.ats.webhookReceivers.create({
-## Crm AccountDetails - -
client.crm.accountDetails.retrieve() -> Merge.AccountDetails +
client.hris.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
@@ -4817,7 +4775,7 @@ await client.ats.webhookReceivers.create({
-Get details for a linked account. +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.
@@ -4833,7 +4791,14 @@ Get details for a linked account.
```typescript -await client.crm.accountDetails.retrieve(); +await client.hris.fieldMapping.fieldMappingsCreate({ + targetFieldName: "example_target_field_name", + targetFieldDescription: "this is a example description of the target field", + remoteFieldTraversalPath: ["example_remote_field"], + remoteMethod: "GET", + remoteUrlPath: "/example-url-path", + commonModelName: "ExampleCommonModel", +}); ```
@@ -4849,7 +4814,15 @@ await client.crm.accountDetails.retrieve();
-**requestOptions:** `AccountDetails.RequestOptions` +**request:** `Merge.hris.CreateFieldMappingRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -4860,9 +4833,7 @@ await client.crm.accountDetails.retrieve();
-## Crm AccountToken - -
client.crm.accountToken.retrieve(publicToken) -> Merge.AccountToken +
client.hris.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
@@ -4874,7 +4845,7 @@ await client.crm.accountDetails.retrieve();
-Returns the account token for the end user with the provided public token. +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.
@@ -4890,7 +4861,7 @@ Returns the account token for the end user with the provided public token.
```typescript -await client.crm.accountToken.retrieve("public_token"); +await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
@@ -4906,7 +4877,7 @@ await client.crm.accountToken.retrieve("public_token");
-**publicToken:** `string` +**fieldMappingId:** `string`
@@ -4914,7 +4885,7 @@ await client.crm.accountToken.retrieve("public_token");
-**requestOptions:** `AccountToken.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -4925,9 +4896,7 @@ await client.crm.accountToken.retrieve("public_token");
-## Crm Accounts - -
client.crm.accounts.list({ ...params }) -> Merge.PaginatedAccountList +
client.hris.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
@@ -4939,7 +4908,7 @@ await client.crm.accountToken.retrieve("public_token");
-Returns a list of `Account` 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.
@@ -4955,7 +4924,7 @@ Returns a list of `Account` objects.
```typescript -await client.crm.accounts.list(); +await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); ```
@@ -4971,7 +4940,7 @@ await client.crm.accounts.list();
-**request:** `Merge.crm.AccountsListRequest` +**fieldMappingId:** `string`
@@ -4979,7 +4948,15 @@ await client.crm.accounts.list();
-**requestOptions:** `Accounts.RequestOptions` +**request:** `Merge.hris.PatchedEditFieldMappingRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -4990,7 +4967,7 @@ await client.crm.accounts.list();
-
client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse +
client.hris.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
@@ -5002,7 +4979,7 @@ await client.crm.accounts.list();
-Creates an `Account` object with the given values. +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/).
@@ -5018,9 +4995,7 @@ Creates an `Account` object with the given values.
```typescript -await client.crm.accounts.create({ - model: {}, -}); +await client.hris.fieldMapping.remoteFieldsRetrieve(); ```
@@ -5036,7 +5011,7 @@ await client.crm.accounts.create({
-**request:** `Merge.crm.CrmAccountEndpointRequest` +**request:** `Merge.hris.RemoteFieldsRetrieveRequest`
@@ -5044,7 +5019,7 @@ await client.crm.accounts.create({
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -5055,7 +5030,7 @@ await client.crm.accounts.create({
-
client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account +
client.hris.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
@@ -5067,7 +5042,7 @@ await client.crm.accounts.create({
-Returns an `Account` object with the given `id`. +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/).
@@ -5083,7 +5058,7 @@ Returns an `Account` object with the given `id`.
```typescript -await client.crm.accounts.retrieve("id"); +await client.hris.fieldMapping.targetFieldsRetrieve(); ```
@@ -5099,23 +5074,7 @@ await client.crm.accounts.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.AccountsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -5126,7 +5085,9 @@ await client.crm.accounts.retrieve("id");
-
client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse +## Hris GenerateKey + +
client.hris.generateKey.create({ ...params }) -> Merge.RemoteKey
@@ -5138,7 +5099,7 @@ await client.crm.accounts.retrieve("id");
-Updates an `Account` object with the given `id`. +Create a remote key.
@@ -5154,8 +5115,8 @@ Updates an `Account` object with the given `id`.
```typescript -await client.crm.accounts.partialUpdate("id", { - model: {}, +await client.hris.generateKey.create({ + name: "Remote Deployment Key 1", }); ``` @@ -5172,15 +5133,7 @@ await client.crm.accounts.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedCrmAccountEndpointRequest` +**request:** `Merge.hris.GenerateRemoteKeyRequest`
@@ -5188,7 +5141,7 @@ await client.crm.accounts.partialUpdate("id", {
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `GenerateKey.RequestOptions`
@@ -5199,7 +5152,9 @@ await client.crm.accounts.partialUpdate("id", {
-
client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse +## Hris Groups + +
client.hris.groups.list({ ...params }) -> Merge.PaginatedGroupList
@@ -5211,7 +5166,7 @@ await client.crm.accounts.partialUpdate("id", {
-Returns metadata for `CRMAccount` PATCHs. +Returns a list of `Group` objects.
@@ -5227,7 +5182,7 @@ Returns metadata for `CRMAccount` PATCHs.
```typescript -await client.crm.accounts.metaPatchRetrieve("id"); +await client.hris.groups.list(); ```
@@ -5243,7 +5198,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.hris.GroupsListRequest`
@@ -5251,7 +5206,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Groups.RequestOptions`
@@ -5262,7 +5217,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-
client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse +
client.hris.groups.retrieve(id, { ...params }) -> Merge.Group
@@ -5274,7 +5229,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-Returns metadata for `CRMAccount` POSTs. +Returns a `Group` object with the given `id`.
@@ -5290,7 +5245,7 @@ Returns metadata for `CRMAccount` POSTs.
```typescript -await client.crm.accounts.metaPostRetrieve(); +await client.hris.groups.retrieve("id"); ```
@@ -5306,7 +5261,23 @@ await client.crm.accounts.metaPostRetrieve();
-**requestOptions:** `Accounts.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.hris.GroupsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Groups.RequestOptions`
@@ -5317,7 +5288,9 @@ await client.crm.accounts.metaPostRetrieve();
-
client.crm.accounts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Hris Issues + +
client.hris.issues.list({ ...params }) -> Merge.PaginatedIssueList
@@ -5329,7 +5302,7 @@ await client.crm.accounts.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Gets all issues for Organization.
@@ -5345,7 +5318,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.accounts.remoteFieldClassesList(); +await client.hris.issues.list(); ```
@@ -5361,7 +5334,7 @@ await client.crm.accounts.remoteFieldClassesList();
-**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest` +**request:** `Merge.hris.IssuesListRequest`
@@ -5369,7 +5342,7 @@ await client.crm.accounts.remoteFieldClassesList();
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -5380,9 +5353,7 @@ await client.crm.accounts.remoteFieldClassesList();
-## Crm AsyncPassthrough - -
client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept +
client.hris.issues.retrieve(id) -> Merge.Issue
@@ -5394,7 +5365,7 @@ await client.crm.accounts.remoteFieldClassesList();
-Asynchronously pull data from an endpoint not currently supported by Merge. +Get a specific issue.
@@ -5410,10 +5381,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```typescript -await client.crm.asyncPassthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.hris.issues.retrieve("id"); ```
@@ -5429,7 +5397,7 @@ await client.crm.asyncPassthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**id:** `string`
@@ -5437,7 +5405,7 @@ await client.crm.asyncPassthrough.create({
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -5448,7 +5416,9 @@ await client.crm.asyncPassthrough.create({
-
client.crm.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse +## Hris LinkToken + +
client.hris.linkToken.create({ ...params }) -> Merge.LinkToken
@@ -5460,7 +5430,7 @@ await client.crm.asyncPassthrough.create({
-Retrieves data from earlier async-passthrough POST request +Creates a link token to be used when linking a new end user.
@@ -5476,7 +5446,12 @@ Retrieves data from earlier async-passthrough POST request
```typescript -await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id"); +await client.hris.linkToken.create({ + endUserEmailAddress: "example@gmail.com", + endUserOrganizationName: "Test Organization", + endUserOriginId: "12345", + categories: ["hris", "ats"], +}); ```
@@ -5492,7 +5467,7 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**asyncPassthroughReceiptId:** `string` +**request:** `Merge.hris.EndUserDetailsRequest`
@@ -5500,7 +5475,7 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `LinkToken.RequestOptions`
@@ -5511,9 +5486,9 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-## Crm AuditTrail +## Hris LinkedAccounts -
client.crm.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList +
client.hris.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
@@ -5525,7 +5500,7 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-Gets a list of audit trail events. +List linked accounts for your organization.
@@ -5541,7 +5516,7 @@ Gets a list of audit trail events.
```typescript -await client.crm.auditTrail.list(); +await client.hris.linkedAccounts.list(); ```
@@ -5557,7 +5532,7 @@ await client.crm.auditTrail.list();
-**request:** `Merge.crm.AuditTrailListRequest` +**request:** `Merge.hris.LinkedAccountsListRequest`
@@ -5565,7 +5540,7 @@ await client.crm.auditTrail.list();
-**requestOptions:** `AuditTrail.RequestOptions` +**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -5576,9 +5551,9 @@ await client.crm.auditTrail.list();
-## Crm AvailableActions +## Hris Locations -
client.crm.availableActions.retrieve() -> Merge.AvailableActions +
client.hris.locations.list({ ...params }) -> Merge.PaginatedLocationList
@@ -5590,7 +5565,7 @@ await client.crm.auditTrail.list();
-Returns a list of models and actions available for an account. +Returns a list of `Location` objects.
@@ -5606,7 +5581,7 @@ Returns a list of models and actions available for an account.
```typescript -await client.crm.availableActions.retrieve(); +await client.hris.locations.list(); ```
@@ -5622,7 +5597,15 @@ await client.crm.availableActions.retrieve();
-**requestOptions:** `AvailableActions.RequestOptions` +**request:** `Merge.hris.LocationsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Locations.RequestOptions`
@@ -5633,9 +5616,7 @@ await client.crm.availableActions.retrieve();
-## Crm Contacts - -
client.crm.contacts.list({ ...params }) -> Merge.PaginatedContactList +
client.hris.locations.retrieve(id, { ...params }) -> Merge.Location
@@ -5647,7 +5628,7 @@ await client.crm.availableActions.retrieve();
-Returns a list of `Contact` objects. +Returns a `Location` object with the given `id`.
@@ -5663,7 +5644,7 @@ Returns a list of `Contact` objects.
```typescript -await client.crm.contacts.list(); +await client.hris.locations.retrieve("id"); ```
@@ -5679,7 +5660,7 @@ await client.crm.contacts.list();
-**request:** `Merge.crm.ContactsListRequest` +**id:** `string`
@@ -5687,7 +5668,15 @@ await client.crm.contacts.list();
-**requestOptions:** `Contacts.RequestOptions` +**request:** `Merge.hris.LocationsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Locations.RequestOptions`
@@ -5698,7 +5687,9 @@ await client.crm.contacts.list();
-
client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse +## Hris Passthrough + +
client.hris.passthrough.create({ ...params }) -> Merge.RemoteResponse
@@ -5710,7 +5701,7 @@ await client.crm.contacts.list();
-Creates a `Contact` object with the given values. +Pull data from an endpoint not currently supported by Merge.
@@ -5726,8 +5717,9 @@ Creates a `Contact` object with the given values.
```typescript -await client.crm.contacts.create({ - model: {}, +await client.hris.passthrough.create({ + method: "GET", + path: "/scooters", }); ``` @@ -5744,7 +5736,7 @@ await client.crm.contacts.create({
-**request:** `Merge.crm.CrmContactEndpointRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -5752,7 +5744,7 @@ await client.crm.contacts.create({
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Passthrough.RequestOptions`
@@ -5763,7 +5755,9 @@ await client.crm.contacts.create({
-
client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact +## Hris PayGroups + +
client.hris.payGroups.list({ ...params }) -> Merge.PaginatedPayGroupList
@@ -5775,7 +5769,7 @@ await client.crm.contacts.create({
-Returns a `Contact` object with the given `id`. +Returns a list of `PayGroup` objects.
@@ -5791,7 +5785,7 @@ Returns a `Contact` object with the given `id`.
```typescript -await client.crm.contacts.retrieve("id"); +await client.hris.payGroups.list(); ```
@@ -5807,15 +5801,7 @@ await client.crm.contacts.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.ContactsRetrieveRequest` +**request:** `Merge.hris.PayGroupsListRequest`
@@ -5823,7 +5809,7 @@ await client.crm.contacts.retrieve("id");
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `PayGroups.RequestOptions`
@@ -5834,7 +5820,7 @@ await client.crm.contacts.retrieve("id");
-
client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse +
client.hris.payGroups.retrieve(id, { ...params }) -> Merge.PayGroup
@@ -5846,7 +5832,7 @@ await client.crm.contacts.retrieve("id");
-Updates a `Contact` object with the given `id`. +Returns a `PayGroup` object with the given `id`.
@@ -5862,9 +5848,7 @@ Updates a `Contact` object with the given `id`.
```typescript -await client.crm.contacts.partialUpdate("id", { - model: {}, -}); +await client.hris.payGroups.retrieve("id"); ```
@@ -5888,7 +5872,7 @@ await client.crm.contacts.partialUpdate("id", {
-**request:** `Merge.crm.PatchedCrmContactEndpointRequest` +**request:** `Merge.hris.PayGroupsRetrieveRequest`
@@ -5896,7 +5880,7 @@ await client.crm.contacts.partialUpdate("id", {
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `PayGroups.RequestOptions`
@@ -5907,7 +5891,9 @@ await client.crm.contacts.partialUpdate("id", {
-
client.crm.contacts.ignoreCreate(modelId, { ...params }) -> void +## Hris PayrollRuns + +
client.hris.payrollRuns.list({ ...params }) -> Merge.PaginatedPayrollRunList
@@ -5919,7 +5905,7 @@ await client.crm.contacts.partialUpdate("id", {
-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 list of `PayrollRun` objects.
@@ -5935,9 +5921,7 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```typescript -await client.crm.contacts.ignoreCreate("model_id", { - reason: "GENERAL_CUSTOMER_REQUEST", -}); +await client.hris.payrollRuns.list(); ```
@@ -5953,15 +5937,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-**modelId:** `string` - -
-
- -
-
- -**request:** `Merge.IgnoreCommonModelRequest` +**request:** `Merge.hris.PayrollRunsListRequest`
@@ -5969,7 +5945,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `PayrollRuns.RequestOptions`
@@ -5980,7 +5956,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-
client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse +
client.hris.payrollRuns.retrieve(id, { ...params }) -> Merge.PayrollRun
@@ -5992,7 +5968,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-Returns metadata for `CRMContact` PATCHs. +Returns a `PayrollRun` object with the given `id`.
@@ -6008,7 +5984,7 @@ Returns metadata for `CRMContact` PATCHs.
```typescript -await client.crm.contacts.metaPatchRetrieve("id"); +await client.hris.payrollRuns.retrieve("id"); ```
@@ -6032,7 +6008,15 @@ await client.crm.contacts.metaPatchRetrieve("id");
-**requestOptions:** `Contacts.RequestOptions` +**request:** `Merge.hris.PayrollRunsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `PayrollRuns.RequestOptions`
@@ -6043,7 +6027,9 @@ await client.crm.contacts.metaPatchRetrieve("id");
-
client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse +## Hris RegenerateKey + +
client.hris.regenerateKey.create({ ...params }) -> Merge.RemoteKey
@@ -6055,7 +6041,7 @@ await client.crm.contacts.metaPatchRetrieve("id");
-Returns metadata for `CRMContact` POSTs. +Exchange remote keys.
@@ -6071,7 +6057,9 @@ Returns metadata for `CRMContact` POSTs.
```typescript -await client.crm.contacts.metaPostRetrieve(); +await client.hris.regenerateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -6087,7 +6075,15 @@ await client.crm.contacts.metaPostRetrieve();
-**requestOptions:** `Contacts.RequestOptions` +**request:** `Merge.hris.RemoteKeyForRegenerationRequest` + +
+
+ +
+
+ +**requestOptions:** `RegenerateKey.RequestOptions`
@@ -6098,7 +6094,9 @@ await client.crm.contacts.metaPostRetrieve();
-
client.crm.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Hris SyncStatus + +
client.hris.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
@@ -6110,7 +6108,7 @@ await client.crm.contacts.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -6126,7 +6124,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.contacts.remoteFieldClassesList(); +await client.hris.syncStatus.list(); ```
@@ -6142,7 +6140,7 @@ await client.crm.contacts.remoteFieldClassesList();
-**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest` +**request:** `Merge.hris.SyncStatusListRequest`
@@ -6150,7 +6148,7 @@ await client.crm.contacts.remoteFieldClassesList();
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `SyncStatus.RequestOptions`
@@ -6161,9 +6159,9 @@ await client.crm.contacts.remoteFieldClassesList();
-## Crm CustomObjectClasses +## Hris ForceResync -
client.crm.customObjectClasses.list({ ...params }) -> Merge.PaginatedCustomObjectClassList +
client.hris.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
@@ -6175,7 +6173,7 @@ await client.crm.contacts.remoteFieldClassesList();
-Returns a list of `CustomObjectClass` objects. +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -6191,7 +6189,7 @@ Returns a list of `CustomObjectClass` objects.
```typescript -await client.crm.customObjectClasses.list(); +await client.hris.forceResync.syncStatusResyncCreate(); ```
@@ -6207,15 +6205,7 @@ await client.crm.customObjectClasses.list();
-**request:** `Merge.crm.CustomObjectClassesListRequest` - -
-
- -
-
- -**requestOptions:** `CustomObjectClasses.RequestOptions` +**requestOptions:** `ForceResync.RequestOptions`
@@ -6226,7 +6216,9 @@ await client.crm.customObjectClasses.list();
-
client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass +## Hris Teams + +
client.hris.teams.list({ ...params }) -> Merge.PaginatedTeamList
@@ -6238,7 +6230,7 @@ await client.crm.customObjectClasses.list();
-Returns a `CustomObjectClass` object with the given `id`. +Returns a list of `Team` objects.
@@ -6254,7 +6246,7 @@ Returns a `CustomObjectClass` object with the given `id`.
```typescript -await client.crm.customObjectClasses.retrieve("id"); +await client.hris.teams.list(); ```
@@ -6270,15 +6262,7 @@ await client.crm.customObjectClasses.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesRetrieveRequest` +**request:** `Merge.hris.TeamsListRequest`
@@ -6286,7 +6270,7 @@ await client.crm.customObjectClasses.retrieve("id");
-**requestOptions:** `CustomObjectClasses.RequestOptions` +**requestOptions:** `Teams.RequestOptions`
@@ -6297,9 +6281,7 @@ await client.crm.customObjectClasses.retrieve("id");
-## Crm AssociationTypes - -
client.crm.associationTypes.customObjectClassesAssociationTypesList(customObjectClassId, { ...params }) -> Merge.PaginatedAssociationTypeList +
client.hris.teams.retrieve(id, { ...params }) -> Merge.Team
@@ -6311,7 +6293,7 @@ await client.crm.customObjectClasses.retrieve("id");
-Returns a list of `AssociationType` objects. +Returns a `Team` object with the given `id`.
@@ -6327,7 +6309,7 @@ Returns a list of `AssociationType` objects.
```typescript -await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id"); +await client.hris.teams.retrieve("id"); ```
@@ -6343,7 +6325,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-**customObjectClassId:** `string` +**id:** `string`
@@ -6351,7 +6333,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest` +**request:** `Merge.hris.TeamsRetrieveRequest`
@@ -6359,7 +6341,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-**requestOptions:** `AssociationTypes.RequestOptions` +**requestOptions:** `Teams.RequestOptions`
@@ -6370,7 +6352,9 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-
client.crm.associationTypes.customObjectClassesAssociationTypesCreate(customObjectClassId, { ...params }) -> Merge.CrmAssociationTypeResponse +## Hris TimeOff + +
client.hris.timeOff.list({ ...params }) -> Merge.PaginatedTimeOffList
@@ -6382,7 +6366,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-Creates an `AssociationType` object with the given values. +Returns a list of `TimeOff` objects.
@@ -6398,21 +6382,7 @@ Creates an `AssociationType` object with the given values.
```typescript -await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("custom_object_class_id", { - model: { - sourceObjectClass: { - id: "id", - originType: "CUSTOM_OBJECT", - }, - targetObjectClasses: [ - { - id: "id", - originType: "CUSTOM_OBJECT", - }, - ], - remoteKeyName: "remote_key_name", - }, -}); +await client.hris.timeOff.list(); ```
@@ -6428,15 +6398,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-**customObjectClassId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CrmAssociationTypeEndpointRequest` +**request:** `Merge.hris.TimeOffListRequest`
@@ -6444,7 +6406,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-**requestOptions:** `AssociationTypes.RequestOptions` +**requestOptions:** `TimeOff.RequestOptions`
@@ -6455,7 +6417,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-
client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(customObjectClassId, id, { ...params }) -> Merge.AssociationType +
client.hris.timeOff.create({ ...params }) -> Merge.TimeOffResponse
@@ -6467,7 +6429,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-Returns an `AssociationType` object with the given `id`. +Creates a `TimeOff` object with the given values.
@@ -6483,7 +6445,9 @@ Returns an `AssociationType` object with the given `id`.
```typescript -await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id"); +await client.hris.timeOff.create({ + model: {}, +}); ```
@@ -6499,7 +6463,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-**customObjectClassId:** `string` +**request:** `Merge.hris.TimeOffEndpointRequest`
@@ -6507,34 +6471,18 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-**id:** `string` +**requestOptions:** `TimeOff.RequestOptions`
- -
-
- -**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `AssociationTypes.RequestOptions` - -
-
- -
+ +
-
client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse +
client.hris.timeOff.retrieve(id, { ...params }) -> Merge.TimeOff
@@ -6546,7 +6494,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-Returns metadata for `CRMAssociationType` POSTs. +Returns a `TimeOff` object with the given `id`.
@@ -6562,7 +6510,7 @@ Returns metadata for `CRMAssociationType` POSTs.
```typescript -await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id"); +await client.hris.timeOff.retrieve("id"); ```
@@ -6578,7 +6526,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-**customObjectClassId:** `string` +**id:** `string`
@@ -6586,7 +6534,15 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-**requestOptions:** `AssociationTypes.RequestOptions` +**request:** `Merge.hris.TimeOffRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `TimeOff.RequestOptions`
@@ -6597,9 +6553,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-## Crm CustomObjects - -
client.crm.customObjects.customObjectClassesCustomObjectsList(customObjectClassId, { ...params }) -> Merge.PaginatedCustomObjectList +
client.hris.timeOff.metaPostRetrieve() -> Merge.MetaResponse
@@ -6611,7 +6565,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-Returns a list of `CustomObject` objects. +Returns metadata for `TimeOff` POSTs.
@@ -6627,7 +6581,7 @@ Returns a list of `CustomObject` objects.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id"); +await client.hris.timeOff.metaPostRetrieve(); ```
@@ -6643,23 +6597,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-**customObjectClassId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest` - -
-
- -
-
- -**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `TimeOff.RequestOptions`
@@ -6670,7 +6608,9 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-
client.crm.customObjects.customObjectClassesCustomObjectsCreate(customObjectClassId, { ...params }) -> Merge.CrmCustomObjectResponse +## Hris TimeOffBalances + +
client.hris.timeOffBalances.list({ ...params }) -> Merge.PaginatedTimeOffBalanceList
@@ -6682,7 +6622,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-Creates a `CustomObject` object with the given values. +Returns a list of `TimeOffBalance` objects.
@@ -6698,13 +6638,7 @@ Creates a `CustomObject` object with the given values.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", { - model: { - fields: { - test_field: "hello", - }, - }, -}); +await client.hris.timeOffBalances.list(); ```
@@ -6720,15 +6654,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-**customObjectClassId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CrmCustomObjectEndpointRequest` +**request:** `Merge.hris.TimeOffBalancesListRequest`
@@ -6736,7 +6662,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `TimeOffBalances.RequestOptions`
@@ -6747,7 +6673,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-
client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(customObjectClassId, id, { ...params }) -> Merge.CustomObject +
client.hris.timeOffBalances.retrieve(id, { ...params }) -> Merge.TimeOffBalance
@@ -6759,7 +6685,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-Returns a `CustomObject` object with the given `id`. +Returns a `TimeOffBalance` object with the given `id`.
@@ -6775,7 +6701,7 @@ Returns a `CustomObject` object with the given `id`.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id"); +await client.hris.timeOffBalances.retrieve("id"); ```
@@ -6791,14 +6717,6 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-**customObjectClassId:** `string` - -
-
- -
-
- **id:** `string`
@@ -6807,7 +6725,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest` +**request:** `Merge.hris.TimeOffBalancesRetrieveRequest`
@@ -6815,7 +6733,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `TimeOffBalances.RequestOptions`
@@ -6826,7 +6744,9 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-
client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse +## Hris TimesheetEntries + +
client.hris.timesheetEntries.list({ ...params }) -> Merge.PaginatedTimesheetEntryList
@@ -6838,7 +6758,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-Returns metadata for `CRMCustomObject` POSTs. +Returns a list of `TimesheetEntry` objects.
@@ -6854,7 +6774,7 @@ Returns metadata for `CRMCustomObject` POSTs.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id"); +await client.hris.timesheetEntries.list(); ```
@@ -6870,7 +6790,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-**customObjectClassId:** `string` +**request:** `Merge.hris.TimesheetEntriesListRequest`
@@ -6878,7 +6798,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `TimesheetEntries.RequestOptions`
@@ -6889,7 +6809,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-
client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.hris.timesheetEntries.create({ ...params }) -> Merge.TimesheetEntryResponse
@@ -6901,7 +6821,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-Returns a list of `RemoteFieldClass` objects. +Creates a `TimesheetEntry` object with the given values.
@@ -6917,7 +6837,9 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList(); +await client.hris.timesheetEntries.create({ + model: {}, +}); ```
@@ -6933,7 +6855,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest` +**request:** `Merge.hris.TimesheetEntryEndpointRequest`
@@ -6941,7 +6863,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `TimesheetEntries.RequestOptions`
@@ -6952,9 +6874,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-## Crm Associations - -
client.crm.associations.customObjectClassesCustomObjectsAssociationsList(customObjectClassId, objectId, { ...params }) -> Merge.PaginatedAssociationList +
client.hris.timesheetEntries.retrieve(id, { ...params }) -> Merge.TimesheetEntry
@@ -6966,7 +6886,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-Returns a list of `Association` objects. +Returns a `TimesheetEntry` object with the given `id`.
@@ -6982,7 +6902,7 @@ Returns a list of `Association` objects.
```typescript -await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id"); +await client.hris.timesheetEntries.retrieve("id"); ```
@@ -6998,15 +6918,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-**customObjectClassId:** `string` - -
-
- -
-
- -**objectId:** `string` +**id:** `string`
@@ -7014,7 +6926,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest` +**request:** `Merge.hris.TimesheetEntriesRetrieveRequest`
@@ -7022,7 +6934,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-**requestOptions:** `Associations.RequestOptions` +**requestOptions:** `TimesheetEntries.RequestOptions`
@@ -7033,7 +6945,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-
client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(associationTypeId, sourceClassId, sourceObjectId, targetClassId, targetObjectId, { ...params }) -> Merge.Association +
client.hris.timesheetEntries.metaPostRetrieve() -> Merge.MetaResponse
@@ -7045,7 +6957,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`. +Returns metadata for `TimesheetEntry` POSTs.
@@ -7061,13 +6973,7 @@ Creates an Association between `source_object_id` and `target_object_id` of type
```typescript -await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate( - "association_type_id", - "source_class_id", - "source_object_id", - "target_class_id", - "target_object_id", -); +await client.hris.timesheetEntries.metaPostRetrieve(); ```
@@ -7083,55 +6989,64 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-**associationTypeId:** `string` +**requestOptions:** `TimesheetEntries.RequestOptions`
- -
-
- -**sourceClassId:** `string` +
+
+
+## Hris WebhookReceivers + +
client.hris.webhookReceivers.list() -> Merge.WebhookReceiver[]
-**sourceObjectId:** `string` +#### 📝 Description -
-
+
+
-**targetClassId:** `string` +Returns a list of `WebhookReceiver` objects.
+
+
+ +#### 🔌 Usage
-**targetObjectId:** `string` - -
-
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest` +```typescript +await client.hris.webhookReceivers.list(); +```
+ + + +#### ⚙️ Parameters
-**requestOptions:** `Associations.RequestOptions` +
+
+ +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -7142,9 +7057,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-## Crm Scopes - -
client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi +
client.hris.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
@@ -7156,7 +7069,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-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). +Creates a `WebhookReceiver` object with the given values.
@@ -7172,7 +7085,10 @@ Get the default permissions for Merge Common Models and fields across all Linked
```typescript -await client.crm.scopes.defaultScopesRetrieve(); +await client.hris.webhookReceivers.create({ + event: "event", + isActive: true, +}); ```
@@ -7188,7 +7104,15 @@ await client.crm.scopes.defaultScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**request:** `Merge.hris.WebhookReceiverRequest` + +
+
+ +
+
+ +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -7199,7 +7123,9 @@ await client.crm.scopes.defaultScopesRetrieve();
-
client.crm.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi +## Ticketing AccountDetails + +
client.ticketing.accountDetails.retrieve() -> Merge.AccountDetails
@@ -7211,7 +7137,7 @@ await client.crm.scopes.defaultScopesRetrieve();
-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). +Get details for a linked account.
@@ -7227,7 +7153,7 @@ Get all available permissions for Merge Common Models and fields for a single Li
```typescript -await client.crm.scopes.linkedAccountScopesRetrieve(); +await client.ticketing.accountDetails.retrieve(); ```
@@ -7243,7 +7169,7 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `AccountDetails.RequestOptions`
@@ -7254,7 +7180,9 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-
client.crm.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi +## Ticketing AccountToken + +
client.ticketing.accountToken.retrieve(publicToken) -> Merge.AccountToken
@@ -7266,7 +7194,7 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-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) +Returns the account token for the end user with the provided public token.
@@ -7282,33 +7210,7 @@ Update permissions for any Common Model or field for a single Linked Account. An
```typescript -await client.crm.scopes.linkedAccountScopesCreate({ - commonModels: [ - { - modelName: "Employee", - modelPermissions: { - READ: { - isEnabled: true, - }, - WRITE: { - isEnabled: false, - }, - }, - fieldPermissions: { - enabledFields: ["avatar", "home_location"], - disabledFields: ["work_location"], - }, - }, - { - modelName: "Benefit", - modelPermissions: { - WRITE: { - isEnabled: false, - }, - }, - }, - ], -}); +await client.ticketing.accountToken.retrieve("public_token"); ```
@@ -7324,7 +7226,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest` +**publicToken:** `string`
@@ -7332,7 +7234,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `AccountToken.RequestOptions`
@@ -7343,9 +7245,9 @@ await client.crm.scopes.linkedAccountScopesCreate({
-## Crm DeleteAccount +## Ticketing Accounts -
client.crm.deleteAccount.delete() -> void +
client.ticketing.accounts.list({ ...params }) -> Merge.PaginatedAccountList
@@ -7357,7 +7259,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-Delete a linked account. +Returns a list of `Account` objects.
@@ -7373,7 +7275,7 @@ Delete a linked account.
```typescript -await client.crm.deleteAccount.delete(); +await client.ticketing.accounts.list(); ```
@@ -7389,7 +7291,15 @@ await client.crm.deleteAccount.delete();
-**requestOptions:** `DeleteAccount.RequestOptions` +**request:** `Merge.ticketing.AccountsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -7400,9 +7310,7 @@ await client.crm.deleteAccount.delete();
-## Crm EngagementTypes - -
client.crm.engagementTypes.list({ ...params }) -> Merge.PaginatedEngagementTypeList +
client.ticketing.accounts.retrieve(id, { ...params }) -> Merge.Account
@@ -7414,7 +7322,7 @@ await client.crm.deleteAccount.delete();
-Returns a list of `EngagementType` objects. +Returns an `Account` object with the given `id`.
@@ -7430,7 +7338,7 @@ Returns a list of `EngagementType` objects.
```typescript -await client.crm.engagementTypes.list(); +await client.ticketing.accounts.retrieve("id"); ```
@@ -7446,7 +7354,7 @@ await client.crm.engagementTypes.list();
-**request:** `Merge.crm.EngagementTypesListRequest` +**id:** `string`
@@ -7454,7 +7362,15 @@ await client.crm.engagementTypes.list();
-**requestOptions:** `EngagementTypes.RequestOptions` +**request:** `Merge.ticketing.AccountsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -7465,7 +7381,9 @@ await client.crm.engagementTypes.list();
-
client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType +## Ticketing AsyncPassthrough + +
client.ticketing.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
@@ -7477,7 +7395,7 @@ await client.crm.engagementTypes.list();
-Returns an `EngagementType` object with the given `id`. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -7493,7 +7411,10 @@ Returns an `EngagementType` object with the given `id`.
```typescript -await client.crm.engagementTypes.retrieve("id"); +await client.ticketing.asyncPassthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -7509,15 +7430,7 @@ await client.crm.engagementTypes.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.EngagementTypesRetrieveRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -7525,7 +7438,7 @@ await client.crm.engagementTypes.retrieve("id");
-**requestOptions:** `EngagementTypes.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -7536,7 +7449,7 @@ await client.crm.engagementTypes.retrieve("id");
-
client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.ticketing.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
@@ -7548,7 +7461,7 @@ await client.crm.engagementTypes.retrieve("id");
-Returns a list of `RemoteFieldClass` objects. +Retrieves data from earlier async-passthrough POST request
@@ -7564,7 +7477,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.engagementTypes.remoteFieldClassesList(); +await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
@@ -7580,7 +7493,7 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest` +**asyncPassthroughReceiptId:** `string`
@@ -7588,7 +7501,7 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-**requestOptions:** `EngagementTypes.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -7599,9 +7512,9 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-## Crm Engagements +## Ticketing Attachments -
client.crm.engagements.list({ ...params }) -> Merge.PaginatedEngagementList +
client.ticketing.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList
@@ -7613,7 +7526,7 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-Returns a list of `Engagement` objects. +Returns a list of `Attachment` objects.
@@ -7629,7 +7542,7 @@ Returns a list of `Engagement` objects.
```typescript -await client.crm.engagements.list(); +await client.ticketing.attachments.list(); ```
@@ -7645,7 +7558,7 @@ await client.crm.engagements.list();
-**request:** `Merge.crm.EngagementsListRequest` +**request:** `Merge.ticketing.AttachmentsListRequest`
@@ -7653,7 +7566,7 @@ await client.crm.engagements.list();
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -7664,7 +7577,7 @@ await client.crm.engagements.list();
-
client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse +
client.ticketing.attachments.create({ ...params }) -> Merge.TicketingAttachmentResponse
@@ -7676,7 +7589,7 @@ await client.crm.engagements.list();
-Creates an `Engagement` object with the given values. +Creates an `Attachment` object with the given values.
@@ -7692,7 +7605,7 @@ Creates an `Engagement` object with the given values.
```typescript -await client.crm.engagements.create({ +await client.ticketing.attachments.create({ model: {}, }); ``` @@ -7710,7 +7623,7 @@ await client.crm.engagements.create({
-**request:** `Merge.crm.EngagementEndpointRequest` +**request:** `Merge.ticketing.TicketingAttachmentEndpointRequest`
@@ -7718,7 +7631,7 @@ await client.crm.engagements.create({
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -7729,7 +7642,7 @@ await client.crm.engagements.create({
-
client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement +
client.ticketing.attachments.retrieve(id, { ...params }) -> Merge.Attachment
@@ -7741,7 +7654,7 @@ await client.crm.engagements.create({
-Returns an `Engagement` object with the given `id`. +Returns an `Attachment` object with the given `id`.
@@ -7757,7 +7670,7 @@ Returns an `Engagement` object with the given `id`.
```typescript -await client.crm.engagements.retrieve("id"); +await client.ticketing.attachments.retrieve("id"); ```
@@ -7781,7 +7694,7 @@ await client.crm.engagements.retrieve("id");
-**request:** `Merge.crm.EngagementsRetrieveRequest` +**request:** `Merge.ticketing.AttachmentsRetrieveRequest`
@@ -7789,7 +7702,7 @@ await client.crm.engagements.retrieve("id");
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -7800,7 +7713,7 @@ await client.crm.engagements.retrieve("id");
-
client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse +
client.ticketing.attachments.metaPostRetrieve() -> Merge.MetaResponse
@@ -7812,7 +7725,7 @@ await client.crm.engagements.retrieve("id");
-Updates an `Engagement` object with the given `id`. +Returns metadata for `TicketingAttachment` POSTs.
@@ -7828,9 +7741,7 @@ Updates an `Engagement` object with the given `id`.
```typescript -await client.crm.engagements.partialUpdate("id", { - model: {}, -}); +await client.ticketing.attachments.metaPostRetrieve(); ```
@@ -7846,23 +7757,7 @@ await client.crm.engagements.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedEngagementEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -7873,7 +7768,9 @@ await client.crm.engagements.partialUpdate("id", {
-
client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse +## Ticketing AuditTrail + +
client.ticketing.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
@@ -7885,7 +7782,7 @@ await client.crm.engagements.partialUpdate("id", {
-Returns metadata for `Engagement` PATCHs. +Gets a list of audit trail events.
@@ -7901,7 +7798,7 @@ Returns metadata for `Engagement` PATCHs.
```typescript -await client.crm.engagements.metaPatchRetrieve("id"); +await client.ticketing.auditTrail.list(); ```
@@ -7917,7 +7814,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.ticketing.AuditTrailListRequest`
@@ -7925,7 +7822,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `AuditTrail.RequestOptions`
@@ -7936,7 +7833,9 @@ await client.crm.engagements.metaPatchRetrieve("id");
-
client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse +## Ticketing AvailableActions + +
client.ticketing.availableActions.retrieve() -> Merge.AvailableActions
@@ -7948,7 +7847,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-Returns metadata for `Engagement` POSTs. +Returns a list of models and actions available for an account.
@@ -7964,7 +7863,7 @@ Returns metadata for `Engagement` POSTs.
```typescript -await client.crm.engagements.metaPostRetrieve(); +await client.ticketing.availableActions.retrieve(); ```
@@ -7980,7 +7879,7 @@ await client.crm.engagements.metaPostRetrieve();
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `AvailableActions.RequestOptions`
@@ -7991,7 +7890,9 @@ await client.crm.engagements.metaPostRetrieve();
-
client.crm.engagements.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Ticketing Collections + +
client.ticketing.collections.list({ ...params }) -> Merge.PaginatedCollectionList
@@ -8003,7 +7904,7 @@ await client.crm.engagements.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Collection` objects.
@@ -8019,7 +7920,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.engagements.remoteFieldClassesList(); +await client.ticketing.collections.list(); ```
@@ -8035,7 +7936,7 @@ await client.crm.engagements.remoteFieldClassesList();
-**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest` +**request:** `Merge.ticketing.CollectionsListRequest`
@@ -8043,7 +7944,7 @@ await client.crm.engagements.remoteFieldClassesList();
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Collections.RequestOptions`
@@ -8054,9 +7955,7 @@ await client.crm.engagements.remoteFieldClassesList();
-## Crm FieldMapping - -
client.crm.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse +
client.ticketing.collections.viewersList(collectionId, { ...params }) -> Merge.PaginatedViewerList
@@ -8068,7 +7967,7 @@ await client.crm.engagements.remoteFieldClassesList();
-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 `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
@@ -8084,7 +7983,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```typescript -await client.crm.fieldMapping.fieldMappingsRetrieve(); +await client.ticketing.collections.viewersList("collection_id"); ```
@@ -8100,7 +7999,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-**request:** `Merge.crm.FieldMappingsRetrieveRequest` +**collectionId:** `string`
@@ -8108,7 +8007,15 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.ticketing.CollectionsViewersListRequest` + +
+
+ +
+
+ +**requestOptions:** `Collections.RequestOptions`
@@ -8119,7 +8026,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-
client.crm.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse +
client.ticketing.collections.retrieve(id, { ...params }) -> Merge.Collection
@@ -8131,7 +8038,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-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. +Returns a `Collection` object with the given `id`.
@@ -8147,14 +8054,7 @@ Create new Field Mappings that will be available after the next scheduled sync.
```typescript -await client.crm.fieldMapping.fieldMappingsCreate({ - targetFieldName: "example_target_field_name", - targetFieldDescription: "this is a example description of the target field", - remoteFieldTraversalPath: ["example_remote_field"], - remoteMethod: "GET", - remoteUrlPath: "/example-url-path", - commonModelName: "ExampleCommonModel", -}); +await client.ticketing.collections.retrieve("id"); ```
@@ -8170,7 +8070,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-**request:** `Merge.crm.CreateFieldMappingRequest` +**id:** `string`
@@ -8178,7 +8078,15 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.ticketing.CollectionsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Collections.RequestOptions`
@@ -8189,7 +8097,9 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-
client.crm.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse +## Ticketing Comments + +
client.ticketing.comments.list({ ...params }) -> Merge.PaginatedCommentList
@@ -8201,7 +8111,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-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 `Comment` objects.
@@ -8217,7 +8127,7 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
```typescript -await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id"); +await client.ticketing.comments.list(); ```
@@ -8233,7 +8143,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**fieldMappingId:** `string` +**request:** `Merge.ticketing.CommentsListRequest`
@@ -8241,7 +8151,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Comments.RequestOptions`
@@ -8252,7 +8162,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
client.crm.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse +
client.ticketing.comments.create({ ...params }) -> Merge.CommentResponse
@@ -8264,7 +8174,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_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. +Creates a `Comment` object with the given values.
@@ -8280,7 +8190,9 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```typescript -await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); +await client.ticketing.comments.create({ + model: {}, +}); ```
@@ -8296,7 +8208,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**fieldMappingId:** `string` +**request:** `Merge.ticketing.CommentEndpointRequest`
@@ -8304,15 +8216,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**request:** `Merge.crm.PatchedEditFieldMappingRequest` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Comments.RequestOptions`
@@ -8323,7 +8227,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
client.crm.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse +
client.ticketing.comments.retrieve(id, { ...params }) -> Merge.Comment
@@ -8335,7 +8239,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_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/). +Returns a `Comment` object with the given `id`.
@@ -8351,7 +8255,7 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```typescript -await client.crm.fieldMapping.remoteFieldsRetrieve(); +await client.ticketing.comments.retrieve("id"); ```
@@ -8367,7 +8271,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-**request:** `Merge.crm.RemoteFieldsRetrieveRequest` +**id:** `string`
@@ -8375,7 +8279,15 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.ticketing.CommentsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Comments.RequestOptions`
@@ -8386,7 +8298,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-
client.crm.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse +
client.ticketing.comments.metaPostRetrieve() -> Merge.MetaResponse
@@ -8398,7 +8310,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-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 metadata for `Comment` POSTs.
@@ -8414,7 +8326,7 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```typescript -await client.crm.fieldMapping.targetFieldsRetrieve(); +await client.ticketing.comments.metaPostRetrieve(); ```
@@ -8430,7 +8342,7 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Comments.RequestOptions`
@@ -8441,9 +8353,9 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-## Crm GenerateKey +## Ticketing Contacts -
client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey +
client.ticketing.contacts.list({ ...params }) -> Merge.PaginatedContactList
@@ -8455,7 +8367,7 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-Create a remote key. +Returns a list of `Contact` objects.
@@ -8471,9 +8383,7 @@ Create a remote key.
```typescript -await client.crm.generateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.ticketing.contacts.list(); ```
@@ -8489,7 +8399,7 @@ await client.crm.generateKey.create({
-**request:** `Merge.crm.GenerateRemoteKeyRequest` +**request:** `Merge.ticketing.ContactsListRequest`
@@ -8497,7 +8407,7 @@ await client.crm.generateKey.create({
-**requestOptions:** `GenerateKey.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -8508,9 +8418,7 @@ await client.crm.generateKey.create({
-## Crm Issues - -
client.crm.issues.list({ ...params }) -> Merge.PaginatedIssueList +
client.ticketing.contacts.create({ ...params }) -> Merge.TicketingContactResponse
@@ -8522,7 +8430,7 @@ await client.crm.generateKey.create({
-Gets all issues for Organization. +Creates a `Contact` object with the given values.
@@ -8538,7 +8446,9 @@ Gets all issues for Organization.
```typescript -await client.crm.issues.list(); +await client.ticketing.contacts.create({ + model: {}, +}); ```
@@ -8554,7 +8464,7 @@ await client.crm.issues.list();
-**request:** `Merge.crm.IssuesListRequest` +**request:** `Merge.ticketing.TicketingContactEndpointRequest`
@@ -8562,7 +8472,7 @@ await client.crm.issues.list();
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -8573,7 +8483,7 @@ await client.crm.issues.list();
-
client.crm.issues.retrieve(id) -> Merge.Issue +
client.ticketing.contacts.retrieve(id, { ...params }) -> Merge.Contact
@@ -8585,7 +8495,7 @@ await client.crm.issues.list();
-Get a specific issue. +Returns a `Contact` object with the given `id`.
@@ -8601,7 +8511,7 @@ Get a specific issue.
```typescript -await client.crm.issues.retrieve("id"); +await client.ticketing.contacts.retrieve("id"); ```
@@ -8625,7 +8535,15 @@ await client.crm.issues.retrieve("id");
-**requestOptions:** `Issues.RequestOptions` +**request:** `Merge.ticketing.ContactsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Contacts.RequestOptions`
@@ -8636,9 +8554,7 @@ await client.crm.issues.retrieve("id");
-## Crm Leads - -
client.crm.leads.list({ ...params }) -> Merge.PaginatedLeadList +
client.ticketing.contacts.metaPostRetrieve() -> Merge.MetaResponse
@@ -8650,7 +8566,7 @@ await client.crm.issues.retrieve("id");
-Returns a list of `Lead` objects. +Returns metadata for `TicketingContact` POSTs.
@@ -8666,7 +8582,7 @@ Returns a list of `Lead` objects.
```typescript -await client.crm.leads.list(); +await client.ticketing.contacts.metaPostRetrieve(); ```
@@ -8682,15 +8598,7 @@ await client.crm.leads.list();
-**request:** `Merge.crm.LeadsListRequest` - -
-
- -
-
- -**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -8701,7 +8609,9 @@ await client.crm.leads.list();
-
client.crm.leads.create({ ...params }) -> Merge.LeadResponse +## Ticketing Scopes + +
client.ticketing.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -8713,7 +8623,7 @@ await client.crm.leads.list();
-Creates a `Lead` object with the given values. +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).
@@ -8729,9 +8639,7 @@ Creates a `Lead` object with the given values.
```typescript -await client.crm.leads.create({ - model: {}, -}); +await client.ticketing.scopes.defaultScopesRetrieve(); ```
@@ -8747,15 +8655,7 @@ await client.crm.leads.create({
-**request:** `Merge.crm.LeadEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -8766,7 +8666,7 @@ await client.crm.leads.create({
-
client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead +
client.ticketing.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -8778,7 +8678,7 @@ await client.crm.leads.create({
-Returns a `Lead` object with the given `id`. +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).
@@ -8794,7 +8694,7 @@ Returns a `Lead` object with the given `id`.
```typescript -await client.crm.leads.retrieve("id"); +await client.ticketing.scopes.linkedAccountScopesRetrieve(); ```
@@ -8810,23 +8710,7 @@ await client.crm.leads.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.LeadsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -8837,7 +8721,7 @@ await client.crm.leads.retrieve("id");
-
client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse +
client.ticketing.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
@@ -8849,7 +8733,7 @@ await client.crm.leads.retrieve("id");
-Returns metadata for `Lead` POSTs. +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)
@@ -8865,7 +8749,33 @@ Returns metadata for `Lead` POSTs.
```typescript -await client.crm.leads.metaPostRetrieve(); +await client.ticketing.scopes.linkedAccountScopesCreate({ + commonModels: [ + { + modelName: "Employee", + modelPermissions: { + READ: { + isEnabled: true, + }, + WRITE: { + isEnabled: false, + }, + }, + fieldPermissions: { + enabledFields: ["avatar", "home_location"], + disabledFields: ["work_location"], + }, + }, + { + modelName: "Benefit", + modelPermissions: { + WRITE: { + isEnabled: false, + }, + }, + }, + ], +}); ```
@@ -8881,7 +8791,15 @@ await client.crm.leads.metaPostRetrieve();
-**requestOptions:** `Leads.RequestOptions` +**request:** `Merge.ticketing.LinkedAccountCommonModelScopeDeserializerRequest` + +
+
+ +
+
+ +**requestOptions:** `Scopes.RequestOptions`
@@ -8892,7 +8810,9 @@ await client.crm.leads.metaPostRetrieve();
-
client.crm.leads.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Ticketing DeleteAccount + +
client.ticketing.deleteAccount.delete() -> void
@@ -8904,7 +8824,7 @@ await client.crm.leads.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Delete a linked account.
@@ -8920,7 +8840,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.leads.remoteFieldClassesList(); +await client.ticketing.deleteAccount.delete(); ```
@@ -8936,15 +8856,7 @@ await client.crm.leads.remoteFieldClassesList();
-**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest` - -
-
- -
-
- -**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `DeleteAccount.RequestOptions`
@@ -8955,9 +8867,9 @@ await client.crm.leads.remoteFieldClassesList();
-## Crm LinkToken +## Ticketing FieldMapping -
client.crm.linkToken.create({ ...params }) -> Merge.LinkToken +
client.ticketing.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
@@ -8969,7 +8881,7 @@ await client.crm.leads.remoteFieldClassesList();
-Creates a link token to be used when linking a new end user. +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/).
@@ -8985,12 +8897,7 @@ Creates a link token to be used when linking a new end user.
```typescript -await client.crm.linkToken.create({ - endUserEmailAddress: "example@gmail.com", - endUserOrganizationName: "Test Organization", - endUserOriginId: "12345", - categories: ["hris", "ats"], -}); +await client.ticketing.fieldMapping.fieldMappingsRetrieve(); ```
@@ -9006,7 +8913,7 @@ await client.crm.linkToken.create({
-**request:** `Merge.crm.EndUserDetailsRequest` +**request:** `Merge.ticketing.FieldMappingsRetrieveRequest`
@@ -9014,7 +8921,7 @@ await client.crm.linkToken.create({
-**requestOptions:** `LinkToken.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -9025,9 +8932,7 @@ await client.crm.linkToken.create({
-## Crm LinkedAccounts - -
client.crm.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList +
client.ticketing.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
@@ -9039,7 +8944,7 @@ await client.crm.linkToken.create({
-List linked accounts for your organization. +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.
@@ -9055,7 +8960,14 @@ List linked accounts for your organization.
```typescript -await client.crm.linkedAccounts.list(); +await client.ticketing.fieldMapping.fieldMappingsCreate({ + targetFieldName: "example_target_field_name", + targetFieldDescription: "this is a example description of the target field", + remoteFieldTraversalPath: ["example_remote_field"], + remoteMethod: "GET", + remoteUrlPath: "/example-url-path", + commonModelName: "ExampleCommonModel", +}); ```
@@ -9071,7 +8983,7 @@ await client.crm.linkedAccounts.list();
-**request:** `Merge.crm.LinkedAccountsListRequest` +**request:** `Merge.ticketing.CreateFieldMappingRequest`
@@ -9079,7 +8991,7 @@ await client.crm.linkedAccounts.list();
-**requestOptions:** `LinkedAccounts.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -9090,9 +9002,7 @@ await client.crm.linkedAccounts.list();
-## Crm Notes - -
client.crm.notes.list({ ...params }) -> Merge.PaginatedNoteList +
client.ticketing.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
@@ -9104,7 +9014,7 @@ await client.crm.linkedAccounts.list();
-Returns a list of `Note` objects. +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.
@@ -9120,7 +9030,7 @@ Returns a list of `Note` objects.
```typescript -await client.crm.notes.list(); +await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
@@ -9136,7 +9046,7 @@ await client.crm.notes.list();
-**request:** `Merge.crm.NotesListRequest` +**fieldMappingId:** `string`
@@ -9144,7 +9054,7 @@ await client.crm.notes.list();
-**requestOptions:** `Notes.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -9155,7 +9065,7 @@ await client.crm.notes.list();
-
client.crm.notes.create({ ...params }) -> Merge.NoteResponse +
client.ticketing.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
@@ -9167,7 +9077,7 @@ await 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.
@@ -9183,9 +9093,7 @@ Creates a `Note` object with the given values.
```typescript -await client.crm.notes.create({ - model: {}, -}); +await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); ```
@@ -9201,7 +9109,7 @@ await client.crm.notes.create({
-**request:** `Merge.crm.NoteEndpointRequest` +**fieldMappingId:** `string`
@@ -9209,10 +9117,18 @@ await client.crm.notes.create({
-**requestOptions:** `Notes.RequestOptions` +**request:** `Merge.ticketing.PatchedEditFieldMappingRequest` -
-
+ +
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions` + +
+
@@ -9220,7 +9136,7 @@ await client.crm.notes.create({
-
client.crm.notes.retrieve(id, { ...params }) -> Merge.Note +
client.ticketing.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
@@ -9232,7 +9148,7 @@ await 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/).
@@ -9248,7 +9164,7 @@ Returns a `Note` object with the given `id`.
```typescript -await client.crm.notes.retrieve("id"); +await client.ticketing.fieldMapping.remoteFieldsRetrieve(); ```
@@ -9264,15 +9180,7 @@ await client.crm.notes.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.NotesRetrieveRequest` +**request:** `Merge.ticketing.RemoteFieldsRetrieveRequest`
@@ -9280,7 +9188,7 @@ await client.crm.notes.retrieve("id");
-**requestOptions:** `Notes.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -9291,7 +9199,7 @@ await client.crm.notes.retrieve("id");
-
client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse +
client.ticketing.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
@@ -9303,7 +9211,7 @@ await client.crm.notes.retrieve("id");
-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/).
@@ -9319,7 +9227,7 @@ Returns metadata for `Note` POSTs.
```typescript -await client.crm.notes.metaPostRetrieve(); +await client.ticketing.fieldMapping.targetFieldsRetrieve(); ```
@@ -9335,7 +9243,7 @@ await client.crm.notes.metaPostRetrieve();
-**requestOptions:** `Notes.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -9346,7 +9254,9 @@ await client.crm.notes.metaPostRetrieve();
-
client.crm.notes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Ticketing GenerateKey + +
client.ticketing.generateKey.create({ ...params }) -> Merge.RemoteKey
@@ -9358,7 +9268,7 @@ await client.crm.notes.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Create a remote key.
@@ -9374,7 +9284,9 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.notes.remoteFieldClassesList(); +await client.ticketing.generateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -9390,7 +9302,7 @@ await client.crm.notes.remoteFieldClassesList();
-**request:** `Merge.crm.NotesRemoteFieldClassesListRequest` +**request:** `Merge.ticketing.GenerateRemoteKeyRequest`
@@ -9398,7 +9310,7 @@ await client.crm.notes.remoteFieldClassesList();
-**requestOptions:** `Notes.RequestOptions` +**requestOptions:** `GenerateKey.RequestOptions`
@@ -9409,9 +9321,9 @@ await client.crm.notes.remoteFieldClassesList();
-## Crm Opportunities +## Ticketing Issues -
client.crm.opportunities.list({ ...params }) -> Merge.PaginatedOpportunityList +
client.ticketing.issues.list({ ...params }) -> Merge.PaginatedIssueList
@@ -9423,7 +9335,7 @@ await client.crm.notes.remoteFieldClassesList();
-Returns a list of `Opportunity` objects. +Gets all issues for Organization.
@@ -9439,7 +9351,7 @@ Returns a list of `Opportunity` objects.
```typescript -await client.crm.opportunities.list(); +await client.ticketing.issues.list(); ```
@@ -9455,7 +9367,7 @@ await client.crm.opportunities.list();
-**request:** `Merge.crm.OpportunitiesListRequest` +**request:** `Merge.ticketing.IssuesListRequest`
@@ -9463,7 +9375,7 @@ await client.crm.opportunities.list();
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -9474,7 +9386,7 @@ await client.crm.opportunities.list();
-
client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse +
client.ticketing.issues.retrieve(id) -> Merge.Issue
@@ -9486,7 +9398,7 @@ await client.crm.opportunities.list();
-Creates an `Opportunity` object with the given values. +Get a specific issue.
@@ -9502,9 +9414,7 @@ Creates an `Opportunity` object with the given values.
```typescript -await client.crm.opportunities.create({ - model: {}, -}); +await client.ticketing.issues.retrieve("id"); ```
@@ -9520,7 +9430,7 @@ await client.crm.opportunities.create({
-**request:** `Merge.crm.OpportunityEndpointRequest` +**id:** `string`
@@ -9528,7 +9438,7 @@ await client.crm.opportunities.create({
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -9539,7 +9449,9 @@ await client.crm.opportunities.create({
-
client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity +## Ticketing LinkToken + +
client.ticketing.linkToken.create({ ...params }) -> Merge.LinkToken
@@ -9551,7 +9463,7 @@ await client.crm.opportunities.create({
-Returns an `Opportunity` object with the given `id`. +Creates a link token to be used when linking a new end user.
@@ -9567,7 +9479,12 @@ Returns an `Opportunity` object with the given `id`.
```typescript -await client.crm.opportunities.retrieve("id"); +await client.ticketing.linkToken.create({ + endUserEmailAddress: "example@gmail.com", + endUserOrganizationName: "Test Organization", + endUserOriginId: "12345", + categories: ["hris", "ats"], +}); ```
@@ -9583,15 +9500,7 @@ await client.crm.opportunities.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.OpportunitiesRetrieveRequest` +**request:** `Merge.ticketing.EndUserDetailsRequest`
@@ -9599,7 +9508,7 @@ await client.crm.opportunities.retrieve("id");
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `LinkToken.RequestOptions`
@@ -9610,7 +9519,9 @@ await client.crm.opportunities.retrieve("id");
-
client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse +## Ticketing LinkedAccounts + +
client.ticketing.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
@@ -9622,7 +9533,7 @@ await client.crm.opportunities.retrieve("id");
-Updates an `Opportunity` object with the given `id`. +List linked accounts for your organization.
@@ -9638,9 +9549,7 @@ Updates an `Opportunity` object with the given `id`.
```typescript -await client.crm.opportunities.partialUpdate("id", { - model: {}, -}); +await client.ticketing.linkedAccounts.list(); ```
@@ -9656,15 +9565,7 @@ await client.crm.opportunities.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedOpportunityEndpointRequest` +**request:** `Merge.ticketing.LinkedAccountsListRequest`
@@ -9672,7 +9573,7 @@ await client.crm.opportunities.partialUpdate("id", {
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -9683,7 +9584,9 @@ await client.crm.opportunities.partialUpdate("id", {
-
client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse +## Ticketing Passthrough + +
client.ticketing.passthrough.create({ ...params }) -> Merge.RemoteResponse
@@ -9695,7 +9598,7 @@ await client.crm.opportunities.partialUpdate("id", {
-Returns metadata for `Opportunity` PATCHs. +Pull data from an endpoint not currently supported by Merge.
@@ -9711,7 +9614,10 @@ Returns metadata for `Opportunity` PATCHs.
```typescript -await client.crm.opportunities.metaPatchRetrieve("id"); +await client.ticketing.passthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -9727,7 +9633,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.DataPassthroughRequest`
@@ -9735,7 +9641,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `Passthrough.RequestOptions`
@@ -9746,7 +9652,9 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-
client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse +## Ticketing Projects + +
client.ticketing.projects.list({ ...params }) -> Merge.PaginatedProjectList
@@ -9758,7 +9666,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-Returns metadata for `Opportunity` POSTs. +Returns a list of `Project` objects.
@@ -9774,7 +9682,7 @@ Returns metadata for `Opportunity` POSTs.
```typescript -await client.crm.opportunities.metaPostRetrieve(); +await client.ticketing.projects.list(); ```
@@ -9790,7 +9698,15 @@ await client.crm.opportunities.metaPostRetrieve();
-**requestOptions:** `Opportunities.RequestOptions` +**request:** `Merge.ticketing.ProjectsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Projects.RequestOptions`
@@ -9801,7 +9717,7 @@ await client.crm.opportunities.metaPostRetrieve();
-
client.crm.opportunities.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.ticketing.projects.retrieve(id, { ...params }) -> Merge.Project
@@ -9813,7 +9729,7 @@ await client.crm.opportunities.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Returns a `Project` object with the given `id`.
@@ -9829,7 +9745,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.opportunities.remoteFieldClassesList(); +await client.ticketing.projects.retrieve("id"); ```
@@ -9845,7 +9761,7 @@ await client.crm.opportunities.remoteFieldClassesList();
-**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest` +**id:** `string`
@@ -9853,7 +9769,15 @@ await client.crm.opportunities.remoteFieldClassesList();
-**requestOptions:** `Opportunities.RequestOptions` +**request:** `Merge.ticketing.ProjectsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Projects.RequestOptions`
@@ -9864,9 +9788,7 @@ await client.crm.opportunities.remoteFieldClassesList();
-## Crm Passthrough - -
client.crm.passthrough.create({ ...params }) -> Merge.RemoteResponse +
client.ticketing.projects.usersList(parentId, { ...params }) -> Merge.PaginatedUserList
@@ -9878,7 +9800,7 @@ await client.crm.opportunities.remoteFieldClassesList();
-Pull data from an endpoint not currently supported by Merge. +Returns a list of `User` objects.
@@ -9894,10 +9816,7 @@ Pull data from an endpoint not currently supported by Merge.
```typescript -await client.crm.passthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.ticketing.projects.usersList("parent_id"); ```
@@ -9913,7 +9832,7 @@ await client.crm.passthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**parentId:** `string`
@@ -9921,7 +9840,15 @@ await client.crm.passthrough.create({
-**requestOptions:** `Passthrough.RequestOptions` +**request:** `Merge.ticketing.ProjectsUsersListRequest` + +
+
+ +
+
+ +**requestOptions:** `Projects.RequestOptions`
@@ -9932,9 +9859,9 @@ await client.crm.passthrough.create({
-## Crm RegenerateKey +## Ticketing RegenerateKey -
client.crm.regenerateKey.create({ ...params }) -> Merge.RemoteKey +
client.ticketing.regenerateKey.create({ ...params }) -> Merge.RemoteKey
@@ -9962,7 +9889,7 @@ Exchange remote keys.
```typescript -await client.crm.regenerateKey.create({ +await client.ticketing.regenerateKey.create({ name: "Remote Deployment Key 1", }); ``` @@ -9980,7 +9907,7 @@ await client.crm.regenerateKey.create({
-**request:** `Merge.crm.RemoteKeyForRegenerationRequest` +**request:** `Merge.ticketing.RemoteKeyForRegenerationRequest`
@@ -9999,9 +9926,9 @@ await client.crm.regenerateKey.create({
-## Crm Stages +## Ticketing Roles -
client.crm.stages.list({ ...params }) -> Merge.PaginatedStageList +
client.ticketing.roles.list({ ...params }) -> Merge.PaginatedRoleList
@@ -10013,7 +9940,7 @@ await client.crm.regenerateKey.create({
-Returns a list of `Stage` objects. +Returns a list of `Role` objects.
@@ -10029,7 +9956,7 @@ Returns a list of `Stage` objects.
```typescript -await client.crm.stages.list(); +await client.ticketing.roles.list(); ```
@@ -10045,7 +9972,7 @@ await client.crm.stages.list();
-**request:** `Merge.crm.StagesListRequest` +**request:** `Merge.ticketing.RolesListRequest`
@@ -10053,7 +9980,7 @@ await client.crm.stages.list();
-**requestOptions:** `Stages.RequestOptions` +**requestOptions:** `Roles.RequestOptions`
@@ -10064,7 +9991,7 @@ await client.crm.stages.list();
-
client.crm.stages.retrieve(id, { ...params }) -> Merge.Stage +
client.ticketing.roles.retrieve(id, { ...params }) -> Merge.Role
@@ -10076,7 +10003,7 @@ await client.crm.stages.list();
-Returns a `Stage` object with the given `id`. +Returns a `Role` object with the given `id`.
@@ -10092,7 +10019,7 @@ Returns a `Stage` object with the given `id`.
```typescript -await client.crm.stages.retrieve("id"); +await client.ticketing.roles.retrieve("id"); ```
@@ -10116,7 +10043,7 @@ await client.crm.stages.retrieve("id");
-**request:** `Merge.crm.StagesRetrieveRequest` +**request:** `Merge.ticketing.RolesRetrieveRequest`
@@ -10124,7 +10051,7 @@ await client.crm.stages.retrieve("id");
-**requestOptions:** `Stages.RequestOptions` +**requestOptions:** `Roles.RequestOptions`
@@ -10135,7 +10062,9 @@ await client.crm.stages.retrieve("id");
-
client.crm.stages.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Ticketing SyncStatus + +
client.ticketing.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
@@ -10147,7 +10076,7 @@ await client.crm.stages.retrieve("id");
-Returns a list of `RemoteFieldClass` objects. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -10163,7 +10092,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.stages.remoteFieldClassesList(); +await client.ticketing.syncStatus.list(); ```
@@ -10179,7 +10108,7 @@ await client.crm.stages.remoteFieldClassesList();
-**request:** `Merge.crm.StagesRemoteFieldClassesListRequest` +**request:** `Merge.ticketing.SyncStatusListRequest`
@@ -10187,7 +10116,7 @@ await client.crm.stages.remoteFieldClassesList();
-**requestOptions:** `Stages.RequestOptions` +**requestOptions:** `SyncStatus.RequestOptions`
@@ -10198,9 +10127,9 @@ await client.crm.stages.remoteFieldClassesList();
-## Crm SyncStatus +## Ticketing ForceResync -
client.crm.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList +
client.ticketing.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
@@ -10212,7 +10141,7 @@ await client.crm.stages.remoteFieldClassesList();
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -10228,7 +10157,7 @@ Get sync status for the current sync and the most recently finished sync. `last_
```typescript -await client.crm.syncStatus.list(); +await client.ticketing.forceResync.syncStatusResyncCreate(); ```
@@ -10244,15 +10173,7 @@ await client.crm.syncStatus.list();
-**request:** `Merge.crm.SyncStatusListRequest` - -
-
- -
-
- -**requestOptions:** `SyncStatus.RequestOptions` +**requestOptions:** `ForceResync.RequestOptions`
@@ -10263,9 +10184,9 @@ await client.crm.syncStatus.list();
-## Crm ForceResync +## Ticketing Tags -
client.crm.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[] +
client.ticketing.tags.list({ ...params }) -> Merge.PaginatedTagList
@@ -10277,7 +10198,7 @@ await client.crm.syncStatus.list();
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Returns a list of `Tag` objects.
@@ -10293,7 +10214,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```typescript -await client.crm.forceResync.syncStatusResyncCreate(); +await client.ticketing.tags.list(); ```
@@ -10309,7 +10230,15 @@ await client.crm.forceResync.syncStatusResyncCreate();
-**requestOptions:** `ForceResync.RequestOptions` +**request:** `Merge.ticketing.TagsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Tags.RequestOptions`
@@ -10320,9 +10249,7 @@ await client.crm.forceResync.syncStatusResyncCreate();
-## Crm Tasks - -
client.crm.tasks.list({ ...params }) -> Merge.PaginatedTaskList +
client.ticketing.tags.retrieve(id, { ...params }) -> Merge.Tag
@@ -10334,7 +10261,7 @@ await client.crm.forceResync.syncStatusResyncCreate();
-Returns a list of `Task` objects. +Returns a `Tag` object with the given `id`.
@@ -10350,7 +10277,7 @@ Returns a list of `Task` objects.
```typescript -await client.crm.tasks.list(); +await client.ticketing.tags.retrieve("id"); ```
@@ -10366,7 +10293,7 @@ await client.crm.tasks.list();
-**request:** `Merge.crm.TasksListRequest` +**id:** `string`
@@ -10374,7 +10301,15 @@ await client.crm.tasks.list();
-**requestOptions:** `Tasks.RequestOptions` +**request:** `Merge.ticketing.TagsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Tags.RequestOptions`
@@ -10385,7 +10320,9 @@ await client.crm.tasks.list();
-
client.crm.tasks.create({ ...params }) -> Merge.TaskResponse +## Ticketing Teams + +
client.ticketing.teams.list({ ...params }) -> Merge.PaginatedTeamList
@@ -10397,7 +10334,7 @@ await client.crm.tasks.list();
-Creates a `Task` object with the given values. +Returns a list of `Team` objects.
@@ -10413,9 +10350,7 @@ Creates a `Task` object with the given values.
```typescript -await client.crm.tasks.create({ - model: {}, -}); +await client.ticketing.teams.list(); ```
@@ -10431,7 +10366,7 @@ await client.crm.tasks.create({
-**request:** `Merge.crm.TaskEndpointRequest` +**request:** `Merge.ticketing.TeamsListRequest`
@@ -10439,7 +10374,7 @@ await client.crm.tasks.create({
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `Teams.RequestOptions`
@@ -10450,7 +10385,7 @@ await client.crm.tasks.create({
-
client.crm.tasks.retrieve(id, { ...params }) -> Merge.Task +
client.ticketing.teams.retrieve(id, { ...params }) -> Merge.Team
@@ -10462,7 +10397,7 @@ await client.crm.tasks.create({
-Returns a `Task` object with the given `id`. +Returns a `Team` object with the given `id`.
@@ -10478,7 +10413,7 @@ Returns a `Task` object with the given `id`.
```typescript -await client.crm.tasks.retrieve("id"); +await client.ticketing.teams.retrieve("id"); ```
@@ -10502,7 +10437,7 @@ await client.crm.tasks.retrieve("id");
-**request:** `Merge.crm.TasksRetrieveRequest` +**request:** `Merge.ticketing.TeamsRetrieveRequest`
@@ -10510,7 +10445,7 @@ await client.crm.tasks.retrieve("id");
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `Teams.RequestOptions`
@@ -10521,7 +10456,9 @@ await client.crm.tasks.retrieve("id");
-
client.crm.tasks.partialUpdate(id, { ...params }) -> Merge.TaskResponse +## Ticketing Tickets + +
client.ticketing.tickets.list({ ...params }) -> Merge.PaginatedTicketList
@@ -10533,7 +10470,7 @@ await client.crm.tasks.retrieve("id");
-Updates a `Task` object with the given `id`. +Returns a list of `Ticket` objects.
@@ -10549,9 +10486,7 @@ Updates a `Task` object with the given `id`.
```typescript -await client.crm.tasks.partialUpdate("id", { - model: {}, -}); +await client.ticketing.tickets.list(); ```
@@ -10567,15 +10502,7 @@ await client.crm.tasks.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedTaskEndpointRequest` +**request:** `Merge.ticketing.TicketsListRequest`
@@ -10583,7 +10510,7 @@ await client.crm.tasks.partialUpdate("id", {
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `Tickets.RequestOptions`
@@ -10594,7 +10521,7 @@ await client.crm.tasks.partialUpdate("id", {
-
client.crm.tasks.metaPatchRetrieve(id) -> Merge.MetaResponse +
client.ticketing.tickets.create({ ...params }) -> Merge.TicketResponse
@@ -10606,7 +10533,7 @@ await client.crm.tasks.partialUpdate("id", {
-Returns metadata for `Task` PATCHs. +Creates a `Ticket` object with the given values.
@@ -10622,7 +10549,9 @@ Returns metadata for `Task` PATCHs.
```typescript -await client.crm.tasks.metaPatchRetrieve("id"); +await client.ticketing.tickets.create({ + model: {}, +}); ```
@@ -10638,7 +10567,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.ticketing.TicketEndpointRequest`
@@ -10646,7 +10575,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `Tickets.RequestOptions`
@@ -10657,7 +10586,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-
client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse +
client.ticketing.tickets.retrieve(id, { ...params }) -> Merge.Ticket
@@ -10669,7 +10598,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-Returns metadata for `Task` POSTs. +Returns a `Ticket` object with the given `id`.
@@ -10685,7 +10614,7 @@ Returns metadata for `Task` POSTs.
```typescript -await client.crm.tasks.metaPostRetrieve(); +await client.ticketing.tickets.retrieve("id"); ```
@@ -10701,7 +10630,23 @@ await client.crm.tasks.metaPostRetrieve();
-**requestOptions:** `Tasks.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.ticketing.TicketsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Tickets.RequestOptions`
@@ -10712,7 +10657,7 @@ await client.crm.tasks.metaPostRetrieve();
-
client.crm.tasks.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.ticketing.tickets.partialUpdate(id, { ...params }) -> Merge.TicketResponse
@@ -10724,7 +10669,7 @@ await client.crm.tasks.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Updates a `Ticket` object with the given `id`.
@@ -10740,7 +10685,9 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.tasks.remoteFieldClassesList(); +await client.ticketing.tickets.partialUpdate("id", { + model: {}, +}); ```
@@ -10756,7 +10703,7 @@ await client.crm.tasks.remoteFieldClassesList();
-**request:** `Merge.crm.TasksRemoteFieldClassesListRequest` +**id:** `string`
@@ -10764,7 +10711,15 @@ await client.crm.tasks.remoteFieldClassesList();
-**requestOptions:** `Tasks.RequestOptions` +**request:** `Merge.ticketing.PatchedTicketEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Tickets.RequestOptions`
@@ -10775,9 +10730,7 @@ await client.crm.tasks.remoteFieldClassesList();
-## Crm Users - -
client.crm.users.list({ ...params }) -> Merge.PaginatedUserList +
client.ticketing.tickets.viewersList(ticketId, { ...params }) -> Merge.PaginatedViewerList
@@ -10789,7 +10742,7 @@ await client.crm.tasks.remoteFieldClassesList();
-Returns a list of `User` objects. +Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
@@ -10805,7 +10758,7 @@ Returns a list of `User` objects.
```typescript -await client.crm.users.list(); +await client.ticketing.tickets.viewersList("ticket_id"); ```
@@ -10821,7 +10774,7 @@ await client.crm.users.list();
-**request:** `Merge.crm.UsersListRequest` +**ticketId:** `string`
@@ -10829,7 +10782,15 @@ await client.crm.users.list();
-**requestOptions:** `Users.RequestOptions` +**request:** `Merge.ticketing.TicketsViewersListRequest` + +
+
+ +
+
+ +**requestOptions:** `Tickets.RequestOptions`
@@ -10840,7 +10801,7 @@ await client.crm.users.list();
-
client.crm.users.retrieve(id, { ...params }) -> Merge.User +
client.ticketing.tickets.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -10852,7 +10813,7 @@ await client.crm.users.list();
-Returns a `User` object with the given `id`. +Returns metadata for `Ticket` PATCHs.
@@ -10868,7 +10829,7 @@ Returns a `User` object with the given `id`.
```typescript -await client.crm.users.retrieve("id"); +await client.ticketing.tickets.metaPatchRetrieve("id"); ```
@@ -10892,15 +10853,7 @@ await client.crm.users.retrieve("id");
-**request:** `Merge.crm.UsersRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Users.RequestOptions` +**requestOptions:** `Tickets.RequestOptions`
@@ -10911,7 +10864,7 @@ await client.crm.users.retrieve("id");
-
client.crm.users.ignoreCreate(modelId, { ...params }) -> void +
client.ticketing.tickets.metaPostRetrieve({ ...params }) -> Merge.MetaResponse
@@ -10923,7 +10876,7 @@ await client.crm.users.retrieve("id");
-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 metadata for `Ticket` POSTs.
@@ -10939,9 +10892,7 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```typescript -await client.crm.users.ignoreCreate("model_id", { - reason: "GENERAL_CUSTOMER_REQUEST", -}); +await client.ticketing.tickets.metaPostRetrieve(); ```
@@ -10957,15 +10908,7 @@ await client.crm.users.ignoreCreate("model_id", {
-**modelId:** `string` - -
-
- -
-
- -**request:** `Merge.IgnoreCommonModelRequest` +**request:** `Merge.ticketing.TicketsMetaPostRetrieveRequest`
@@ -10973,7 +10916,7 @@ await client.crm.users.ignoreCreate("model_id", {
-**requestOptions:** `Users.RequestOptions` +**requestOptions:** `Tickets.RequestOptions`
@@ -10984,7 +10927,7 @@ await client.crm.users.ignoreCreate("model_id", {
-
client.crm.users.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.ticketing.tickets.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -11012,7 +10955,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.users.remoteFieldClassesList(); +await client.ticketing.tickets.remoteFieldClassesList(); ```
@@ -11028,7 +10971,7 @@ await client.crm.users.remoteFieldClassesList();
-**request:** `Merge.crm.UsersRemoteFieldClassesListRequest` +**request:** `Merge.ticketing.TicketsRemoteFieldClassesListRequest`
@@ -11036,7 +10979,7 @@ await client.crm.users.remoteFieldClassesList();
-**requestOptions:** `Users.RequestOptions` +**requestOptions:** `Tickets.RequestOptions`
@@ -11047,9 +10990,9 @@ await client.crm.users.remoteFieldClassesList();
-## Crm WebhookReceivers +## Ticketing Users -
client.crm.webhookReceivers.list() -> Merge.WebhookReceiver[] +
client.ticketing.users.list({ ...params }) -> Merge.PaginatedUserList
@@ -11061,7 +11004,7 @@ await client.crm.users.remoteFieldClassesList();
-Returns a list of `WebhookReceiver` objects. +Returns a list of `User` objects.
@@ -11077,7 +11020,7 @@ Returns a list of `WebhookReceiver` objects.
```typescript -await client.crm.webhookReceivers.list(); +await client.ticketing.users.list(); ```
@@ -11093,7 +11036,15 @@ await client.crm.webhookReceivers.list();
-**requestOptions:** `WebhookReceivers.RequestOptions` +**request:** `Merge.ticketing.UsersListRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions`
@@ -11104,7 +11055,7 @@ await client.crm.webhookReceivers.list();
-
client.crm.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver +
client.ticketing.users.retrieve(id, { ...params }) -> Merge.User
@@ -11116,7 +11067,7 @@ await client.crm.webhookReceivers.list();
-Creates a `WebhookReceiver` object with the given values. +Returns a `User` object with the given `id`.
@@ -11132,10 +11083,7 @@ Creates a `WebhookReceiver` object with the given values.
```typescript -await client.crm.webhookReceivers.create({ - event: "event", - isActive: true, -}); +await client.ticketing.users.retrieve("id"); ```
@@ -11151,7 +11099,7 @@ await client.crm.webhookReceivers.create({
-**request:** `Merge.crm.WebhookReceiverRequest` +**id:** `string`
@@ -11159,7 +11107,15 @@ await client.crm.webhookReceivers.create({
-**requestOptions:** `WebhookReceivers.RequestOptions` +**request:** `Merge.ticketing.UsersRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions`
@@ -11170,9 +11126,9 @@ await client.crm.webhookReceivers.create({
-## Filestorage AccountDetails +## Ticketing WebhookReceivers -
client.filestorage.accountDetails.retrieve() -> Merge.AccountDetails +
client.ticketing.webhookReceivers.list() -> Merge.WebhookReceiver[]
@@ -11184,7 +11140,7 @@ await client.crm.webhookReceivers.create({
-Get details for a linked account. +Returns a list of `WebhookReceiver` objects.
@@ -11200,7 +11156,7 @@ Get details for a linked account.
```typescript -await client.filestorage.accountDetails.retrieve(); +await client.ticketing.webhookReceivers.list(); ```
@@ -11216,7 +11172,7 @@ await client.filestorage.accountDetails.retrieve();
-**requestOptions:** `AccountDetails.RequestOptions` +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -11227,9 +11183,7 @@ await client.filestorage.accountDetails.retrieve();
-## Filestorage AccountToken - -
client.filestorage.accountToken.retrieve(publicToken) -> Merge.AccountToken +
client.ticketing.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
@@ -11241,7 +11195,7 @@ await client.filestorage.accountDetails.retrieve();
-Returns the account token for the end user with the provided public token. +Creates a `WebhookReceiver` object with the given values.
@@ -11257,7 +11211,10 @@ Returns the account token for the end user with the provided public token.
```typescript -await client.filestorage.accountToken.retrieve("public_token"); +await client.ticketing.webhookReceivers.create({ + event: "event", + isActive: true, +}); ```
@@ -11273,7 +11230,7 @@ await client.filestorage.accountToken.retrieve("public_token");
-**publicToken:** `string` +**request:** `Merge.ticketing.WebhookReceiverRequest`
@@ -11281,7 +11238,7 @@ await client.filestorage.accountToken.retrieve("public_token");
-**requestOptions:** `AccountToken.RequestOptions` +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -11292,9 +11249,9 @@ await client.filestorage.accountToken.retrieve("public_token");
-## Filestorage AsyncPassthrough +## Crm AccountDetails -
client.filestorage.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept +
client.crm.accountDetails.retrieve() -> Merge.AccountDetails
@@ -11306,7 +11263,7 @@ await client.filestorage.accountToken.retrieve("public_token");
-Asynchronously pull data from an endpoint not currently supported by Merge. +Get details for a linked account.
@@ -11322,10 +11279,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```typescript -await client.filestorage.asyncPassthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.crm.accountDetails.retrieve(); ```
@@ -11341,15 +11295,7 @@ await client.filestorage.asyncPassthrough.create({
-**request:** `Merge.DataPassthroughRequest` - -
-
- -
-
- -**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `AccountDetails.RequestOptions`
@@ -11360,7 +11306,9 @@ await client.filestorage.asyncPassthrough.create({
-
client.filestorage.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse +## Crm AccountToken + +
client.crm.accountToken.retrieve(publicToken) -> Merge.AccountToken
@@ -11372,7 +11320,7 @@ await client.filestorage.asyncPassthrough.create({
-Retrieves data from earlier async-passthrough POST request +Returns the account token for the end user with the provided public token.
@@ -11388,7 +11336,7 @@ Retrieves data from earlier async-passthrough POST request
```typescript -await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id"); +await client.crm.accountToken.retrieve("public_token"); ```
@@ -11404,7 +11352,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-**asyncPassthroughReceiptId:** `string` +**publicToken:** `string`
@@ -11412,7 +11360,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `AccountToken.RequestOptions`
@@ -11423,9 +11371,9 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-## Filestorage AuditTrail +## Crm Accounts -
client.filestorage.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList +
client.crm.accounts.list({ ...params }) -> Merge.PaginatedAccountList
@@ -11437,7 +11385,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-Gets a list of audit trail events. +Returns a list of `Account` objects.
@@ -11453,7 +11401,7 @@ Gets a list of audit trail events.
```typescript -await client.filestorage.auditTrail.list(); +await client.crm.accounts.list(); ```
@@ -11469,7 +11417,7 @@ await client.filestorage.auditTrail.list();
-**request:** `Merge.filestorage.AuditTrailListRequest` +**request:** `Merge.crm.AccountsListRequest`
@@ -11477,7 +11425,7 @@ await client.filestorage.auditTrail.list();
-**requestOptions:** `AuditTrail.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -11488,9 +11436,7 @@ await client.filestorage.auditTrail.list();
-## Filestorage AvailableActions - -
client.filestorage.availableActions.retrieve() -> Merge.AvailableActions +
client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse
@@ -11502,7 +11448,7 @@ await client.filestorage.auditTrail.list();
-Returns a list of models and actions available for an account. +Creates an `Account` object with the given values.
@@ -11518,7 +11464,9 @@ Returns a list of models and actions available for an account.
```typescript -await client.filestorage.availableActions.retrieve(); +await client.crm.accounts.create({ + model: {}, +}); ```
@@ -11534,7 +11482,15 @@ await client.filestorage.availableActions.retrieve();
-**requestOptions:** `AvailableActions.RequestOptions` +**request:** `Merge.crm.CrmAccountEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -11545,9 +11501,7 @@ await client.filestorage.availableActions.retrieve();
-## Filestorage Scopes - -
client.filestorage.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi +
client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account
@@ -11559,7 +11513,7 @@ await client.filestorage.availableActions.retrieve();
-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 an `Account` object with the given `id`.
@@ -11575,7 +11529,7 @@ Get the default permissions for Merge Common Models and fields across all Linked
```typescript -await client.filestorage.scopes.defaultScopesRetrieve(); +await client.crm.accounts.retrieve("id"); ```
@@ -11591,7 +11545,23 @@ await client.filestorage.scopes.defaultScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.AccountsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -11602,7 +11572,7 @@ await client.filestorage.scopes.defaultScopesRetrieve();
-
client.filestorage.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi +
client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse
@@ -11614,7 +11584,7 @@ await client.filestorage.scopes.defaultScopesRetrieve();
-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). +Updates an `Account` object with the given `id`.
@@ -11630,7 +11600,9 @@ Get all available permissions for Merge Common Models and fields for a single Li
```typescript -await client.filestorage.scopes.linkedAccountScopesRetrieve(); +await client.crm.accounts.partialUpdate("id", { + model: {}, +}); ```
@@ -11646,7 +11618,23 @@ await client.filestorage.scopes.linkedAccountScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.PatchedCrmAccountEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -11657,7 +11645,7 @@ await client.filestorage.scopes.linkedAccountScopesRetrieve();
-
client.filestorage.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi +
client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -11669,7 +11657,7 @@ await client.filestorage.scopes.linkedAccountScopesRetrieve();
-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) +Returns metadata for `CRMAccount` PATCHs.
@@ -11685,33 +11673,7 @@ Update permissions for any Common Model or field for a single Linked Account. An
```typescript -await client.filestorage.scopes.linkedAccountScopesCreate({ - commonModels: [ - { - modelName: "Employee", - modelPermissions: { - READ: { - isEnabled: true, - }, - WRITE: { - isEnabled: false, - }, - }, - fieldPermissions: { - enabledFields: ["avatar", "home_location"], - disabledFields: ["work_location"], - }, - }, - { - modelName: "Benefit", - modelPermissions: { - WRITE: { - isEnabled: false, - }, - }, - }, - ], -}); +await client.crm.accounts.metaPatchRetrieve("id"); ```
@@ -11727,7 +11689,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-**request:** `Merge.filestorage.LinkedAccountCommonModelScopeDeserializerRequest` +**id:** `string`
@@ -11735,7 +11697,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -11746,9 +11708,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-## Filestorage DeleteAccount - -
client.filestorage.deleteAccount.delete() -> void +
client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse
@@ -11760,7 +11720,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-Delete a linked account. +Returns metadata for `CRMAccount` POSTs.
@@ -11776,7 +11736,7 @@ Delete a linked account.
```typescript -await client.filestorage.deleteAccount.delete(); +await client.crm.accounts.metaPostRetrieve(); ```
@@ -11792,7 +11752,7 @@ await client.filestorage.deleteAccount.delete();
-**requestOptions:** `DeleteAccount.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -11803,9 +11763,7 @@ await client.filestorage.deleteAccount.delete();
-## Filestorage Drives - -
client.filestorage.drives.list({ ...params }) -> Merge.PaginatedDriveList +
client.crm.accounts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -11817,7 +11775,7 @@ await client.filestorage.deleteAccount.delete();
-Returns a list of `Drive` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -11833,7 +11791,7 @@ Returns a list of `Drive` objects.
```typescript -await client.filestorage.drives.list(); +await client.crm.accounts.remoteFieldClassesList(); ```
@@ -11849,7 +11807,7 @@ await client.filestorage.drives.list();
-**request:** `Merge.filestorage.DrivesListRequest` +**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest`
@@ -11857,7 +11815,7 @@ await client.filestorage.drives.list();
-**requestOptions:** `Drives.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -11868,7 +11826,9 @@ await client.filestorage.drives.list();
-
client.filestorage.drives.retrieve(id, { ...params }) -> Merge.Drive +## Crm AsyncPassthrough + +
client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
@@ -11880,7 +11840,7 @@ await client.filestorage.drives.list();
-Returns a `Drive` object with the given `id`. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -11896,7 +11856,10 @@ Returns a `Drive` object with the given `id`.
```typescript -await client.filestorage.drives.retrieve("id"); +await client.crm.asyncPassthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -11912,15 +11875,7 @@ await client.filestorage.drives.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.DrivesRetrieveRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -11928,7 +11883,7 @@ await client.filestorage.drives.retrieve("id");
-**requestOptions:** `Drives.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -11939,9 +11894,7 @@ await client.filestorage.drives.retrieve("id");
-## Filestorage FieldMapping - -
client.filestorage.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse +
client.crm.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
@@ -11953,7 +11906,7 @@ await client.filestorage.drives.retrieve("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/). +Retrieves data from earlier async-passthrough POST request
@@ -11969,7 +11922,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```typescript -await client.filestorage.fieldMapping.fieldMappingsRetrieve(); +await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
@@ -11985,7 +11938,7 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve();
-**request:** `Merge.filestorage.FieldMappingsRetrieveRequest` +**asyncPassthroughReceiptId:** `string`
@@ -11993,7 +11946,7 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -12004,7 +11957,9 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve();
-
client.filestorage.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse +## Crm AuditTrail + +
client.crm.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
@@ -12016,7 +11971,7 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve();
-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. +Gets a list of audit trail events.
@@ -12032,14 +11987,7 @@ Create new Field Mappings that will be available after the next scheduled sync.
```typescript -await client.filestorage.fieldMapping.fieldMappingsCreate({ - targetFieldName: "example_target_field_name", - targetFieldDescription: "this is a example description of the target field", - remoteFieldTraversalPath: ["example_remote_field"], - remoteMethod: "GET", - remoteUrlPath: "/example-url-path", - commonModelName: "ExampleCommonModel", -}); +await client.crm.auditTrail.list(); ```
@@ -12055,7 +12003,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-**request:** `Merge.filestorage.CreateFieldMappingRequest` +**request:** `Merge.crm.AuditTrailListRequest`
@@ -12063,7 +12011,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `AuditTrail.RequestOptions`
@@ -12074,7 +12022,9 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-
client.filestorage.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse +## Crm AvailableActions + +
client.crm.availableActions.retrieve() -> Merge.AvailableActions
@@ -12086,7 +12036,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-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 models and actions available for an account.
@@ -12102,7 +12052,7 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
```typescript -await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id"); +await client.crm.availableActions.retrieve(); ```
@@ -12118,15 +12068,7 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**fieldMappingId:** `string` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `AvailableActions.RequestOptions`
@@ -12137,7 +12079,9 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
client.filestorage.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse +## Crm Contacts + +
client.crm.contacts.list({ ...params }) -> Merge.PaginatedContactList
@@ -12149,7 +12093,7 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_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. +Returns a list of `Contact` objects.
@@ -12165,7 +12109,7 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```typescript -await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); +await client.crm.contacts.list(); ```
@@ -12181,15 +12125,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-**fieldMappingId:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.PatchedEditFieldMappingRequest` +**request:** `Merge.crm.ContactsListRequest`
@@ -12197,7 +12133,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -12208,7 +12144,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-
client.filestorage.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse +
client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse
@@ -12220,7 +12156,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-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/). +Creates a `Contact` object with the given values.
@@ -12236,7 +12172,9 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```typescript -await client.filestorage.fieldMapping.remoteFieldsRetrieve(); +await client.crm.contacts.create({ + model: {}, +}); ```
@@ -12252,7 +12190,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve();
-**request:** `Merge.filestorage.RemoteFieldsRetrieveRequest` +**request:** `Merge.crm.CrmContactEndpointRequest`
@@ -12260,7 +12198,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -12271,7 +12209,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve();
-
client.filestorage.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse +
client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact
@@ -12283,7 +12221,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve();
-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 `Contact` object with the given `id`.
@@ -12299,7 +12237,7 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```typescript -await client.filestorage.fieldMapping.targetFieldsRetrieve(); +await client.crm.contacts.retrieve("id"); ```
@@ -12315,7 +12253,23 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.ContactsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Contacts.RequestOptions`
@@ -12326,9 +12280,7 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-## Filestorage Files - -
client.filestorage.files.list({ ...params }) -> Merge.PaginatedFileList +
client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse
@@ -12340,7 +12292,7 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-Returns a list of `File` objects. +Updates a `Contact` object with the given `id`.
@@ -12356,7 +12308,9 @@ Returns a list of `File` objects.
```typescript -await client.filestorage.files.list(); +await client.crm.contacts.partialUpdate("id", { + model: {}, +}); ```
@@ -12372,7 +12326,7 @@ await client.filestorage.files.list();
-**request:** `Merge.filestorage.FilesListRequest` +**id:** `string`
@@ -12380,7 +12334,15 @@ await client.filestorage.files.list();
-**requestOptions:** `Files.RequestOptions` +**request:** `Merge.crm.PatchedCrmContactEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Contacts.RequestOptions`
@@ -12391,7 +12353,7 @@ await client.filestorage.files.list();
-
client.filestorage.files.create({ ...params }) -> Merge.FileStorageFileResponse +
client.crm.contacts.ignoreCreate(modelId, { ...params }) -> void
@@ -12403,7 +12365,7 @@ await client.filestorage.files.list();
-Creates a `File` object with the given values. +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.
@@ -12419,8 +12381,8 @@ Creates a `File` object with the given values.
```typescript -await client.filestorage.files.create({ - model: {}, +await client.crm.contacts.ignoreCreate("model_id", { + reason: "GENERAL_CUSTOMER_REQUEST", }); ``` @@ -12437,7 +12399,7 @@ await client.filestorage.files.create({
-**request:** `Merge.filestorage.FileStorageFileEndpointRequest` +**modelId:** `string`
@@ -12445,7 +12407,15 @@ await client.filestorage.files.create({
-**requestOptions:** `Files.RequestOptions` +**request:** `Merge.IgnoreCommonModelRequest` + +
+
+ +
+
+ +**requestOptions:** `Contacts.RequestOptions`
@@ -12456,7 +12426,7 @@ await client.filestorage.files.create({
-
client.filestorage.files.retrieve(id, { ...params }) -> Merge.File_ +
client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -12468,7 +12438,7 @@ await client.filestorage.files.create({
-Returns a `File` object with the given `id`. +Returns metadata for `CRMContact` PATCHs.
@@ -12484,7 +12454,7 @@ Returns a `File` object with the given `id`.
```typescript -await client.filestorage.files.retrieve("id"); +await client.crm.contacts.metaPatchRetrieve("id"); ```
@@ -12508,15 +12478,7 @@ await client.filestorage.files.retrieve("id");
-**request:** `Merge.filestorage.FilesRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -12527,7 +12489,7 @@ await client.filestorage.files.retrieve("id");
-
client.filestorage.files.downloadRequestMetaRetrieve(id, { ...params }) -> Merge.DownloadRequestMeta +
client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse
@@ -12539,7 +12501,7 @@ await client.filestorage.files.retrieve("id");
-Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party. +Returns metadata for `CRMContact` POSTs.
@@ -12555,7 +12517,7 @@ Returns metadata to construct an authenticated file download request for a singu
```typescript -await client.filestorage.files.downloadRequestMetaRetrieve("id"); +await client.crm.contacts.metaPostRetrieve(); ```
@@ -12571,23 +12533,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.FilesDownloadRequestMetaRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -12598,7 +12544,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id");
-
client.filestorage.files.downloadRequestMetaList({ ...params }) -> Merge.PaginatedDownloadRequestMetaList +
client.crm.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -12610,7 +12556,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id");
-Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party. +Returns a list of `RemoteFieldClass` objects.
@@ -12626,7 +12572,7 @@ Returns metadata to construct authenticated file download requests, allowing you
```typescript -await client.filestorage.files.downloadRequestMetaList(); +await client.crm.contacts.remoteFieldClassesList(); ```
@@ -12642,7 +12588,7 @@ await client.filestorage.files.downloadRequestMetaList();
-**request:** `Merge.filestorage.FilesDownloadRequestMetaListRequest` +**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest`
@@ -12650,7 +12596,7 @@ await client.filestorage.files.downloadRequestMetaList();
-**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -12661,7 +12607,9 @@ await client.filestorage.files.downloadRequestMetaList();
-
client.filestorage.files.metaPostRetrieve() -> Merge.MetaResponse +## Crm CustomObjectClasses + +
client.crm.customObjectClasses.list({ ...params }) -> Merge.PaginatedCustomObjectClassList
@@ -12673,7 +12621,7 @@ await client.filestorage.files.downloadRequestMetaList();
-Returns metadata for `FileStorageFile` POSTs. +Returns a list of `CustomObjectClass` objects.
@@ -12689,7 +12637,7 @@ Returns metadata for `FileStorageFile` POSTs.
```typescript -await client.filestorage.files.metaPostRetrieve(); +await client.crm.customObjectClasses.list(); ```
@@ -12705,7 +12653,15 @@ await client.filestorage.files.metaPostRetrieve();
-**requestOptions:** `Files.RequestOptions` +**request:** `Merge.crm.CustomObjectClassesListRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjectClasses.RequestOptions`
@@ -12716,9 +12672,7 @@ await client.filestorage.files.metaPostRetrieve();
-## Filestorage Folders - -
client.filestorage.folders.list({ ...params }) -> Merge.PaginatedFolderList +
client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass
@@ -12730,7 +12684,7 @@ await client.filestorage.files.metaPostRetrieve();
-Returns a list of `Folder` objects. +Returns a `CustomObjectClass` object with the given `id`.
@@ -12746,7 +12700,7 @@ Returns a list of `Folder` objects.
```typescript -await client.filestorage.folders.list(); +await client.crm.customObjectClasses.retrieve("id"); ```
@@ -12762,7 +12716,7 @@ await client.filestorage.folders.list();
-**request:** `Merge.filestorage.FoldersListRequest` +**id:** `string`
@@ -12770,7 +12724,15 @@ await client.filestorage.folders.list();
-**requestOptions:** `Folders.RequestOptions` +**request:** `Merge.crm.CustomObjectClassesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjectClasses.RequestOptions`
@@ -12781,7 +12743,9 @@ await client.filestorage.folders.list();
-
client.filestorage.folders.create({ ...params }) -> Merge.FileStorageFolderResponse +## Crm AssociationTypes + +
client.crm.associationTypes.customObjectClassesAssociationTypesList(customObjectClassId, { ...params }) -> Merge.PaginatedAssociationTypeList
@@ -12793,7 +12757,7 @@ await client.filestorage.folders.list();
-Creates a `Folder` object with the given values. +Returns a list of `AssociationType` objects.
@@ -12809,9 +12773,7 @@ Creates a `Folder` object with the given values.
```typescript -await client.filestorage.folders.create({ - model: {}, -}); +await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id"); ```
@@ -12827,7 +12789,7 @@ await client.filestorage.folders.create({
-**request:** `Merge.filestorage.FileStorageFolderEndpointRequest` +**customObjectClassId:** `string`
@@ -12835,7 +12797,15 @@ await client.filestorage.folders.create({
-**requestOptions:** `Folders.RequestOptions` +**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest` + +
+
+ +
+
+ +**requestOptions:** `AssociationTypes.RequestOptions`
@@ -12846,7 +12816,7 @@ await client.filestorage.folders.create({
-
client.filestorage.folders.retrieve(id, { ...params }) -> Merge.Folder +
client.crm.associationTypes.customObjectClassesAssociationTypesCreate(customObjectClassId, { ...params }) -> Merge.CrmAssociationTypeResponse
@@ -12858,7 +12828,7 @@ await client.filestorage.folders.create({
-Returns a `Folder` object with the given `id`. +Creates an `AssociationType` object with the given values.
@@ -12874,7 +12844,21 @@ Returns a `Folder` object with the given `id`.
```typescript -await client.filestorage.folders.retrieve("id"); +await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("custom_object_class_id", { + model: { + sourceObjectClass: { + id: "id", + originType: "CUSTOM_OBJECT", + }, + targetObjectClasses: [ + { + id: "id", + originType: "CUSTOM_OBJECT", + }, + ], + remoteKeyName: "remote_key_name", + }, +}); ```
@@ -12890,7 +12874,7 @@ await client.filestorage.folders.retrieve("id");
-**id:** `string` +**customObjectClassId:** `string`
@@ -12898,7 +12882,7 @@ await client.filestorage.folders.retrieve("id");
-**request:** `Merge.filestorage.FoldersRetrieveRequest` +**request:** `Merge.crm.CrmAssociationTypeEndpointRequest`
@@ -12906,7 +12890,7 @@ await client.filestorage.folders.retrieve("id");
-**requestOptions:** `Folders.RequestOptions` +**requestOptions:** `AssociationTypes.RequestOptions`
@@ -12917,7 +12901,7 @@ await client.filestorage.folders.retrieve("id");
-
client.filestorage.folders.metaPostRetrieve() -> Merge.MetaResponse +
client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(customObjectClassId, id, { ...params }) -> Merge.AssociationType
@@ -12929,7 +12913,7 @@ await client.filestorage.folders.retrieve("id");
-Returns metadata for `FileStorageFolder` POSTs. +Returns an `AssociationType` object with the given `id`.
@@ -12945,7 +12929,7 @@ Returns metadata for `FileStorageFolder` POSTs.
```typescript -await client.filestorage.folders.metaPostRetrieve(); +await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id"); ```
@@ -12961,32 +12945,54 @@ await client.filestorage.folders.metaPostRetrieve();
-**requestOptions:** `Folders.RequestOptions` +**customObjectClassId:** `string`
- -
+ +
+
+ +**id:** `string`
-
-## Filestorage GenerateKey - -
client.filestorage.generateKey.create({ ...params }) -> Merge.RemoteKey
-#### 📝 Description +**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `AssociationTypes.RequestOptions` + +
+
+ + + + +
+ +
client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
+#### 📝 Description +
-Create a remote key. +
+
+ +Returns metadata for `CRMAssociationType` POSTs.
@@ -13002,9 +13008,7 @@ Create a remote key.
```typescript -await client.filestorage.generateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id"); ```
@@ -13020,7 +13024,7 @@ await client.filestorage.generateKey.create({
-**request:** `Merge.filestorage.GenerateRemoteKeyRequest` +**customObjectClassId:** `string`
@@ -13028,7 +13032,7 @@ await client.filestorage.generateKey.create({
-**requestOptions:** `GenerateKey.RequestOptions` +**requestOptions:** `AssociationTypes.RequestOptions`
@@ -13039,9 +13043,9 @@ await client.filestorage.generateKey.create({
-## Filestorage Groups +## Crm CustomObjects -
client.filestorage.groups.list({ ...params }) -> Merge.PaginatedGroupList +
client.crm.customObjects.customObjectClassesCustomObjectsList(customObjectClassId, { ...params }) -> Merge.PaginatedCustomObjectList
@@ -13053,7 +13057,7 @@ await client.filestorage.generateKey.create({
-Returns a list of `Group` objects. +Returns a list of `CustomObject` objects.
@@ -13069,7 +13073,7 @@ Returns a list of `Group` objects.
```typescript -await client.filestorage.groups.list(); +await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id"); ```
@@ -13085,7 +13089,7 @@ await client.filestorage.groups.list();
-**request:** `Merge.filestorage.GroupsListRequest` +**customObjectClassId:** `string`
@@ -13093,7 +13097,15 @@ await client.filestorage.groups.list();
-**requestOptions:** `Groups.RequestOptions` +**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjects.RequestOptions`
@@ -13104,7 +13116,7 @@ await client.filestorage.groups.list();
-
client.filestorage.groups.retrieve(id, { ...params }) -> Merge.Group +
client.crm.customObjects.customObjectClassesCustomObjectsCreate(customObjectClassId, { ...params }) -> Merge.CrmCustomObjectResponse
@@ -13116,7 +13128,7 @@ await client.filestorage.groups.list();
-Returns a `Group` object with the given `id`. +Creates a `CustomObject` object with the given values.
@@ -13132,7 +13144,13 @@ Returns a `Group` object with the given `id`.
```typescript -await client.filestorage.groups.retrieve("id"); +await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", { + model: { + fields: { + test_field: "hello", + }, + }, +}); ```
@@ -13148,7 +13166,7 @@ await client.filestorage.groups.retrieve("id");
-**id:** `string` +**customObjectClassId:** `string`
@@ -13156,7 +13174,7 @@ await client.filestorage.groups.retrieve("id");
-**request:** `Merge.filestorage.GroupsRetrieveRequest` +**request:** `Merge.crm.CrmCustomObjectEndpointRequest`
@@ -13164,7 +13182,7 @@ await client.filestorage.groups.retrieve("id");
-**requestOptions:** `Groups.RequestOptions` +**requestOptions:** `CustomObjects.RequestOptions`
@@ -13175,9 +13193,7 @@ await client.filestorage.groups.retrieve("id");
-## Filestorage Issues - -
client.filestorage.issues.list({ ...params }) -> Merge.PaginatedIssueList +
client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(customObjectClassId, id, { ...params }) -> Merge.CustomObject
@@ -13189,7 +13205,7 @@ await client.filestorage.groups.retrieve("id");
-Gets all issues for Organization. +Returns a `CustomObject` object with the given `id`.
@@ -13205,7 +13221,7 @@ Gets all issues for Organization.
```typescript -await client.filestorage.issues.list(); +await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id"); ```
@@ -13221,7 +13237,7 @@ await client.filestorage.issues.list();
-**request:** `Merge.filestorage.IssuesListRequest` +**customObjectClassId:** `string`
@@ -13229,7 +13245,23 @@ await client.filestorage.issues.list();
-**requestOptions:** `Issues.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjects.RequestOptions`
@@ -13240,7 +13272,7 @@ await client.filestorage.issues.list();
-
client.filestorage.issues.retrieve(id) -> Merge.Issue +
client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
@@ -13252,7 +13284,7 @@ await client.filestorage.issues.list();
-Get a specific issue. +Returns metadata for `CRMCustomObject` POSTs.
@@ -13268,7 +13300,7 @@ Get a specific issue.
```typescript -await client.filestorage.issues.retrieve("id"); +await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id"); ```
@@ -13284,7 +13316,7 @@ await client.filestorage.issues.retrieve("id");
-**id:** `string` +**customObjectClassId:** `string`
@@ -13292,7 +13324,7 @@ await client.filestorage.issues.retrieve("id");
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `CustomObjects.RequestOptions`
@@ -13303,9 +13335,7 @@ await client.filestorage.issues.retrieve("id");
-## Filestorage LinkToken - -
client.filestorage.linkToken.create({ ...params }) -> Merge.LinkToken +
client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -13317,7 +13347,7 @@ await client.filestorage.issues.retrieve("id");
-Creates a link token to be used when linking a new end user. +Returns a list of `RemoteFieldClass` objects.
@@ -13333,12 +13363,7 @@ Creates a link token to be used when linking a new end user.
```typescript -await client.filestorage.linkToken.create({ - endUserEmailAddress: "example@gmail.com", - endUserOrganizationName: "Test Organization", - endUserOriginId: "12345", - categories: ["hris", "ats"], -}); +await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList(); ```
@@ -13354,7 +13379,7 @@ await client.filestorage.linkToken.create({
-**request:** `Merge.filestorage.EndUserDetailsRequest` +**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest`
@@ -13362,7 +13387,7 @@ await client.filestorage.linkToken.create({
-**requestOptions:** `LinkToken.RequestOptions` +**requestOptions:** `CustomObjects.RequestOptions`
@@ -13373,9 +13398,9 @@ await client.filestorage.linkToken.create({
-## Filestorage LinkedAccounts +## Crm Associations -
client.filestorage.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList +
client.crm.associations.customObjectClassesCustomObjectsAssociationsList(customObjectClassId, objectId, { ...params }) -> Merge.PaginatedAssociationList
@@ -13387,7 +13412,7 @@ await client.filestorage.linkToken.create({
-List linked accounts for your organization. +Returns a list of `Association` objects.
@@ -13403,7 +13428,7 @@ List linked accounts for your organization.
```typescript -await client.filestorage.linkedAccounts.list(); +await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id"); ```
@@ -13419,7 +13444,7 @@ await client.filestorage.linkedAccounts.list();
-**request:** `Merge.filestorage.LinkedAccountsListRequest` +**customObjectClassId:** `string`
@@ -13427,20 +13452,34 @@ await client.filestorage.linkedAccounts.list();
-**requestOptions:** `LinkedAccounts.RequestOptions` +**objectId:** `string`
+ +
+
+ +**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest` +
+
+
+ +**requestOptions:** `Associations.RequestOptions` + +
+
-
-## Filestorage Passthrough + + +
-
client.filestorage.passthrough.create({ ...params }) -> Merge.RemoteResponse +
client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(associationTypeId, sourceClassId, sourceObjectId, targetClassId, targetObjectId, { ...params }) -> Merge.Association
@@ -13452,7 +13491,7 @@ await client.filestorage.linkedAccounts.list();
-Pull data from an endpoint not currently supported by Merge. +Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -13468,10 +13507,13 @@ Pull data from an endpoint not currently supported by Merge.
```typescript -await client.filestorage.passthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate( + "association_type_id", + "source_class_id", + "source_object_id", + "target_class_id", + "target_object_id", +); ```
@@ -13487,7 +13529,7 @@ await client.filestorage.passthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**associationTypeId:** `string`
@@ -13495,58 +13537,79 @@ await client.filestorage.passthrough.create({
-**requestOptions:** `Passthrough.RequestOptions` +**sourceClassId:** `string`
+ +
+
+ +**sourceObjectId:** `string` +
+
+
+ +**targetClassId:** `string` +
-
- -## Filestorage RegenerateKey -
client.filestorage.regenerateKey.create({ ...params }) -> Merge.RemoteKey
-#### 📝 Description +**targetObjectId:** `string` + +
+
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest` + +
+
+
-Exchange remote keys. +**requestOptions:** `Associations.RequestOptions`
-#### 🔌 Usage + + +
+ +## Crm Scopes +
client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
+#### 📝 Description +
-```typescript -await client.filestorage.regenerateKey.create({ - name: "Remote Deployment Key 1", -}); -``` +
+
+ +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).
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -13554,15 +13617,24 @@ await client.filestorage.regenerateKey.create({
-**request:** `Merge.filestorage.RemoteKeyForRegenerationRequest` +```typescript +await client.crm.scopes.defaultScopesRetrieve(); +```
+
+
+ +#### ⚙️ Parameters
-**requestOptions:** `RegenerateKey.RequestOptions` +
+
+ +**requestOptions:** `Scopes.RequestOptions`
@@ -13573,9 +13645,7 @@ await client.filestorage.regenerateKey.create({
-## Filestorage SyncStatus - -
client.filestorage.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList +
client.crm.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -13587,7 +13657,7 @@ await client.filestorage.regenerateKey.create({
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +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).
@@ -13603,7 +13673,7 @@ Get sync status for the current sync and the most recently finished sync. `last_
```typescript -await client.filestorage.syncStatus.list(); +await client.crm.scopes.linkedAccountScopesRetrieve(); ```
@@ -13619,15 +13689,7 @@ await client.filestorage.syncStatus.list();
-**request:** `Merge.filestorage.SyncStatusListRequest` - -
-
- -
-
- -**requestOptions:** `SyncStatus.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -13638,9 +13700,7 @@ await client.filestorage.syncStatus.list();
-## Filestorage ForceResync - -
client.filestorage.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[] +
client.crm.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
@@ -13652,7 +13712,7 @@ await client.filestorage.syncStatus.list();
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +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)
@@ -13668,7 +13728,33 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```typescript -await client.filestorage.forceResync.syncStatusResyncCreate(); +await client.crm.scopes.linkedAccountScopesCreate({ + commonModels: [ + { + modelName: "Employee", + modelPermissions: { + READ: { + isEnabled: true, + }, + WRITE: { + isEnabled: false, + }, + }, + fieldPermissions: { + enabledFields: ["avatar", "home_location"], + disabledFields: ["work_location"], + }, + }, + { + modelName: "Benefit", + modelPermissions: { + WRITE: { + isEnabled: false, + }, + }, + }, + ], +}); ```
@@ -13684,7 +13770,15 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-**requestOptions:** `ForceResync.RequestOptions` +**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest` + +
+
+ +
+
+ +**requestOptions:** `Scopes.RequestOptions`
@@ -13695,9 +13789,9 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-## Filestorage Users +## Crm DeleteAccount -
client.filestorage.users.list({ ...params }) -> Merge.PaginatedUserList +
client.crm.deleteAccount.delete() -> void
@@ -13709,7 +13803,7 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-Returns a list of `User` objects. +Delete a linked account.
@@ -13725,7 +13819,7 @@ Returns a list of `User` objects.
```typescript -await client.filestorage.users.list(); +await client.crm.deleteAccount.delete(); ```
@@ -13741,15 +13835,7 @@ await client.filestorage.users.list();
-**request:** `Merge.filestorage.UsersListRequest` - -
-
- -
-
- -**requestOptions:** `Users.RequestOptions` +**requestOptions:** `DeleteAccount.RequestOptions`
@@ -13760,7 +13846,9 @@ await client.filestorage.users.list();
-
client.filestorage.users.retrieve(id, { ...params }) -> Merge.User +## Crm EngagementTypes + +
client.crm.engagementTypes.list({ ...params }) -> Merge.PaginatedEngagementTypeList
@@ -13772,7 +13860,7 @@ await client.filestorage.users.list();
-Returns a `User` object with the given `id`. +Returns a list of `EngagementType` objects.
@@ -13788,7 +13876,7 @@ Returns a `User` object with the given `id`.
```typescript -await client.filestorage.users.retrieve("id"); +await client.crm.engagementTypes.list(); ```
@@ -13804,15 +13892,7 @@ await client.filestorage.users.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.UsersRetrieveRequest` +**request:** `Merge.crm.EngagementTypesListRequest`
@@ -13820,7 +13900,7 @@ await client.filestorage.users.retrieve("id");
-**requestOptions:** `Users.RequestOptions` +**requestOptions:** `EngagementTypes.RequestOptions`
@@ -13831,9 +13911,7 @@ await client.filestorage.users.retrieve("id");
-## Filestorage WebhookReceivers - -
client.filestorage.webhookReceivers.list() -> Merge.WebhookReceiver[] +
client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType
@@ -13845,7 +13923,7 @@ await client.filestorage.users.retrieve("id");
-Returns a list of `WebhookReceiver` objects. +Returns an `EngagementType` object with the given `id`.
@@ -13861,7 +13939,7 @@ Returns a list of `WebhookReceiver` objects.
```typescript -await client.filestorage.webhookReceivers.list(); +await client.crm.engagementTypes.retrieve("id"); ```
@@ -13877,7 +13955,23 @@ await client.filestorage.webhookReceivers.list();
-**requestOptions:** `WebhookReceivers.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.EngagementTypesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `EngagementTypes.RequestOptions`
@@ -13888,7 +13982,7 @@ await client.filestorage.webhookReceivers.list();
-
client.filestorage.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver +
client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -13900,7 +13994,7 @@ await client.filestorage.webhookReceivers.list();
-Creates a `WebhookReceiver` object with the given values. +Returns a list of `RemoteFieldClass` objects.
@@ -13916,10 +14010,7 @@ Creates a `WebhookReceiver` object with the given values.
```typescript -await client.filestorage.webhookReceivers.create({ - event: "event", - isActive: true, -}); +await client.crm.engagementTypes.remoteFieldClassesList(); ```
@@ -13935,7 +14026,7 @@ await client.filestorage.webhookReceivers.create({
-**request:** `Merge.filestorage.WebhookReceiverRequest` +**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest`
@@ -13943,7 +14034,7 @@ await client.filestorage.webhookReceivers.create({
-**requestOptions:** `WebhookReceivers.RequestOptions` +**requestOptions:** `EngagementTypes.RequestOptions`
@@ -13954,9 +14045,9 @@ await client.filestorage.webhookReceivers.create({
-## Hris AccountDetails +## Crm Engagements -
client.hris.accountDetails.retrieve() -> Merge.AccountDetails +
client.crm.engagements.list({ ...params }) -> Merge.PaginatedEngagementList
@@ -13968,7 +14059,7 @@ await client.filestorage.webhookReceivers.create({
-Get details for a linked account. +Returns a list of `Engagement` objects.
@@ -13984,7 +14075,7 @@ Get details for a linked account.
```typescript -await client.hris.accountDetails.retrieve(); +await client.crm.engagements.list(); ```
@@ -14000,7 +14091,15 @@ await client.hris.accountDetails.retrieve();
-**requestOptions:** `AccountDetails.RequestOptions` +**request:** `Merge.crm.EngagementsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Engagements.RequestOptions`
@@ -14011,9 +14110,7 @@ await client.hris.accountDetails.retrieve();
-## Hris AccountToken - -
client.hris.accountToken.retrieve(publicToken) -> Merge.AccountToken +
client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse
@@ -14025,7 +14122,7 @@ await client.hris.accountDetails.retrieve();
-Returns the account token for the end user with the provided public token. +Creates an `Engagement` object with the given values.
@@ -14041,7 +14138,9 @@ Returns the account token for the end user with the provided public token.
```typescript -await client.hris.accountToken.retrieve("public_token"); +await client.crm.engagements.create({ + model: {}, +}); ```
@@ -14057,7 +14156,7 @@ await client.hris.accountToken.retrieve("public_token");
-**publicToken:** `string` +**request:** `Merge.crm.EngagementEndpointRequest`
@@ -14065,7 +14164,7 @@ await client.hris.accountToken.retrieve("public_token");
-**requestOptions:** `AccountToken.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -14076,9 +14175,7 @@ await client.hris.accountToken.retrieve("public_token");
-## Hris AsyncPassthrough - -
client.hris.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept +
client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement
@@ -14090,7 +14187,7 @@ await client.hris.accountToken.retrieve("public_token");
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns an `Engagement` object with the given `id`.
@@ -14106,10 +14203,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```typescript -await client.hris.asyncPassthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.crm.engagements.retrieve("id"); ```
@@ -14125,7 +14219,7 @@ await client.hris.asyncPassthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**id:** `string`
@@ -14133,7 +14227,15 @@ await client.hris.asyncPassthrough.create({
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**request:** `Merge.crm.EngagementsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Engagements.RequestOptions`
@@ -14144,7 +14246,7 @@ await client.hris.asyncPassthrough.create({
-
client.hris.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse +
client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse
@@ -14156,7 +14258,7 @@ await client.hris.asyncPassthrough.create({
-Retrieves data from earlier async-passthrough POST request +Updates an `Engagement` object with the given `id`.
@@ -14172,7 +14274,9 @@ Retrieves data from earlier async-passthrough POST request
```typescript -await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id"); +await client.crm.engagements.partialUpdate("id", { + model: {}, +}); ```
@@ -14188,7 +14292,7 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**asyncPassthroughReceiptId:** `string` +**id:** `string`
@@ -14196,7 +14300,15 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**request:** `Merge.crm.PatchedEngagementEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Engagements.RequestOptions`
@@ -14207,9 +14319,7 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-## Hris AuditTrail - -
client.hris.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList +
client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -14221,7 +14331,7 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-Gets a list of audit trail events. +Returns metadata for `Engagement` PATCHs.
@@ -14237,7 +14347,7 @@ Gets a list of audit trail events.
```typescript -await client.hris.auditTrail.list(); +await client.crm.engagements.metaPatchRetrieve("id"); ```
@@ -14253,7 +14363,7 @@ await client.hris.auditTrail.list();
-**request:** `Merge.hris.AuditTrailListRequest` +**id:** `string`
@@ -14261,7 +14371,7 @@ await client.hris.auditTrail.list();
-**requestOptions:** `AuditTrail.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -14272,9 +14382,7 @@ await client.hris.auditTrail.list();
-## Hris AvailableActions - -
client.hris.availableActions.retrieve() -> Merge.AvailableActions +
client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse
@@ -14286,7 +14394,7 @@ await client.hris.auditTrail.list();
-Returns a list of models and actions available for an account. +Returns metadata for `Engagement` POSTs.
@@ -14302,7 +14410,7 @@ Returns a list of models and actions available for an account.
```typescript -await client.hris.availableActions.retrieve(); +await client.crm.engagements.metaPostRetrieve(); ```
@@ -14318,7 +14426,7 @@ await client.hris.availableActions.retrieve();
-**requestOptions:** `AvailableActions.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -14329,9 +14437,7 @@ await client.hris.availableActions.retrieve();
-## Hris BankInfo - -
client.hris.bankInfo.list({ ...params }) -> Merge.PaginatedBankInfoList +
client.crm.engagements.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -14343,7 +14449,7 @@ await client.hris.availableActions.retrieve();
-Returns a list of `BankInfo` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -14359,7 +14465,7 @@ Returns a list of `BankInfo` objects.
```typescript -await client.hris.bankInfo.list(); +await client.crm.engagements.remoteFieldClassesList(); ```
@@ -14375,7 +14481,7 @@ await client.hris.bankInfo.list();
-**request:** `Merge.hris.BankInfoListRequest` +**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest`
@@ -14383,7 +14489,7 @@ await client.hris.bankInfo.list();
-**requestOptions:** `BankInfo.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -14394,7 +14500,9 @@ await client.hris.bankInfo.list();
-
client.hris.bankInfo.retrieve(id, { ...params }) -> Merge.BankInfo +## Crm FieldMapping + +
client.crm.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
@@ -14406,7 +14514,7 @@ await client.hris.bankInfo.list();
-Returns a `BankInfo` 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/).
@@ -14422,7 +14530,7 @@ Returns a `BankInfo` object with the given `id`.
```typescript -await client.hris.bankInfo.retrieve("id"); +await client.crm.fieldMapping.fieldMappingsRetrieve(); ```
@@ -14438,15 +14546,7 @@ await client.hris.bankInfo.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.BankInfoRetrieveRequest` +**request:** `Merge.crm.FieldMappingsRetrieveRequest`
@@ -14454,7 +14554,7 @@ await client.hris.bankInfo.retrieve("id");
-**requestOptions:** `BankInfo.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -14465,9 +14565,7 @@ await client.hris.bankInfo.retrieve("id");
-## Hris Benefits - -
client.hris.benefits.list({ ...params }) -> Merge.PaginatedBenefitList +
client.crm.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
@@ -14479,7 +14577,7 @@ await client.hris.bankInfo.retrieve("id");
-Returns a list of `Benefit` 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.
@@ -14495,7 +14593,14 @@ Returns a list of `Benefit` objects.
```typescript -await client.hris.benefits.list(); +await client.crm.fieldMapping.fieldMappingsCreate({ + targetFieldName: "example_target_field_name", + targetFieldDescription: "this is a example description of the target field", + remoteFieldTraversalPath: ["example_remote_field"], + remoteMethod: "GET", + remoteUrlPath: "/example-url-path", + commonModelName: "ExampleCommonModel", +}); ```
@@ -14511,7 +14616,7 @@ await client.hris.benefits.list();
-**request:** `Merge.hris.BenefitsListRequest` +**request:** `Merge.crm.CreateFieldMappingRequest`
@@ -14519,7 +14624,7 @@ await client.hris.benefits.list();
-**requestOptions:** `Benefits.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -14530,7 +14635,7 @@ await client.hris.benefits.list();
-
client.hris.benefits.retrieve(id, { ...params }) -> Merge.Benefit +
client.crm.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
@@ -14542,7 +14647,7 @@ await client.hris.benefits.list();
-Returns a `Benefit` object with the given `id`. +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.
@@ -14558,7 +14663,7 @@ Returns a `Benefit` object with the given `id`.
```typescript -await client.hris.benefits.retrieve("id"); +await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
@@ -14574,15 +14679,7 @@ await client.hris.benefits.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.BenefitsRetrieveRequest` +**fieldMappingId:** `string`
@@ -14590,7 +14687,7 @@ await client.hris.benefits.retrieve("id");
-**requestOptions:** `Benefits.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -14601,9 +14698,7 @@ await client.hris.benefits.retrieve("id");
-## Hris Companies - -
client.hris.companies.list({ ...params }) -> Merge.PaginatedCompanyList +
client.crm.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
@@ -14615,7 +14710,7 @@ await client.hris.benefits.retrieve("id");
-Returns a list of `Company` 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.
@@ -14631,7 +14726,7 @@ Returns a list of `Company` objects.
```typescript -await client.hris.companies.list(); +await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); ```
@@ -14647,7 +14742,7 @@ await client.hris.companies.list();
-**request:** `Merge.hris.CompaniesListRequest` +**fieldMappingId:** `string`
@@ -14655,7 +14750,15 @@ await client.hris.companies.list();
-**requestOptions:** `Companies.RequestOptions` +**request:** `Merge.crm.PatchedEditFieldMappingRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -14666,7 +14769,7 @@ await client.hris.companies.list();
-
client.hris.companies.retrieve(id, { ...params }) -> Merge.Company +
client.crm.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
@@ -14678,7 +14781,7 @@ await client.hris.companies.list();
-Returns a `Company` 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/).
@@ -14694,7 +14797,7 @@ Returns a `Company` object with the given `id`.
```typescript -await client.hris.companies.retrieve("id"); +await client.crm.fieldMapping.remoteFieldsRetrieve(); ```
@@ -14710,15 +14813,7 @@ await client.hris.companies.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.CompaniesRetrieveRequest` +**request:** `Merge.crm.RemoteFieldsRetrieveRequest`
@@ -14726,7 +14821,7 @@ await client.hris.companies.retrieve("id");
-**requestOptions:** `Companies.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -14737,9 +14832,7 @@ await client.hris.companies.retrieve("id");
-## Hris Scopes - -
client.hris.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi +
client.crm.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
@@ -14751,7 +14844,7 @@ await client.hris.companies.retrieve("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). +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/).
@@ -14767,7 +14860,7 @@ Get the default permissions for Merge Common Models and fields across all Linked
```typescript -await client.hris.scopes.defaultScopesRetrieve(); +await client.crm.fieldMapping.targetFieldsRetrieve(); ```
@@ -14783,7 +14876,7 @@ await client.hris.scopes.defaultScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -14794,7 +14887,9 @@ await client.hris.scopes.defaultScopesRetrieve();
-
client.hris.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi +## Crm GenerateKey + +
client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey
@@ -14806,7 +14901,7 @@ await client.hris.scopes.defaultScopesRetrieve();
-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). +Create a remote key.
@@ -14822,7 +14917,9 @@ Get all available permissions for Merge Common Models and fields for a single Li
```typescript -await client.hris.scopes.linkedAccountScopesRetrieve(); +await client.crm.generateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -14838,7 +14935,15 @@ await client.hris.scopes.linkedAccountScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**request:** `Merge.crm.GenerateRemoteKeyRequest` + +
+
+ +
+
+ +**requestOptions:** `GenerateKey.RequestOptions`
@@ -14849,7 +14954,9 @@ await client.hris.scopes.linkedAccountScopesRetrieve();
-
client.hris.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi +## Crm Issues + +
client.crm.issues.list({ ...params }) -> Merge.PaginatedIssueList
@@ -14861,7 +14968,7 @@ await client.hris.scopes.linkedAccountScopesRetrieve();
-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) +Gets all issues for Organization.
@@ -14877,33 +14984,7 @@ Update permissions for any Common Model or field for a single Linked Account. An
```typescript -await client.hris.scopes.linkedAccountScopesCreate({ - commonModels: [ - { - modelName: "Employee", - modelPermissions: { - READ: { - isEnabled: true, - }, - WRITE: { - isEnabled: false, - }, - }, - fieldPermissions: { - enabledFields: ["avatar", "home_location"], - disabledFields: ["work_location"], - }, - }, - { - modelName: "Benefit", - modelPermissions: { - WRITE: { - isEnabled: false, - }, - }, - }, - ], -}); +await client.crm.issues.list(); ```
@@ -14919,7 +15000,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-**request:** `Merge.hris.LinkedAccountCommonModelScopeDeserializerRequest` +**request:** `Merge.crm.IssuesListRequest`
@@ -14927,7 +15008,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -14938,9 +15019,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-## Hris DeleteAccount - -
client.hris.deleteAccount.delete() -> void +
client.crm.issues.retrieve(id) -> Merge.Issue
@@ -14952,7 +15031,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-Delete a linked account. +Get a specific issue.
@@ -14968,7 +15047,7 @@ Delete a linked account.
```typescript -await client.hris.deleteAccount.delete(); +await client.crm.issues.retrieve("id"); ```
@@ -14984,7 +15063,15 @@ await client.hris.deleteAccount.delete();
-**requestOptions:** `DeleteAccount.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `Issues.RequestOptions`
@@ -14995,9 +15082,9 @@ await client.hris.deleteAccount.delete();
-## Hris Dependents +## Crm Leads -
client.hris.dependents.list({ ...params }) -> Merge.PaginatedDependentList +
client.crm.leads.list({ ...params }) -> Merge.PaginatedLeadList
@@ -15009,7 +15096,7 @@ await client.hris.deleteAccount.delete();
-Returns a list of `Dependent` objects. +Returns a list of `Lead` objects.
@@ -15025,7 +15112,7 @@ Returns a list of `Dependent` objects.
```typescript -await client.hris.dependents.list(); +await client.crm.leads.list(); ```
@@ -15041,7 +15128,7 @@ await client.hris.dependents.list();
-**request:** `Merge.hris.DependentsListRequest` +**request:** `Merge.crm.LeadsListRequest`
@@ -15049,7 +15136,7 @@ await client.hris.dependents.list();
-**requestOptions:** `Dependents.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -15060,7 +15147,7 @@ await client.hris.dependents.list();
-
client.hris.dependents.retrieve(id, { ...params }) -> Merge.Dependent +
client.crm.leads.create({ ...params }) -> Merge.LeadResponse
@@ -15072,7 +15159,7 @@ await client.hris.dependents.list();
-Returns a `Dependent` object with the given `id`. +Creates a `Lead` object with the given values.
@@ -15088,7 +15175,9 @@ Returns a `Dependent` object with the given `id`.
```typescript -await client.hris.dependents.retrieve("id"); +await client.crm.leads.create({ + model: {}, +}); ```
@@ -15104,15 +15193,7 @@ await client.hris.dependents.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.DependentsRetrieveRequest` +**request:** `Merge.crm.LeadEndpointRequest`
@@ -15120,7 +15201,7 @@ await client.hris.dependents.retrieve("id");
-**requestOptions:** `Dependents.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -15131,9 +15212,7 @@ await client.hris.dependents.retrieve("id");
-## Hris EmployeePayrollRuns - -
client.hris.employeePayrollRuns.list({ ...params }) -> Merge.PaginatedEmployeePayrollRunList +
client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead
@@ -15145,7 +15224,7 @@ await client.hris.dependents.retrieve("id");
-Returns a list of `EmployeePayrollRun` objects. +Returns a `Lead` object with the given `id`.
@@ -15161,7 +15240,7 @@ Returns a list of `EmployeePayrollRun` objects.
```typescript -await client.hris.employeePayrollRuns.list(); +await client.crm.leads.retrieve("id"); ```
@@ -15177,7 +15256,7 @@ await client.hris.employeePayrollRuns.list();
-**request:** `Merge.hris.EmployeePayrollRunsListRequest` +**id:** `string`
@@ -15185,7 +15264,15 @@ await client.hris.employeePayrollRuns.list();
-**requestOptions:** `EmployeePayrollRuns.RequestOptions` +**request:** `Merge.crm.LeadsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Leads.RequestOptions`
@@ -15196,7 +15283,7 @@ await client.hris.employeePayrollRuns.list();
-
client.hris.employeePayrollRuns.retrieve(id, { ...params }) -> Merge.EmployeePayrollRun +
client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse
@@ -15208,7 +15295,7 @@ await client.hris.employeePayrollRuns.list();
-Returns an `EmployeePayrollRun` object with the given `id`. +Returns metadata for `Lead` POSTs.
@@ -15224,7 +15311,7 @@ Returns an `EmployeePayrollRun` object with the given `id`.
```typescript -await client.hris.employeePayrollRuns.retrieve("id"); +await client.crm.leads.metaPostRetrieve(); ```
@@ -15240,23 +15327,7 @@ await client.hris.employeePayrollRuns.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.EmployeePayrollRunsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `EmployeePayrollRuns.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -15267,9 +15338,7 @@ await client.hris.employeePayrollRuns.retrieve("id");
-## Hris Employees - -
client.hris.employees.list({ ...params }) -> Merge.PaginatedEmployeeList +
client.crm.leads.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -15281,7 +15350,7 @@ await client.hris.employeePayrollRuns.retrieve("id");
-Returns a list of `Employee` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -15297,7 +15366,7 @@ Returns a list of `Employee` objects.
```typescript -await client.hris.employees.list(); +await client.crm.leads.remoteFieldClassesList(); ```
@@ -15313,7 +15382,7 @@ await client.hris.employees.list();
-**request:** `Merge.hris.EmployeesListRequest` +**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest`
@@ -15321,7 +15390,7 @@ await client.hris.employees.list();
-**requestOptions:** `Employees.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -15332,7 +15401,9 @@ await client.hris.employees.list();
-
client.hris.employees.create({ ...params }) -> Merge.EmployeeResponse +## Crm LinkToken + +
client.crm.linkToken.create({ ...params }) -> Merge.LinkToken
@@ -15344,7 +15415,7 @@ await client.hris.employees.list();
-Creates an `Employee` object with the given values. +Creates a link token to be used when linking a new end user.
@@ -15360,8 +15431,11 @@ Creates an `Employee` object with the given values.
```typescript -await client.hris.employees.create({ - model: {}, +await client.crm.linkToken.create({ + endUserEmailAddress: "example@gmail.com", + endUserOrganizationName: "Test Organization", + endUserOriginId: "12345", + categories: ["hris", "ats"], }); ``` @@ -15378,7 +15452,7 @@ await client.hris.employees.create({
-**request:** `Merge.hris.EmployeeEndpointRequest` +**request:** `Merge.crm.EndUserDetailsRequest`
@@ -15386,7 +15460,7 @@ await client.hris.employees.create({
-**requestOptions:** `Employees.RequestOptions` +**requestOptions:** `LinkToken.RequestOptions`
@@ -15397,7 +15471,9 @@ await client.hris.employees.create({
-
client.hris.employees.retrieve(id, { ...params }) -> Merge.Employee +## Crm LinkedAccounts + +
client.crm.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
@@ -15409,7 +15485,7 @@ await client.hris.employees.create({
-Returns an `Employee` object with the given `id`. +List linked accounts for your organization.
@@ -15425,7 +15501,7 @@ Returns an `Employee` object with the given `id`.
```typescript -await client.hris.employees.retrieve("id"); +await client.crm.linkedAccounts.list(); ```
@@ -15441,15 +15517,7 @@ await client.hris.employees.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.EmployeesRetrieveRequest` +**request:** `Merge.crm.LinkedAccountsListRequest`
@@ -15457,7 +15525,7 @@ await client.hris.employees.retrieve("id");
-**requestOptions:** `Employees.RequestOptions` +**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -15468,7 +15536,9 @@ await client.hris.employees.retrieve("id");
-
client.hris.employees.ignoreCreate(modelId, { ...params }) -> void +## Crm Notes + +
client.crm.notes.list({ ...params }) -> Merge.PaginatedNoteList
@@ -15480,7 +15550,7 @@ await client.hris.employees.retrieve("id");
-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 list of `Note` objects.
@@ -15496,9 +15566,7 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```typescript -await client.hris.employees.ignoreCreate("model_id", { - reason: "GENERAL_CUSTOMER_REQUEST", -}); +await client.crm.notes.list(); ```
@@ -15514,15 +15582,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-**modelId:** `string` - -
-
- -
-
- -**request:** `Merge.hris.IgnoreCommonModelRequest` +**request:** `Merge.crm.NotesListRequest`
@@ -15530,7 +15590,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-**requestOptions:** `Employees.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -15541,7 +15601,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-
client.hris.employees.metaPostRetrieve() -> Merge.MetaResponse +
client.crm.notes.create({ ...params }) -> Merge.NoteResponse
@@ -15553,7 +15613,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-Returns metadata for `Employee` POSTs. +Creates a `Note` object with the given values.
@@ -15569,7 +15629,9 @@ Returns metadata for `Employee` POSTs.
```typescript -await client.hris.employees.metaPostRetrieve(); +await client.crm.notes.create({ + model: {}, +}); ```
@@ -15585,7 +15647,15 @@ await client.hris.employees.metaPostRetrieve();
-**requestOptions:** `Employees.RequestOptions` +**request:** `Merge.crm.NoteEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Notes.RequestOptions`
@@ -15596,9 +15666,7 @@ await client.hris.employees.metaPostRetrieve();
-## Hris EmployerBenefits - -
client.hris.employerBenefits.list({ ...params }) -> Merge.PaginatedEmployerBenefitList +
client.crm.notes.retrieve(id, { ...params }) -> Merge.Note
@@ -15610,7 +15678,7 @@ await client.hris.employees.metaPostRetrieve();
-Returns a list of `EmployerBenefit` objects. +Returns a `Note` object with the given `id`.
@@ -15626,7 +15694,7 @@ Returns a list of `EmployerBenefit` objects.
```typescript -await client.hris.employerBenefits.list(); +await client.crm.notes.retrieve("id"); ```
@@ -15642,7 +15710,7 @@ await client.hris.employerBenefits.list();
-**request:** `Merge.hris.EmployerBenefitsListRequest` +**id:** `string`
@@ -15650,7 +15718,15 @@ await client.hris.employerBenefits.list();
-**requestOptions:** `EmployerBenefits.RequestOptions` +**request:** `Merge.crm.NotesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Notes.RequestOptions`
@@ -15661,7 +15737,7 @@ await client.hris.employerBenefits.list();
-
client.hris.employerBenefits.retrieve(id, { ...params }) -> Merge.EmployerBenefit +
client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse
@@ -15673,7 +15749,7 @@ await client.hris.employerBenefits.list();
-Returns an `EmployerBenefit` object with the given `id`. +Returns metadata for `Note` POSTs.
@@ -15689,7 +15765,7 @@ Returns an `EmployerBenefit` object with the given `id`.
```typescript -await client.hris.employerBenefits.retrieve("id"); +await client.crm.notes.metaPostRetrieve(); ```
@@ -15705,23 +15781,7 @@ await client.hris.employerBenefits.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.EmployerBenefitsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `EmployerBenefits.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -15732,9 +15792,7 @@ await client.hris.employerBenefits.retrieve("id");
-## Hris Employments - -
client.hris.employments.list({ ...params }) -> Merge.PaginatedEmploymentList +
client.crm.notes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -15746,7 +15804,7 @@ await client.hris.employerBenefits.retrieve("id");
-Returns a list of `Employment` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -15762,7 +15820,7 @@ Returns a list of `Employment` objects.
```typescript -await client.hris.employments.list(); +await client.crm.notes.remoteFieldClassesList(); ```
@@ -15778,7 +15836,7 @@ await client.hris.employments.list();
-**request:** `Merge.hris.EmploymentsListRequest` +**request:** `Merge.crm.NotesRemoteFieldClassesListRequest`
@@ -15786,7 +15844,7 @@ await client.hris.employments.list();
-**requestOptions:** `Employments.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -15797,7 +15855,9 @@ await client.hris.employments.list();
-
client.hris.employments.retrieve(id, { ...params }) -> Merge.Employment +## Crm Opportunities + +
client.crm.opportunities.list({ ...params }) -> Merge.PaginatedOpportunityList
@@ -15809,7 +15869,7 @@ await client.hris.employments.list();
-Returns an `Employment` object with the given `id`. +Returns a list of `Opportunity` objects.
@@ -15825,7 +15885,7 @@ Returns an `Employment` object with the given `id`.
```typescript -await client.hris.employments.retrieve("id"); +await client.crm.opportunities.list(); ```
@@ -15841,15 +15901,7 @@ await client.hris.employments.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.EmploymentsRetrieveRequest` +**request:** `Merge.crm.OpportunitiesListRequest`
@@ -15857,7 +15909,7 @@ await client.hris.employments.retrieve("id");
-**requestOptions:** `Employments.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -15868,9 +15920,7 @@ await client.hris.employments.retrieve("id");
-## Hris FieldMapping - -
client.hris.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse +
client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse
@@ -15882,7 +15932,7 @@ await client.hris.employments.retrieve("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/). +Creates an `Opportunity` object with the given values.
@@ -15898,7 +15948,9 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```typescript -await client.hris.fieldMapping.fieldMappingsRetrieve(); +await client.crm.opportunities.create({ + model: {}, +}); ```
@@ -15914,7 +15966,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve();
-**request:** `Merge.hris.FieldMappingsRetrieveRequest` +**request:** `Merge.crm.OpportunityEndpointRequest`
@@ -15922,7 +15974,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -15933,7 +15985,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve();
-
client.hris.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse +
client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity
@@ -15945,7 +15997,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve();
-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. +Returns an `Opportunity` object with the given `id`.
@@ -15961,14 +16013,7 @@ Create new Field Mappings that will be available after the next scheduled sync.
```typescript -await client.hris.fieldMapping.fieldMappingsCreate({ - targetFieldName: "example_target_field_name", - targetFieldDescription: "this is a example description of the target field", - remoteFieldTraversalPath: ["example_remote_field"], - remoteMethod: "GET", - remoteUrlPath: "/example-url-path", - commonModelName: "ExampleCommonModel", -}); +await client.crm.opportunities.retrieve("id"); ```
@@ -15984,7 +16029,7 @@ await client.hris.fieldMapping.fieldMappingsCreate({
-**request:** `Merge.hris.CreateFieldMappingRequest` +**id:** `string`
@@ -15992,7 +16037,15 @@ await client.hris.fieldMapping.fieldMappingsCreate({
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.crm.OpportunitiesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Opportunities.RequestOptions`
@@ -16003,7 +16056,7 @@ await client.hris.fieldMapping.fieldMappingsCreate({
-
client.hris.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse +
client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse
@@ -16015,7 +16068,7 @@ await client.hris.fieldMapping.fieldMappingsCreate({
-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. +Updates an `Opportunity` object with the given `id`.
@@ -16031,7 +16084,9 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
```typescript -await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id"); +await client.crm.opportunities.partialUpdate("id", { + model: {}, +}); ```
@@ -16047,7 +16102,7 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**fieldMappingId:** `string` +**id:** `string`
@@ -16055,7 +16110,15 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.crm.PatchedOpportunityEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Opportunities.RequestOptions`
@@ -16066,7 +16129,7 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
client.hris.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse +
client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -16078,7 +16141,7 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_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. +Returns metadata for `Opportunity` PATCHs.
@@ -16094,7 +16157,7 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```typescript -await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); +await client.crm.opportunities.metaPatchRetrieve("id"); ```
@@ -16110,15 +16173,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**fieldMappingId:** `string` - -
-
- -
-
- -**request:** `Merge.hris.PatchedEditFieldMappingRequest` +**id:** `string`
@@ -16126,7 +16181,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -16137,7 +16192,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
client.hris.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse +
client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse
@@ -16149,7 +16204,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_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/). +Returns metadata for `Opportunity` POSTs.
@@ -16165,7 +16220,7 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```typescript -await client.hris.fieldMapping.remoteFieldsRetrieve(); +await client.crm.opportunities.metaPostRetrieve(); ```
@@ -16181,15 +16236,7 @@ await client.hris.fieldMapping.remoteFieldsRetrieve();
-**request:** `Merge.hris.RemoteFieldsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -16200,7 +16247,7 @@ await client.hris.fieldMapping.remoteFieldsRetrieve();
-
client.hris.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse +
client.crm.opportunities.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -16212,7 +16259,7 @@ await client.hris.fieldMapping.remoteFieldsRetrieve();
-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 `RemoteFieldClass` objects.
@@ -16228,7 +16275,7 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```typescript -await client.hris.fieldMapping.targetFieldsRetrieve(); +await client.crm.opportunities.remoteFieldClassesList(); ```
@@ -16244,7 +16291,15 @@ await client.hris.fieldMapping.targetFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Opportunities.RequestOptions`
@@ -16255,9 +16310,9 @@ await client.hris.fieldMapping.targetFieldsRetrieve();
-## Hris GenerateKey +## Crm Passthrough -
client.hris.generateKey.create({ ...params }) -> Merge.RemoteKey +
client.crm.passthrough.create({ ...params }) -> Merge.RemoteResponse
@@ -16269,7 +16324,7 @@ await client.hris.fieldMapping.targetFieldsRetrieve();
-Create a remote key. +Pull data from an endpoint not currently supported by Merge.
@@ -16285,8 +16340,9 @@ Create a remote key.
```typescript -await client.hris.generateKey.create({ - name: "Remote Deployment Key 1", +await client.crm.passthrough.create({ + method: "GET", + path: "/scooters", }); ``` @@ -16303,7 +16359,7 @@ await client.hris.generateKey.create({
-**request:** `Merge.hris.GenerateRemoteKeyRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -16311,7 +16367,7 @@ await client.hris.generateKey.create({
-**requestOptions:** `GenerateKey.RequestOptions` +**requestOptions:** `Passthrough.RequestOptions`
@@ -16322,9 +16378,9 @@ await client.hris.generateKey.create({
-## Hris Groups +## Crm RegenerateKey -
client.hris.groups.list({ ...params }) -> Merge.PaginatedGroupList +
client.crm.regenerateKey.create({ ...params }) -> Merge.RemoteKey
@@ -16336,7 +16392,7 @@ await client.hris.generateKey.create({
-Returns a list of `Group` objects. +Exchange remote keys.
@@ -16352,7 +16408,9 @@ Returns a list of `Group` objects.
```typescript -await client.hris.groups.list(); +await client.crm.regenerateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -16368,7 +16426,7 @@ await client.hris.groups.list();
-**request:** `Merge.hris.GroupsListRequest` +**request:** `Merge.crm.RemoteKeyForRegenerationRequest`
@@ -16376,7 +16434,7 @@ await client.hris.groups.list();
-**requestOptions:** `Groups.RequestOptions` +**requestOptions:** `RegenerateKey.RequestOptions`
@@ -16387,7 +16445,9 @@ await client.hris.groups.list();
-
client.hris.groups.retrieve(id, { ...params }) -> Merge.Group +## Crm Stages + +
client.crm.stages.list({ ...params }) -> Merge.PaginatedStageList
@@ -16399,7 +16459,7 @@ await client.hris.groups.list();
-Returns a `Group` object with the given `id`. +Returns a list of `Stage` objects.
@@ -16415,7 +16475,7 @@ Returns a `Group` object with the given `id`.
```typescript -await client.hris.groups.retrieve("id"); +await client.crm.stages.list(); ```
@@ -16431,15 +16491,7 @@ await client.hris.groups.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.GroupsRetrieveRequest` +**request:** `Merge.crm.StagesListRequest`
@@ -16447,7 +16499,7 @@ await client.hris.groups.retrieve("id");
-**requestOptions:** `Groups.RequestOptions` +**requestOptions:** `Stages.RequestOptions`
@@ -16458,9 +16510,7 @@ await client.hris.groups.retrieve("id");
-## Hris Issues - -
client.hris.issues.list({ ...params }) -> Merge.PaginatedIssueList +
client.crm.stages.retrieve(id, { ...params }) -> Merge.Stage
@@ -16472,7 +16522,7 @@ await client.hris.groups.retrieve("id");
-Gets all issues for Organization. +Returns a `Stage` object with the given `id`.
@@ -16488,7 +16538,7 @@ Gets all issues for Organization.
```typescript -await client.hris.issues.list(); +await client.crm.stages.retrieve("id"); ```
@@ -16504,7 +16554,7 @@ await client.hris.issues.list();
-**request:** `Merge.hris.IssuesListRequest` +**id:** `string`
@@ -16512,7 +16562,15 @@ await client.hris.issues.list();
-**requestOptions:** `Issues.RequestOptions` +**request:** `Merge.crm.StagesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Stages.RequestOptions`
@@ -16523,7 +16581,7 @@ await client.hris.issues.list();
-
client.hris.issues.retrieve(id) -> Merge.Issue +
client.crm.stages.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -16535,7 +16593,7 @@ await client.hris.issues.list();
-Get a specific issue. +Returns a list of `RemoteFieldClass` objects.
@@ -16551,7 +16609,7 @@ Get a specific issue.
```typescript -await client.hris.issues.retrieve("id"); +await client.crm.stages.remoteFieldClassesList(); ```
@@ -16567,7 +16625,7 @@ await client.hris.issues.retrieve("id");
-**id:** `string` +**request:** `Merge.crm.StagesRemoteFieldClassesListRequest`
@@ -16575,7 +16633,7 @@ await client.hris.issues.retrieve("id");
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `Stages.RequestOptions`
@@ -16586,9 +16644,9 @@ await client.hris.issues.retrieve("id");
-## Hris LinkToken +## Crm SyncStatus -
client.hris.linkToken.create({ ...params }) -> Merge.LinkToken +
client.crm.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
@@ -16600,7 +16658,7 @@ await client.hris.issues.retrieve("id");
-Creates a link token to be used when linking a new end user. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -16616,12 +16674,7 @@ Creates a link token to be used when linking a new end user.
```typescript -await client.hris.linkToken.create({ - endUserEmailAddress: "example@gmail.com", - endUserOrganizationName: "Test Organization", - endUserOriginId: "12345", - categories: ["hris", "ats"], -}); +await client.crm.syncStatus.list(); ```
@@ -16637,7 +16690,7 @@ await client.hris.linkToken.create({
-**request:** `Merge.hris.EndUserDetailsRequest` +**request:** `Merge.crm.SyncStatusListRequest`
@@ -16645,7 +16698,7 @@ await client.hris.linkToken.create({
-**requestOptions:** `LinkToken.RequestOptions` +**requestOptions:** `SyncStatus.RequestOptions`
@@ -16656,9 +16709,9 @@ await client.hris.linkToken.create({
-## Hris LinkedAccounts +## Crm ForceResync -
client.hris.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList +
client.crm.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
@@ -16670,7 +16723,7 @@ await client.hris.linkToken.create({
-List linked accounts for your organization. +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -16686,7 +16739,7 @@ List linked accounts for your organization.
```typescript -await client.hris.linkedAccounts.list(); +await client.crm.forceResync.syncStatusResyncCreate(); ```
@@ -16702,15 +16755,7 @@ await client.hris.linkedAccounts.list();
-**request:** `Merge.hris.LinkedAccountsListRequest` - -
-
- -
-
- -**requestOptions:** `LinkedAccounts.RequestOptions` +**requestOptions:** `ForceResync.RequestOptions`
@@ -16721,9 +16766,9 @@ await client.hris.linkedAccounts.list();
-## Hris Locations +## Crm Tasks -
client.hris.locations.list({ ...params }) -> Merge.PaginatedLocationList +
client.crm.tasks.list({ ...params }) -> Merge.PaginatedTaskList
@@ -16735,7 +16780,7 @@ await client.hris.linkedAccounts.list();
-Returns a list of `Location` objects. +Returns a list of `Task` objects.
@@ -16751,7 +16796,7 @@ Returns a list of `Location` objects.
```typescript -await client.hris.locations.list(); +await client.crm.tasks.list(); ```
@@ -16767,7 +16812,7 @@ await client.hris.locations.list();
-**request:** `Merge.hris.LocationsListRequest` +**request:** `Merge.crm.TasksListRequest`
@@ -16775,7 +16820,7 @@ await client.hris.locations.list();
-**requestOptions:** `Locations.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -16786,7 +16831,7 @@ await client.hris.locations.list();
-
client.hris.locations.retrieve(id, { ...params }) -> Merge.Location +
client.crm.tasks.create({ ...params }) -> Merge.TaskResponse
@@ -16798,7 +16843,7 @@ await client.hris.locations.list();
-Returns a `Location` object with the given `id`. +Creates a `Task` object with the given values.
@@ -16814,7 +16859,9 @@ Returns a `Location` object with the given `id`.
```typescript -await client.hris.locations.retrieve("id"); +await client.crm.tasks.create({ + model: {}, +}); ```
@@ -16830,15 +16877,7 @@ await client.hris.locations.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.LocationsRetrieveRequest` +**request:** `Merge.crm.TaskEndpointRequest`
@@ -16846,7 +16885,7 @@ await client.hris.locations.retrieve("id");
-**requestOptions:** `Locations.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -16857,9 +16896,7 @@ await client.hris.locations.retrieve("id");
-## Hris Passthrough - -
client.hris.passthrough.create({ ...params }) -> Merge.RemoteResponse +
client.crm.tasks.retrieve(id, { ...params }) -> Merge.Task
@@ -16871,7 +16908,7 @@ await client.hris.locations.retrieve("id");
-Pull data from an endpoint not currently supported by Merge. +Returns a `Task` object with the given `id`.
@@ -16887,10 +16924,7 @@ Pull data from an endpoint not currently supported by Merge.
```typescript -await client.hris.passthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.crm.tasks.retrieve("id"); ```
@@ -16906,7 +16940,7 @@ await client.hris.passthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**id:** `string`
@@ -16914,7 +16948,15 @@ await client.hris.passthrough.create({
-**requestOptions:** `Passthrough.RequestOptions` +**request:** `Merge.crm.TasksRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Tasks.RequestOptions`
@@ -16925,9 +16967,7 @@ await client.hris.passthrough.create({
-## Hris PayGroups - -
client.hris.payGroups.list({ ...params }) -> Merge.PaginatedPayGroupList +
client.crm.tasks.partialUpdate(id, { ...params }) -> Merge.TaskResponse
@@ -16939,7 +16979,7 @@ await client.hris.passthrough.create({
-Returns a list of `PayGroup` objects. +Updates a `Task` object with the given `id`.
@@ -16955,7 +16995,9 @@ Returns a list of `PayGroup` objects.
```typescript -await client.hris.payGroups.list(); +await client.crm.tasks.partialUpdate("id", { + model: {}, +}); ```
@@ -16971,7 +17013,7 @@ await client.hris.payGroups.list();
-**request:** `Merge.hris.PayGroupsListRequest` +**id:** `string`
@@ -16979,7 +17021,15 @@ await client.hris.payGroups.list();
-**requestOptions:** `PayGroups.RequestOptions` +**request:** `Merge.crm.PatchedTaskEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Tasks.RequestOptions`
@@ -16990,7 +17040,7 @@ await client.hris.payGroups.list();
-
client.hris.payGroups.retrieve(id, { ...params }) -> Merge.PayGroup +
client.crm.tasks.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -17002,7 +17052,7 @@ await client.hris.payGroups.list();
-Returns a `PayGroup` object with the given `id`. +Returns metadata for `Task` PATCHs.
@@ -17018,7 +17068,7 @@ Returns a `PayGroup` object with the given `id`.
```typescript -await client.hris.payGroups.retrieve("id"); +await client.crm.tasks.metaPatchRetrieve("id"); ```
@@ -17042,15 +17092,7 @@ await client.hris.payGroups.retrieve("id");
-**request:** `Merge.hris.PayGroupsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `PayGroups.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -17061,9 +17103,7 @@ await client.hris.payGroups.retrieve("id");
-## Hris PayrollRuns - -
client.hris.payrollRuns.list({ ...params }) -> Merge.PaginatedPayrollRunList +
client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse
@@ -17075,7 +17115,7 @@ await client.hris.payGroups.retrieve("id");
-Returns a list of `PayrollRun` objects. +Returns metadata for `Task` POSTs.
@@ -17091,7 +17131,7 @@ Returns a list of `PayrollRun` objects.
```typescript -await client.hris.payrollRuns.list(); +await client.crm.tasks.metaPostRetrieve(); ```
@@ -17107,15 +17147,7 @@ await client.hris.payrollRuns.list();
-**request:** `Merge.hris.PayrollRunsListRequest` - -
-
- -
-
- -**requestOptions:** `PayrollRuns.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -17126,7 +17158,7 @@ await client.hris.payrollRuns.list();
-
client.hris.payrollRuns.retrieve(id, { ...params }) -> Merge.PayrollRun +
client.crm.tasks.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -17138,7 +17170,7 @@ await client.hris.payrollRuns.list();
-Returns a `PayrollRun` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -17154,7 +17186,7 @@ Returns a `PayrollRun` object with the given `id`.
```typescript -await client.hris.payrollRuns.retrieve("id"); +await client.crm.tasks.remoteFieldClassesList(); ```
@@ -17170,15 +17202,7 @@ await client.hris.payrollRuns.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.PayrollRunsRetrieveRequest` +**request:** `Merge.crm.TasksRemoteFieldClassesListRequest`
@@ -17186,7 +17210,7 @@ await client.hris.payrollRuns.retrieve("id");
-**requestOptions:** `PayrollRuns.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -17197,9 +17221,9 @@ await client.hris.payrollRuns.retrieve("id");
-## Hris RegenerateKey +## Crm Users -
client.hris.regenerateKey.create({ ...params }) -> Merge.RemoteKey +
client.crm.users.list({ ...params }) -> Merge.PaginatedUserList
@@ -17211,7 +17235,7 @@ await client.hris.payrollRuns.retrieve("id");
-Exchange remote keys. +Returns a list of `User` objects.
@@ -17227,9 +17251,7 @@ Exchange remote keys.
```typescript -await client.hris.regenerateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.crm.users.list(); ```
@@ -17245,7 +17267,7 @@ await client.hris.regenerateKey.create({
-**request:** `Merge.hris.RemoteKeyForRegenerationRequest` +**request:** `Merge.crm.UsersListRequest`
@@ -17253,7 +17275,7 @@ await client.hris.regenerateKey.create({
-**requestOptions:** `RegenerateKey.RequestOptions` +**requestOptions:** `Users.RequestOptions`
@@ -17264,9 +17286,7 @@ await client.hris.regenerateKey.create({
-## Hris SyncStatus - -
client.hris.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList +
client.crm.users.retrieve(id, { ...params }) -> Merge.User
@@ -17278,7 +17298,7 @@ await client.hris.regenerateKey.create({
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +Returns a `User` object with the given `id`.
@@ -17294,7 +17314,7 @@ Get sync status for the current sync and the most recently finished sync. `last_
```typescript -await client.hris.syncStatus.list(); +await client.crm.users.retrieve("id"); ```
@@ -17310,7 +17330,7 @@ await client.hris.syncStatus.list();
-**request:** `Merge.hris.SyncStatusListRequest` +**id:** `string`
@@ -17318,7 +17338,15 @@ await client.hris.syncStatus.list();
-**requestOptions:** `SyncStatus.RequestOptions` +**request:** `Merge.crm.UsersRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions`
@@ -17329,9 +17357,7 @@ await client.hris.syncStatus.list();
-## Hris ForceResync - -
client.hris.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[] +
client.crm.users.ignoreCreate(modelId, { ...params }) -> void
@@ -17343,7 +17369,7 @@ await client.hris.syncStatus.list();
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +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.
@@ -17359,7 +17385,9 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```typescript -await client.hris.forceResync.syncStatusResyncCreate(); +await client.crm.users.ignoreCreate("model_id", { + reason: "GENERAL_CUSTOMER_REQUEST", +}); ```
@@ -17375,20 +17403,34 @@ await client.hris.forceResync.syncStatusResyncCreate();
-**requestOptions:** `ForceResync.RequestOptions` +**modelId:** `string`
+ +
+
+ +**request:** `Merge.IgnoreCommonModelRequest` +
+
+
+ +**requestOptions:** `Users.RequestOptions` + +
+
-
-## Hris Teams + + +
-
client.hris.teams.list({ ...params }) -> Merge.PaginatedTeamList +
client.crm.users.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -17400,7 +17442,7 @@ await client.hris.forceResync.syncStatusResyncCreate();
-Returns a list of `Team` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -17416,7 +17458,7 @@ Returns a list of `Team` objects.
```typescript -await client.hris.teams.list(); +await client.crm.users.remoteFieldClassesList(); ```
@@ -17432,7 +17474,7 @@ await client.hris.teams.list();
-**request:** `Merge.hris.TeamsListRequest` +**request:** `Merge.crm.UsersRemoteFieldClassesListRequest`
@@ -17440,7 +17482,7 @@ await client.hris.teams.list();
-**requestOptions:** `Teams.RequestOptions` +**requestOptions:** `Users.RequestOptions`
@@ -17451,7 +17493,9 @@ await client.hris.teams.list();
-
client.hris.teams.retrieve(id, { ...params }) -> Merge.Team +## Crm WebhookReceivers + +
client.crm.webhookReceivers.list() -> Merge.WebhookReceiver[]
@@ -17463,7 +17507,7 @@ await client.hris.teams.list();
-Returns a `Team` object with the given `id`. +Returns a list of `WebhookReceiver` objects.
@@ -17479,7 +17523,7 @@ Returns a `Team` object with the given `id`.
```typescript -await client.hris.teams.retrieve("id"); +await client.crm.webhookReceivers.list(); ```
@@ -17495,23 +17539,7 @@ await client.hris.teams.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.TeamsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Teams.RequestOptions` +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -17522,9 +17550,7 @@ await client.hris.teams.retrieve("id");
-## Hris TimeOff - -
client.hris.timeOff.list({ ...params }) -> Merge.PaginatedTimeOffList +
client.crm.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
@@ -17536,7 +17562,7 @@ await client.hris.teams.retrieve("id");
-Returns a list of `TimeOff` objects. +Creates a `WebhookReceiver` object with the given values.
@@ -17552,7 +17578,10 @@ Returns a list of `TimeOff` objects.
```typescript -await client.hris.timeOff.list(); +await client.crm.webhookReceivers.create({ + event: "event", + isActive: true, +}); ```
@@ -17568,7 +17597,7 @@ await client.hris.timeOff.list();
-**request:** `Merge.hris.TimeOffListRequest` +**request:** `Merge.crm.WebhookReceiverRequest`
@@ -17576,7 +17605,7 @@ await client.hris.timeOff.list();
-**requestOptions:** `TimeOff.RequestOptions` +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -17587,7 +17616,9 @@ await client.hris.timeOff.list();
-
client.hris.timeOff.create({ ...params }) -> Merge.TimeOffResponse +## Ats AccountDetails + +
client.ats.accountDetails.retrieve() -> Merge.AccountDetails
@@ -17599,7 +17630,7 @@ await client.hris.timeOff.list();
-Creates a `TimeOff` object with the given values. +Get details for a linked account.
@@ -17615,9 +17646,7 @@ Creates a `TimeOff` object with the given values.
```typescript -await client.hris.timeOff.create({ - model: {}, -}); +await client.ats.accountDetails.retrieve(); ```
@@ -17633,15 +17662,7 @@ await client.hris.timeOff.create({
-**request:** `Merge.hris.TimeOffEndpointRequest` - -
-
- -
-
- -**requestOptions:** `TimeOff.RequestOptions` +**requestOptions:** `AccountDetails.RequestOptions`
@@ -17652,7 +17673,9 @@ await client.hris.timeOff.create({
-
client.hris.timeOff.retrieve(id, { ...params }) -> Merge.TimeOff +## Ats AccountToken + +
client.ats.accountToken.retrieve(publicToken) -> Merge.AccountToken
@@ -17664,7 +17687,7 @@ await client.hris.timeOff.create({
-Returns a `TimeOff` object with the given `id`. +Returns the account token for the end user with the provided public token.
@@ -17680,7 +17703,7 @@ Returns a `TimeOff` object with the given `id`.
```typescript -await client.hris.timeOff.retrieve("id"); +await client.ats.accountToken.retrieve("public_token"); ```
@@ -17696,15 +17719,7 @@ await client.hris.timeOff.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.TimeOffRetrieveRequest` +**publicToken:** `string`
@@ -17712,7 +17727,7 @@ await client.hris.timeOff.retrieve("id");
-**requestOptions:** `TimeOff.RequestOptions` +**requestOptions:** `AccountToken.RequestOptions`
@@ -17723,7 +17738,9 @@ await client.hris.timeOff.retrieve("id");
-
client.hris.timeOff.metaPostRetrieve() -> Merge.MetaResponse +## Ats Activities + +
client.ats.activities.list({ ...params }) -> Merge.PaginatedActivityList
@@ -17735,7 +17752,7 @@ await client.hris.timeOff.retrieve("id");
-Returns metadata for `TimeOff` POSTs. +Returns a list of `Activity` objects.
@@ -17751,7 +17768,7 @@ Returns metadata for `TimeOff` POSTs.
```typescript -await client.hris.timeOff.metaPostRetrieve(); +await client.ats.activities.list(); ```
@@ -17767,7 +17784,15 @@ await client.hris.timeOff.metaPostRetrieve();
-**requestOptions:** `TimeOff.RequestOptions` +**request:** `Merge.ats.ActivitiesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Activities.RequestOptions`
@@ -17778,9 +17803,7 @@ await client.hris.timeOff.metaPostRetrieve();
-## Hris TimeOffBalances - -
client.hris.timeOffBalances.list({ ...params }) -> Merge.PaginatedTimeOffBalanceList +
client.ats.activities.create({ ...params }) -> Merge.ActivityResponse
@@ -17792,7 +17815,7 @@ await client.hris.timeOff.metaPostRetrieve();
-Returns a list of `TimeOffBalance` objects. +Creates an `Activity` object with the given values.
@@ -17808,7 +17831,10 @@ Returns a list of `TimeOffBalance` objects.
```typescript -await client.hris.timeOffBalances.list(); +await client.ats.activities.create({ + model: {}, + remoteUserId: "remote_user_id", +}); ```
@@ -17824,7 +17850,7 @@ await client.hris.timeOffBalances.list();
-**request:** `Merge.hris.TimeOffBalancesListRequest` +**request:** `Merge.ats.ActivityEndpointRequest`
@@ -17832,7 +17858,7 @@ await client.hris.timeOffBalances.list();
-**requestOptions:** `TimeOffBalances.RequestOptions` +**requestOptions:** `Activities.RequestOptions`
@@ -17843,7 +17869,7 @@ await client.hris.timeOffBalances.list();
-
client.hris.timeOffBalances.retrieve(id, { ...params }) -> Merge.TimeOffBalance +
client.ats.activities.retrieve(id, { ...params }) -> Merge.Activity
@@ -17855,7 +17881,7 @@ await client.hris.timeOffBalances.list();
-Returns a `TimeOffBalance` object with the given `id`. +Returns an `Activity` object with the given `id`.
@@ -17871,7 +17897,7 @@ Returns a `TimeOffBalance` object with the given `id`.
```typescript -await client.hris.timeOffBalances.retrieve("id"); +await client.ats.activities.retrieve("id"); ```
@@ -17895,7 +17921,7 @@ await client.hris.timeOffBalances.retrieve("id");
-**request:** `Merge.hris.TimeOffBalancesRetrieveRequest` +**request:** `Merge.ats.ActivitiesRetrieveRequest`
@@ -17903,7 +17929,7 @@ await client.hris.timeOffBalances.retrieve("id");
-**requestOptions:** `TimeOffBalances.RequestOptions` +**requestOptions:** `Activities.RequestOptions`
@@ -17914,9 +17940,7 @@ await client.hris.timeOffBalances.retrieve("id");
-## Hris TimesheetEntries - -
client.hris.timesheetEntries.list({ ...params }) -> Merge.PaginatedTimesheetEntryList +
client.ats.activities.metaPostRetrieve() -> Merge.MetaResponse
@@ -17928,7 +17952,7 @@ await client.hris.timeOffBalances.retrieve("id");
-Returns a list of `TimesheetEntry` objects. +Returns metadata for `Activity` POSTs.
@@ -17944,7 +17968,7 @@ Returns a list of `TimesheetEntry` objects.
```typescript -await client.hris.timesheetEntries.list(); +await client.ats.activities.metaPostRetrieve(); ```
@@ -17960,15 +17984,7 @@ await client.hris.timesheetEntries.list();
-**request:** `Merge.hris.TimesheetEntriesListRequest` - -
-
- -
-
- -**requestOptions:** `TimesheetEntries.RequestOptions` +**requestOptions:** `Activities.RequestOptions`
@@ -17979,7 +17995,9 @@ await client.hris.timesheetEntries.list();
-
client.hris.timesheetEntries.create({ ...params }) -> Merge.TimesheetEntryResponse +## Ats Applications + +
client.ats.applications.list({ ...params }) -> Merge.PaginatedApplicationList
@@ -17991,7 +18009,7 @@ await client.hris.timesheetEntries.list();
-Creates a `TimesheetEntry` object with the given values. +Returns a list of `Application` objects.
@@ -18007,9 +18025,7 @@ Creates a `TimesheetEntry` object with the given values.
```typescript -await client.hris.timesheetEntries.create({ - model: {}, -}); +await client.ats.applications.list(); ```
@@ -18025,7 +18041,7 @@ await client.hris.timesheetEntries.create({
-**request:** `Merge.hris.TimesheetEntryEndpointRequest` +**request:** `Merge.ats.ApplicationsListRequest`
@@ -18033,7 +18049,7 @@ await client.hris.timesheetEntries.create({
-**requestOptions:** `TimesheetEntries.RequestOptions` +**requestOptions:** `Applications.RequestOptions`
@@ -18044,7 +18060,7 @@ await client.hris.timesheetEntries.create({
-
client.hris.timesheetEntries.retrieve(id, { ...params }) -> Merge.TimesheetEntry +
client.ats.applications.create({ ...params }) -> Merge.ApplicationResponse
@@ -18056,7 +18072,10 @@ await client.hris.timesheetEntries.create({
-Returns a `TimesheetEntry` object with the given `id`. +Creates an `Application` object with the given values. +For certain integrations, but not all, our API detects duplicate candidates and will associate applications with existing records in the third-party. New candidates are created and automatically linked to the application. + +See our [Help Center article](https://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024) for detailed support per integration.
@@ -18072,7 +18091,10 @@ Returns a `TimesheetEntry` object with the given `id`.
```typescript -await client.hris.timesheetEntries.retrieve("id"); +await client.ats.applications.create({ + model: {}, + remoteUserId: "remote_user_id", +}); ```
@@ -18088,15 +18110,7 @@ await client.hris.timesheetEntries.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.hris.TimesheetEntriesRetrieveRequest` +**request:** `Merge.ats.ApplicationEndpointRequest`
@@ -18104,7 +18118,7 @@ await client.hris.timesheetEntries.retrieve("id");
-**requestOptions:** `TimesheetEntries.RequestOptions` +**requestOptions:** `Applications.RequestOptions`
@@ -18115,7 +18129,7 @@ await client.hris.timesheetEntries.retrieve("id");
-
client.hris.timesheetEntries.metaPostRetrieve() -> Merge.MetaResponse +
client.ats.applications.retrieve(id, { ...params }) -> Merge.Application
@@ -18127,7 +18141,7 @@ await client.hris.timesheetEntries.retrieve("id");
-Returns metadata for `TimesheetEntry` POSTs. +Returns an `Application` object with the given `id`.
@@ -18143,7 +18157,7 @@ Returns metadata for `TimesheetEntry` POSTs.
```typescript -await client.hris.timesheetEntries.metaPostRetrieve(); +await client.ats.applications.retrieve("id"); ```
@@ -18159,7 +18173,23 @@ await client.hris.timesheetEntries.metaPostRetrieve();
-**requestOptions:** `TimesheetEntries.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.ats.ApplicationsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Applications.RequestOptions`
@@ -18170,9 +18200,7 @@ await client.hris.timesheetEntries.metaPostRetrieve();
-## Hris WebhookReceivers - -
client.hris.webhookReceivers.list() -> Merge.WebhookReceiver[] +
client.ats.applications.changeStageCreate(id, { ...params }) -> Merge.ApplicationResponse
@@ -18184,7 +18212,7 @@ await client.hris.timesheetEntries.metaPostRetrieve();
-Returns a list of `WebhookReceiver` objects. +Updates the `current_stage` field of an `Application` object
@@ -18200,7 +18228,7 @@ Returns a list of `WebhookReceiver` objects.
```typescript -await client.hris.webhookReceivers.list(); +await client.ats.applications.changeStageCreate("id"); ```
@@ -18216,7 +18244,23 @@ await client.hris.webhookReceivers.list();
-**requestOptions:** `WebhookReceivers.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.ats.UpdateApplicationStageRequest` + +
+
+ +
+
+ +**requestOptions:** `Applications.RequestOptions`
@@ -18227,7 +18271,7 @@ await client.hris.webhookReceivers.list();
-
client.hris.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver +
client.ats.applications.metaPostRetrieve({ ...params }) -> Merge.MetaResponse
@@ -18239,7 +18283,7 @@ await client.hris.webhookReceivers.list();
-Creates a `WebhookReceiver` object with the given values. +Returns metadata for `Application` POSTs.
@@ -18255,10 +18299,7 @@ Creates a `WebhookReceiver` object with the given values.
```typescript -await client.hris.webhookReceivers.create({ - event: "event", - isActive: true, -}); +await client.ats.applications.metaPostRetrieve(); ```
@@ -18274,7 +18315,7 @@ await client.hris.webhookReceivers.create({
-**request:** `Merge.hris.WebhookReceiverRequest` +**request:** `Merge.ats.ApplicationsMetaPostRetrieveRequest`
@@ -18282,7 +18323,7 @@ await client.hris.webhookReceivers.create({
-**requestOptions:** `WebhookReceivers.RequestOptions` +**requestOptions:** `Applications.RequestOptions`
@@ -18293,9 +18334,9 @@ await client.hris.webhookReceivers.create({
-## Ticketing AccountDetails +## Ats AsyncPassthrough -
client.ticketing.accountDetails.retrieve() -> Merge.AccountDetails +
client.ats.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
@@ -18307,7 +18348,7 @@ await client.hris.webhookReceivers.create({
-Get details for a linked account. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -18323,7 +18364,10 @@ Get details for a linked account.
```typescript -await client.ticketing.accountDetails.retrieve(); +await client.ats.asyncPassthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -18339,7 +18383,15 @@ await client.ticketing.accountDetails.retrieve();
-**requestOptions:** `AccountDetails.RequestOptions` +**request:** `Merge.DataPassthroughRequest` + +
+
+ +
+
+ +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -18350,9 +18402,7 @@ await client.ticketing.accountDetails.retrieve();
-## Ticketing AccountToken - -
client.ticketing.accountToken.retrieve(publicToken) -> Merge.AccountToken +
client.ats.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
@@ -18364,7 +18414,7 @@ await client.ticketing.accountDetails.retrieve();
-Returns the account token for the end user with the provided public token. +Retrieves data from earlier async-passthrough POST request
@@ -18380,7 +18430,7 @@ Returns the account token for the end user with the provided public token.
```typescript -await client.ticketing.accountToken.retrieve("public_token"); +await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
@@ -18396,7 +18446,7 @@ await client.ticketing.accountToken.retrieve("public_token");
-**publicToken:** `string` +**asyncPassthroughReceiptId:** `string`
@@ -18404,7 +18454,7 @@ await client.ticketing.accountToken.retrieve("public_token");
-**requestOptions:** `AccountToken.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -18415,9 +18465,9 @@ await client.ticketing.accountToken.retrieve("public_token");
-## Ticketing Accounts +## Ats Attachments -
client.ticketing.accounts.list({ ...params }) -> Merge.PaginatedAccountList +
client.ats.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList
@@ -18429,7 +18479,7 @@ await client.ticketing.accountToken.retrieve("public_token");
-Returns a list of `Account` objects. +Returns a list of `Attachment` objects.
@@ -18445,7 +18495,7 @@ Returns a list of `Account` objects.
```typescript -await client.ticketing.accounts.list(); +await client.ats.attachments.list(); ```
@@ -18461,7 +18511,7 @@ await client.ticketing.accounts.list();
-**request:** `Merge.ticketing.AccountsListRequest` +**request:** `Merge.ats.AttachmentsListRequest`
@@ -18469,7 +18519,7 @@ await client.ticketing.accounts.list();
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -18480,7 +18530,7 @@ await client.ticketing.accounts.list();
-
client.ticketing.accounts.retrieve(id, { ...params }) -> Merge.Account +
client.ats.attachments.create({ ...params }) -> Merge.AttachmentResponse
@@ -18492,7 +18542,7 @@ await client.ticketing.accounts.list();
-Returns an `Account` object with the given `id`. +Creates an `Attachment` object with the given values.
@@ -18508,7 +18558,10 @@ Returns an `Account` object with the given `id`.
```typescript -await client.ticketing.accounts.retrieve("id"); +await client.ats.attachments.create({ + model: {}, + remoteUserId: "remote_user_id", +}); ```
@@ -18524,15 +18577,7 @@ await client.ticketing.accounts.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.AccountsRetrieveRequest` +**request:** `Merge.ats.AttachmentEndpointRequest`
@@ -18540,7 +18585,7 @@ await client.ticketing.accounts.retrieve("id");
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -18551,9 +18596,7 @@ await client.ticketing.accounts.retrieve("id");
-## Ticketing AsyncPassthrough - -
client.ticketing.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept +
client.ats.attachments.retrieve(id, { ...params }) -> Merge.Attachment
@@ -18565,7 +18608,7 @@ await client.ticketing.accounts.retrieve("id");
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns an `Attachment` object with the given `id`.
@@ -18581,10 +18624,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```typescript -await client.ticketing.asyncPassthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.ats.attachments.retrieve("id"); ```
@@ -18600,7 +18640,7 @@ await client.ticketing.asyncPassthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**id:** `string`
@@ -18608,7 +18648,15 @@ await client.ticketing.asyncPassthrough.create({
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**request:** `Merge.ats.AttachmentsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Attachments.RequestOptions`
@@ -18619,7 +18667,7 @@ await client.ticketing.asyncPassthrough.create({
-
client.ticketing.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse +
client.ats.attachments.metaPostRetrieve() -> Merge.MetaResponse
@@ -18631,7 +18679,7 @@ await client.ticketing.asyncPassthrough.create({
-Retrieves data from earlier async-passthrough POST request +Returns metadata for `Attachment` POSTs.
@@ -18647,7 +18695,7 @@ Retrieves data from earlier async-passthrough POST request
```typescript -await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id"); +await client.ats.attachments.metaPostRetrieve(); ```
@@ -18663,15 +18711,7 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
-**asyncPassthroughReceiptId:** `string` - -
-
- -
-
- -**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -18682,9 +18722,9 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
-## Ticketing Attachments +## Ats AuditTrail -
client.ticketing.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList +
client.ats.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
@@ -18696,7 +18736,7 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
-Returns a list of `Attachment` objects. +Gets a list of audit trail events.
@@ -18712,7 +18752,7 @@ Returns a list of `Attachment` objects.
```typescript -await client.ticketing.attachments.list(); +await client.ats.auditTrail.list(); ```
@@ -18728,7 +18768,7 @@ await client.ticketing.attachments.list();
-**request:** `Merge.ticketing.AttachmentsListRequest` +**request:** `Merge.ats.AuditTrailListRequest`
@@ -18736,7 +18776,7 @@ await client.ticketing.attachments.list();
-**requestOptions:** `Attachments.RequestOptions` +**requestOptions:** `AuditTrail.RequestOptions`
@@ -18747,7 +18787,9 @@ await client.ticketing.attachments.list();
-
client.ticketing.attachments.create({ ...params }) -> Merge.TicketingAttachmentResponse +## Ats AvailableActions + +
client.ats.availableActions.retrieve() -> Merge.AvailableActions
@@ -18759,7 +18801,7 @@ await client.ticketing.attachments.list();
-Creates an `Attachment` object with the given values. +Returns a list of models and actions available for an account.
@@ -18775,9 +18817,7 @@ Creates an `Attachment` object with the given values.
```typescript -await client.ticketing.attachments.create({ - model: {}, -}); +await client.ats.availableActions.retrieve(); ```
@@ -18793,15 +18833,7 @@ await client.ticketing.attachments.create({
-**request:** `Merge.ticketing.TicketingAttachmentEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Attachments.RequestOptions` +**requestOptions:** `AvailableActions.RequestOptions`
@@ -18812,7 +18844,9 @@ await client.ticketing.attachments.create({
-
client.ticketing.attachments.retrieve(id, { ...params }) -> Merge.Attachment +## Ats Candidates + +
client.ats.candidates.list({ ...params }) -> Merge.PaginatedCandidateList
@@ -18824,7 +18858,7 @@ await client.ticketing.attachments.create({
-Returns an `Attachment` object with the given `id`. +Returns a list of `Candidate` objects.
@@ -18840,7 +18874,7 @@ Returns an `Attachment` object with the given `id`.
```typescript -await client.ticketing.attachments.retrieve("id"); +await client.ats.candidates.list(); ```
@@ -18856,15 +18890,7 @@ await client.ticketing.attachments.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.AttachmentsRetrieveRequest` +**request:** `Merge.ats.CandidatesListRequest`
@@ -18872,7 +18898,7 @@ await client.ticketing.attachments.retrieve("id");
-**requestOptions:** `Attachments.RequestOptions` +**requestOptions:** `Candidates.RequestOptions`
@@ -18883,7 +18909,7 @@ await client.ticketing.attachments.retrieve("id");
-
client.ticketing.attachments.metaPostRetrieve() -> Merge.MetaResponse +
client.ats.candidates.create({ ...params }) -> Merge.CandidateResponse
@@ -18895,7 +18921,7 @@ await client.ticketing.attachments.retrieve("id");
-Returns metadata for `TicketingAttachment` POSTs. +Creates a `Candidate` object with the given values.
@@ -18911,7 +18937,10 @@ Returns metadata for `TicketingAttachment` POSTs.
```typescript -await client.ticketing.attachments.metaPostRetrieve(); +await client.ats.candidates.create({ + model: {}, + remoteUserId: "remote_user_id", +}); ```
@@ -18927,7 +18956,15 @@ await client.ticketing.attachments.metaPostRetrieve();
-**requestOptions:** `Attachments.RequestOptions` +**request:** `Merge.ats.CandidateEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Candidates.RequestOptions`
@@ -18938,9 +18975,7 @@ await client.ticketing.attachments.metaPostRetrieve();
-## Ticketing AuditTrail - -
client.ticketing.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList +
client.ats.candidates.retrieve(id, { ...params }) -> Merge.Candidate
@@ -18952,7 +18987,7 @@ await client.ticketing.attachments.metaPostRetrieve();
-Gets a list of audit trail events. +Returns a `Candidate` object with the given `id`.
@@ -18968,7 +19003,7 @@ Gets a list of audit trail events.
```typescript -await client.ticketing.auditTrail.list(); +await client.ats.candidates.retrieve("id"); ```
@@ -18984,7 +19019,7 @@ await client.ticketing.auditTrail.list();
-**request:** `Merge.ticketing.AuditTrailListRequest` +**id:** `string`
@@ -18992,7 +19027,15 @@ await client.ticketing.auditTrail.list();
-**requestOptions:** `AuditTrail.RequestOptions` +**request:** `Merge.ats.CandidatesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Candidates.RequestOptions`
@@ -19003,9 +19046,7 @@ await client.ticketing.auditTrail.list();
-## Ticketing AvailableActions - -
client.ticketing.availableActions.retrieve() -> Merge.AvailableActions +
client.ats.candidates.partialUpdate(id, { ...params }) -> Merge.CandidateResponse
@@ -19017,7 +19058,7 @@ await client.ticketing.auditTrail.list();
-Returns a list of models and actions available for an account. +Updates a `Candidate` object with the given `id`.
@@ -19033,7 +19074,10 @@ Returns a list of models and actions available for an account.
```typescript -await client.ticketing.availableActions.retrieve(); +await client.ats.candidates.partialUpdate("id", { + model: {}, + remoteUserId: "remote_user_id", +}); ```
@@ -19049,20 +19093,34 @@ await client.ticketing.availableActions.retrieve();
-**requestOptions:** `AvailableActions.RequestOptions` +**id:** `string`
+ +
+
+ +**request:** `Merge.ats.PatchedCandidateEndpointRequest` +
+
+
+ +**requestOptions:** `Candidates.RequestOptions` + +
+
-
-## Ticketing Collections + + +
-
client.ticketing.collections.list({ ...params }) -> Merge.PaginatedCollectionList +
client.ats.candidates.ignoreCreate(modelId, { ...params }) -> void
@@ -19074,7 +19132,7 @@ await client.ticketing.availableActions.retrieve();
-Returns a list of `Collection` 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.
@@ -19090,7 +19148,9 @@ Returns a list of `Collection` objects.
```typescript -await client.ticketing.collections.list(); +await client.ats.candidates.ignoreCreate("model_id", { + reason: "GENERAL_CUSTOMER_REQUEST", +}); ```
@@ -19106,7 +19166,7 @@ await client.ticketing.collections.list();
-**request:** `Merge.ticketing.CollectionsListRequest` +**modelId:** `string`
@@ -19114,7 +19174,15 @@ await client.ticketing.collections.list();
-**requestOptions:** `Collections.RequestOptions` +**request:** `Merge.ats.IgnoreCommonModelRequest` + +
+
+ +
+
+ +**requestOptions:** `Candidates.RequestOptions`
@@ -19125,7 +19193,7 @@ await client.ticketing.collections.list();
-
client.ticketing.collections.viewersList(collectionId, { ...params }) -> Merge.PaginatedViewerList +
client.ats.candidates.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -19137,7 +19205,7 @@ await client.ticketing.collections.list();
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) +Returns metadata for `Candidate` PATCHs.
@@ -19153,7 +19221,7 @@ Returns a list of `Viewer` objects that point to a User id or Team id that is ei
```typescript -await client.ticketing.collections.viewersList("collection_id"); +await client.ats.candidates.metaPatchRetrieve("id"); ```
@@ -19169,15 +19237,7 @@ await client.ticketing.collections.viewersList("collection_id");
-**collectionId:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.CollectionsViewersListRequest` +**id:** `string`
@@ -19185,7 +19245,7 @@ await client.ticketing.collections.viewersList("collection_id");
-**requestOptions:** `Collections.RequestOptions` +**requestOptions:** `Candidates.RequestOptions`
@@ -19196,7 +19256,7 @@ await client.ticketing.collections.viewersList("collection_id");
-
client.ticketing.collections.retrieve(id, { ...params }) -> Merge.Collection +
client.ats.candidates.metaPostRetrieve() -> Merge.MetaResponse
@@ -19208,7 +19268,7 @@ await client.ticketing.collections.viewersList("collection_id");
-Returns a `Collection` object with the given `id`. +Returns metadata for `Candidate` POSTs.
@@ -19224,7 +19284,7 @@ Returns a `Collection` object with the given `id`.
```typescript -await client.ticketing.collections.retrieve("id"); +await client.ats.candidates.metaPostRetrieve(); ```
@@ -19240,23 +19300,7 @@ await client.ticketing.collections.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.CollectionsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Collections.RequestOptions` +**requestOptions:** `Candidates.RequestOptions`
@@ -19267,9 +19311,9 @@ await client.ticketing.collections.retrieve("id");
-## Ticketing Comments +## Ats Scopes -
client.ticketing.comments.list({ ...params }) -> Merge.PaginatedCommentList +
client.ats.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -19281,7 +19325,7 @@ await client.ticketing.collections.retrieve("id");
-Returns a list of `Comment` objects. +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).
@@ -19297,7 +19341,7 @@ Returns a list of `Comment` objects.
```typescript -await client.ticketing.comments.list(); +await client.ats.scopes.defaultScopesRetrieve(); ```
@@ -19313,15 +19357,7 @@ await client.ticketing.comments.list();
-**request:** `Merge.ticketing.CommentsListRequest` - -
-
- -
-
- -**requestOptions:** `Comments.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -19332,7 +19368,7 @@ await client.ticketing.comments.list();
-
client.ticketing.comments.create({ ...params }) -> Merge.CommentResponse +
client.ats.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -19344,7 +19380,7 @@ await client.ticketing.comments.list();
-Creates a `Comment` object with the given values. +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).
@@ -19360,9 +19396,7 @@ Creates a `Comment` object with the given values.
```typescript -await client.ticketing.comments.create({ - model: {}, -}); +await client.ats.scopes.linkedAccountScopesRetrieve(); ```
@@ -19378,15 +19412,7 @@ await client.ticketing.comments.create({
-**request:** `Merge.ticketing.CommentEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Comments.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -19397,7 +19423,7 @@ await client.ticketing.comments.create({
-
client.ticketing.comments.retrieve(id, { ...params }) -> Merge.Comment +
client.ats.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
@@ -19409,7 +19435,7 @@ await client.ticketing.comments.create({
-Returns a `Comment` object with the given `id`. +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)
@@ -19425,7 +19451,33 @@ Returns a `Comment` object with the given `id`.
```typescript -await client.ticketing.comments.retrieve("id"); +await client.ats.scopes.linkedAccountScopesCreate({ + commonModels: [ + { + modelName: "Employee", + modelPermissions: { + READ: { + isEnabled: true, + }, + WRITE: { + isEnabled: false, + }, + }, + fieldPermissions: { + enabledFields: ["avatar", "home_location"], + disabledFields: ["work_location"], + }, + }, + { + modelName: "Benefit", + modelPermissions: { + WRITE: { + isEnabled: false, + }, + }, + }, + ], +}); ```
@@ -19435,21 +19487,13 @@ await client.ticketing.comments.retrieve("id"); #### ⚙️ Parameters -
-
- -
-
- -**id:** `string` - -
-
+
+
-**request:** `Merge.ticketing.CommentsRetrieveRequest` +**request:** `Merge.ats.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -19457,7 +19501,7 @@ await client.ticketing.comments.retrieve("id");
-**requestOptions:** `Comments.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -19468,7 +19512,9 @@ await client.ticketing.comments.retrieve("id");
-
client.ticketing.comments.metaPostRetrieve() -> Merge.MetaResponse +## Ats DeleteAccount + +
client.ats.deleteAccount.delete() -> void
@@ -19480,7 +19526,7 @@ await client.ticketing.comments.retrieve("id");
-Returns metadata for `Comment` POSTs. +Delete a linked account.
@@ -19496,7 +19542,7 @@ Returns metadata for `Comment` POSTs.
```typescript -await client.ticketing.comments.metaPostRetrieve(); +await client.ats.deleteAccount.delete(); ```
@@ -19512,7 +19558,7 @@ await client.ticketing.comments.metaPostRetrieve();
-**requestOptions:** `Comments.RequestOptions` +**requestOptions:** `DeleteAccount.RequestOptions`
@@ -19523,9 +19569,9 @@ await client.ticketing.comments.metaPostRetrieve();
-## Ticketing Contacts +## Ats Departments -
client.ticketing.contacts.list({ ...params }) -> Merge.PaginatedContactList +
client.ats.departments.list({ ...params }) -> Merge.PaginatedDepartmentList
@@ -19537,7 +19583,7 @@ await client.ticketing.comments.metaPostRetrieve();
-Returns a list of `Contact` objects. +Returns a list of `Department` objects.
@@ -19553,7 +19599,7 @@ Returns a list of `Contact` objects.
```typescript -await client.ticketing.contacts.list(); +await client.ats.departments.list(); ```
@@ -19569,7 +19615,7 @@ await client.ticketing.contacts.list();
-**request:** `Merge.ticketing.ContactsListRequest` +**request:** `Merge.ats.DepartmentsListRequest`
@@ -19577,7 +19623,7 @@ await client.ticketing.contacts.list();
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Departments.RequestOptions`
@@ -19588,7 +19634,7 @@ await client.ticketing.contacts.list();
-
client.ticketing.contacts.create({ ...params }) -> Merge.TicketingContactResponse +
client.ats.departments.retrieve(id, { ...params }) -> Merge.Department
@@ -19600,7 +19646,7 @@ await client.ticketing.contacts.list();
-Creates a `Contact` object with the given values. +Returns a `Department` object with the given `id`.
@@ -19616,9 +19662,7 @@ Creates a `Contact` object with the given values.
```typescript -await client.ticketing.contacts.create({ - model: {}, -}); +await client.ats.departments.retrieve("id"); ```
@@ -19634,7 +19678,7 @@ await client.ticketing.contacts.create({
-**request:** `Merge.ticketing.TicketingContactEndpointRequest` +**id:** `string`
@@ -19642,7 +19686,15 @@ await client.ticketing.contacts.create({
-**requestOptions:** `Contacts.RequestOptions` +**request:** `Merge.ats.DepartmentsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Departments.RequestOptions`
@@ -19653,7 +19705,9 @@ await client.ticketing.contacts.create({
-
client.ticketing.contacts.retrieve(id, { ...params }) -> Merge.Contact +## Ats Eeocs + +
client.ats.eeocs.list({ ...params }) -> Merge.PaginatedEeocList
@@ -19665,7 +19719,7 @@ await client.ticketing.contacts.create({
-Returns a `Contact` object with the given `id`. +Returns a list of `EEOC` objects.
@@ -19681,7 +19735,7 @@ Returns a `Contact` object with the given `id`.
```typescript -await client.ticketing.contacts.retrieve("id"); +await client.ats.eeocs.list(); ```
@@ -19697,15 +19751,7 @@ await client.ticketing.contacts.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.ContactsRetrieveRequest` +**request:** `Merge.ats.EeocsListRequest`
@@ -19713,7 +19759,7 @@ await client.ticketing.contacts.retrieve("id");
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Eeocs.RequestOptions`
@@ -19724,7 +19770,7 @@ await client.ticketing.contacts.retrieve("id");
-
client.ticketing.contacts.metaPostRetrieve() -> Merge.MetaResponse +
client.ats.eeocs.retrieve(id, { ...params }) -> Merge.Eeoc
@@ -19736,7 +19782,7 @@ await client.ticketing.contacts.retrieve("id");
-Returns metadata for `TicketingContact` POSTs. +Returns an `EEOC` object with the given `id`.
@@ -19752,7 +19798,7 @@ Returns metadata for `TicketingContact` POSTs.
```typescript -await client.ticketing.contacts.metaPostRetrieve(); +await client.ats.eeocs.retrieve("id"); ```
@@ -19768,64 +19814,23 @@ await client.ticketing.contacts.metaPostRetrieve();
-**requestOptions:** `Contacts.RequestOptions` - -
-
- -
- - - -
- -## Ticketing Scopes - -
client.ticketing.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi -
-
- -#### 📝 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). +**id:** `string`
-
-
- -#### 🔌 Usage - -
-
-```typescript -await client.ticketing.scopes.defaultScopesRetrieve(); -``` +**request:** `Merge.ats.EeocsRetrieveRequest`
-
-
- -#### ⚙️ Parameters - -
-
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `Eeocs.RequestOptions`
@@ -19836,7 +19841,9 @@ await client.ticketing.scopes.defaultScopesRetrieve();
-
client.ticketing.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi +## Ats FieldMapping + +
client.ats.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
@@ -19848,7 +19855,7 @@ await client.ticketing.scopes.defaultScopesRetrieve();
-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). +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/).
@@ -19864,7 +19871,7 @@ Get all available permissions for Merge Common Models and fields for a single Li
```typescript -await client.ticketing.scopes.linkedAccountScopesRetrieve(); +await client.ats.fieldMapping.fieldMappingsRetrieve(); ```
@@ -19880,7 +19887,15 @@ await client.ticketing.scopes.linkedAccountScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**request:** `Merge.ats.FieldMappingsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -19891,7 +19906,7 @@ await client.ticketing.scopes.linkedAccountScopesRetrieve();
-
client.ticketing.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi +
client.ats.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
@@ -19903,7 +19918,7 @@ await client.ticketing.scopes.linkedAccountScopesRetrieve();
-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 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.
@@ -19919,32 +19934,13 @@ Update permissions for any Common Model or field for a single Linked Account. An
```typescript -await client.ticketing.scopes.linkedAccountScopesCreate({ - commonModels: [ - { - modelName: "Employee", - modelPermissions: { - READ: { - isEnabled: true, - }, - WRITE: { - isEnabled: false, - }, - }, - fieldPermissions: { - enabledFields: ["avatar", "home_location"], - disabledFields: ["work_location"], - }, - }, - { - modelName: "Benefit", - modelPermissions: { - WRITE: { - isEnabled: false, - }, - }, - }, - ], +await client.ats.fieldMapping.fieldMappingsCreate({ + targetFieldName: "example_target_field_name", + targetFieldDescription: "this is a example description of the target field", + remoteFieldTraversalPath: ["example_remote_field"], + remoteMethod: "GET", + remoteUrlPath: "/example-url-path", + commonModelName: "ExampleCommonModel", }); ``` @@ -19961,7 +19957,7 @@ await client.ticketing.scopes.linkedAccountScopesCreate({
-**request:** `Merge.ticketing.LinkedAccountCommonModelScopeDeserializerRequest` +**request:** `Merge.ats.CreateFieldMappingRequest`
@@ -19969,7 +19965,7 @@ await client.ticketing.scopes.linkedAccountScopesCreate({
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -19980,9 +19976,7 @@ await client.ticketing.scopes.linkedAccountScopesCreate({
-## Ticketing DeleteAccount - -
client.ticketing.deleteAccount.delete() -> void +
client.ats.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
@@ -19994,7 +19988,7 @@ await client.ticketing.scopes.linkedAccountScopesCreate({
-Delete a 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.
@@ -20010,7 +20004,7 @@ Delete a linked account.
```typescript -await client.ticketing.deleteAccount.delete(); +await client.ats.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
@@ -20026,7 +20020,15 @@ await client.ticketing.deleteAccount.delete();
-**requestOptions:** `DeleteAccount.RequestOptions` +**fieldMappingId:** `string` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -20037,9 +20039,7 @@ await client.ticketing.deleteAccount.delete();
-## Ticketing FieldMapping - -
client.ticketing.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse +
client.ats.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
@@ -20051,7 +20051,7 @@ await client.ticketing.deleteAccount.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/). +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.
@@ -20067,7 +20067,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```typescript -await client.ticketing.fieldMapping.fieldMappingsRetrieve(); +await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); ```
@@ -20083,7 +20083,15 @@ await client.ticketing.fieldMapping.fieldMappingsRetrieve();
-**request:** `Merge.ticketing.FieldMappingsRetrieveRequest` +**fieldMappingId:** `string` + +
+
+ +
+
+ +**request:** `Merge.ats.PatchedEditFieldMappingRequest`
@@ -20102,7 +20110,7 @@ await client.ticketing.fieldMapping.fieldMappingsRetrieve();
-
client.ticketing.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse +
client.ats.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
@@ -20114,7 +20122,7 @@ await client.ticketing.fieldMapping.fieldMappingsRetrieve();
-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. +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/).
@@ -20130,14 +20138,7 @@ Create new Field Mappings that will be available after the next scheduled sync.
```typescript -await client.ticketing.fieldMapping.fieldMappingsCreate({ - targetFieldName: "example_target_field_name", - targetFieldDescription: "this is a example description of the target field", - remoteFieldTraversalPath: ["example_remote_field"], - remoteMethod: "GET", - remoteUrlPath: "/example-url-path", - commonModelName: "ExampleCommonModel", -}); +await client.ats.fieldMapping.remoteFieldsRetrieve(); ```
@@ -20153,7 +20154,7 @@ await client.ticketing.fieldMapping.fieldMappingsCreate({
-**request:** `Merge.ticketing.CreateFieldMappingRequest` +**request:** `Merge.ats.RemoteFieldsRetrieveRequest`
@@ -20172,7 +20173,7 @@ await client.ticketing.fieldMapping.fieldMappingsCreate({
-
client.ticketing.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse +
client.ats.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
@@ -20184,7 +20185,7 @@ await client.ticketing.fieldMapping.fieldMappingsCreate({
-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. +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/).
@@ -20200,7 +20201,7 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
```typescript -await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id"); +await client.ats.fieldMapping.targetFieldsRetrieve(); ```
@@ -20216,14 +20217,6 @@ await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**fieldMappingId:** `string` - -
-
- -
-
- **requestOptions:** `FieldMapping.RequestOptions`
@@ -20235,7 +20228,9 @@ await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
client.ticketing.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse +## Ats GenerateKey + +
client.ats.generateKey.create({ ...params }) -> Merge.RemoteKey
@@ -20247,7 +20242,7 @@ await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_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. +Create a remote key.
@@ -20263,7 +20258,9 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```typescript -await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); +await client.ats.generateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -20279,15 +20276,7 @@ await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id
-**fieldMappingId:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.PatchedEditFieldMappingRequest` +**request:** `Merge.ats.GenerateRemoteKeyRequest`
@@ -20295,7 +20284,7 @@ await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `GenerateKey.RequestOptions`
@@ -20306,7 +20295,9 @@ await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id
-
client.ticketing.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse +## Ats Interviews + +
client.ats.interviews.list({ ...params }) -> Merge.PaginatedScheduledInterviewList
@@ -20318,7 +20309,7 @@ await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_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/). +Returns a list of `ScheduledInterview` objects.
@@ -20334,7 +20325,7 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```typescript -await client.ticketing.fieldMapping.remoteFieldsRetrieve(); +await client.ats.interviews.list(); ```
@@ -20350,7 +20341,7 @@ await client.ticketing.fieldMapping.remoteFieldsRetrieve();
-**request:** `Merge.ticketing.RemoteFieldsRetrieveRequest` +**request:** `Merge.ats.InterviewsListRequest`
@@ -20358,7 +20349,7 @@ await client.ticketing.fieldMapping.remoteFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Interviews.RequestOptions`
@@ -20369,7 +20360,7 @@ await client.ticketing.fieldMapping.remoteFieldsRetrieve();
-
client.ticketing.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse +
client.ats.interviews.create({ ...params }) -> Merge.ScheduledInterviewResponse
@@ -20381,7 +20372,7 @@ await client.ticketing.fieldMapping.remoteFieldsRetrieve();
-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/). +Creates a `ScheduledInterview` object with the given values.
@@ -20397,7 +20388,10 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```typescript -await client.ticketing.fieldMapping.targetFieldsRetrieve(); +await client.ats.interviews.create({ + model: {}, + remoteUserId: "remote_user_id", +}); ```
@@ -20413,7 +20407,15 @@ await client.ticketing.fieldMapping.targetFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.ats.ScheduledInterviewEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Interviews.RequestOptions`
@@ -20424,9 +20426,7 @@ await client.ticketing.fieldMapping.targetFieldsRetrieve();
-## Ticketing GenerateKey - -
client.ticketing.generateKey.create({ ...params }) -> Merge.RemoteKey +
client.ats.interviews.retrieve(id, { ...params }) -> Merge.ScheduledInterview
@@ -20438,7 +20438,7 @@ await client.ticketing.fieldMapping.targetFieldsRetrieve();
-Create a remote key. +Returns a `ScheduledInterview` object with the given `id`.
@@ -20454,9 +20454,7 @@ Create a remote key.
```typescript -await client.ticketing.generateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.ats.interviews.retrieve("id"); ```
@@ -20472,7 +20470,7 @@ await client.ticketing.generateKey.create({
-**request:** `Merge.ticketing.GenerateRemoteKeyRequest` +**id:** `string`
@@ -20480,7 +20478,15 @@ await client.ticketing.generateKey.create({
-**requestOptions:** `GenerateKey.RequestOptions` +**request:** `Merge.ats.InterviewsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Interviews.RequestOptions`
@@ -20491,9 +20497,7 @@ await client.ticketing.generateKey.create({
-## Ticketing Issues - -
client.ticketing.issues.list({ ...params }) -> Merge.PaginatedIssueList +
client.ats.interviews.metaPostRetrieve() -> Merge.MetaResponse
@@ -20505,7 +20509,7 @@ await client.ticketing.generateKey.create({
-Gets all issues for Organization. +Returns metadata for `ScheduledInterview` POSTs.
@@ -20521,7 +20525,7 @@ Gets all issues for Organization.
```typescript -await client.ticketing.issues.list(); +await client.ats.interviews.metaPostRetrieve(); ```
@@ -20537,15 +20541,7 @@ await client.ticketing.issues.list();
-**request:** `Merge.ticketing.IssuesListRequest` - -
-
- -
-
- -**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `Interviews.RequestOptions`
@@ -20556,7 +20552,9 @@ await client.ticketing.issues.list();
-
client.ticketing.issues.retrieve(id) -> Merge.Issue +## Ats Issues + +
client.ats.issues.list({ ...params }) -> Merge.PaginatedIssueList
@@ -20568,7 +20566,7 @@ await client.ticketing.issues.list();
-Get a specific issue. +Gets all issues for Organization.
@@ -20584,7 +20582,7 @@ Get a specific issue.
```typescript -await client.ticketing.issues.retrieve("id"); +await client.ats.issues.list(); ```
@@ -20600,7 +20598,7 @@ await client.ticketing.issues.retrieve("id");
-**id:** `string` +**request:** `Merge.ats.IssuesListRequest`
@@ -20619,9 +20617,7 @@ await client.ticketing.issues.retrieve("id");
-## Ticketing LinkToken - -
client.ticketing.linkToken.create({ ...params }) -> Merge.LinkToken +
client.ats.issues.retrieve(id) -> Merge.Issue
@@ -20633,7 +20629,7 @@ await client.ticketing.issues.retrieve("id");
-Creates a link token to be used when linking a new end user. +Get a specific issue.
@@ -20649,12 +20645,7 @@ Creates a link token to be used when linking a new end user.
```typescript -await client.ticketing.linkToken.create({ - endUserEmailAddress: "example@gmail.com", - endUserOrganizationName: "Test Organization", - endUserOriginId: "12345", - categories: ["hris", "ats"], -}); +await client.ats.issues.retrieve("id"); ```
@@ -20670,7 +20661,7 @@ await client.ticketing.linkToken.create({
-**request:** `Merge.ticketing.EndUserDetailsRequest` +**id:** `string`
@@ -20678,7 +20669,7 @@ await client.ticketing.linkToken.create({
-**requestOptions:** `LinkToken.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -20689,9 +20680,9 @@ await client.ticketing.linkToken.create({
-## Ticketing LinkedAccounts +## Ats JobInterviewStages -
client.ticketing.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList +
client.ats.jobInterviewStages.list({ ...params }) -> Merge.PaginatedJobInterviewStageList
@@ -20703,7 +20694,7 @@ await client.ticketing.linkToken.create({
-List linked accounts for your organization. +Returns a list of `JobInterviewStage` objects.
@@ -20719,7 +20710,7 @@ List linked accounts for your organization.
```typescript -await client.ticketing.linkedAccounts.list(); +await client.ats.jobInterviewStages.list(); ```
@@ -20735,7 +20726,7 @@ await client.ticketing.linkedAccounts.list();
-**request:** `Merge.ticketing.LinkedAccountsListRequest` +**request:** `Merge.ats.JobInterviewStagesListRequest`
@@ -20743,7 +20734,7 @@ await client.ticketing.linkedAccounts.list();
-**requestOptions:** `LinkedAccounts.RequestOptions` +**requestOptions:** `JobInterviewStages.RequestOptions`
@@ -20754,9 +20745,7 @@ await client.ticketing.linkedAccounts.list();
-## Ticketing Passthrough - -
client.ticketing.passthrough.create({ ...params }) -> Merge.RemoteResponse +
client.ats.jobInterviewStages.retrieve(id, { ...params }) -> Merge.JobInterviewStage
@@ -20768,7 +20757,7 @@ await client.ticketing.linkedAccounts.list();
-Pull data from an endpoint not currently supported by Merge. +Returns a `JobInterviewStage` object with the given `id`.
@@ -20784,10 +20773,7 @@ Pull data from an endpoint not currently supported by Merge.
```typescript -await client.ticketing.passthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.ats.jobInterviewStages.retrieve("id"); ```
@@ -20803,7 +20789,7 @@ await client.ticketing.passthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**id:** `string`
@@ -20811,7 +20797,15 @@ await client.ticketing.passthrough.create({
-**requestOptions:** `Passthrough.RequestOptions` +**request:** `Merge.ats.JobInterviewStagesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `JobInterviewStages.RequestOptions`
@@ -20822,9 +20816,9 @@ await client.ticketing.passthrough.create({
-## Ticketing Projects +## Ats JobPostings -
client.ticketing.projects.list({ ...params }) -> Merge.PaginatedProjectList +
client.ats.jobPostings.list({ ...params }) -> Merge.PaginatedJobPostingList
@@ -20836,7 +20830,7 @@ await client.ticketing.passthrough.create({
-Returns a list of `Project` objects. +Returns a list of `JobPosting` objects.
@@ -20852,7 +20846,7 @@ Returns a list of `Project` objects.
```typescript -await client.ticketing.projects.list(); +await client.ats.jobPostings.list(); ```
@@ -20868,7 +20862,7 @@ await client.ticketing.projects.list();
-**request:** `Merge.ticketing.ProjectsListRequest` +**request:** `Merge.ats.JobPostingsListRequest`
@@ -20876,7 +20870,7 @@ await client.ticketing.projects.list();
-**requestOptions:** `Projects.RequestOptions` +**requestOptions:** `JobPostings.RequestOptions`
@@ -20887,7 +20881,7 @@ await client.ticketing.projects.list();
-
client.ticketing.projects.retrieve(id, { ...params }) -> Merge.Project +
client.ats.jobPostings.retrieve(id, { ...params }) -> Merge.JobPosting
@@ -20899,7 +20893,7 @@ await client.ticketing.projects.list();
-Returns a `Project` object with the given `id`. +Returns a `JobPosting` object with the given `id`.
@@ -20915,7 +20909,7 @@ Returns a `Project` object with the given `id`.
```typescript -await client.ticketing.projects.retrieve("id"); +await client.ats.jobPostings.retrieve("id"); ```
@@ -20939,7 +20933,7 @@ await client.ticketing.projects.retrieve("id");
-**request:** `Merge.ticketing.ProjectsRetrieveRequest` +**request:** `Merge.ats.JobPostingsRetrieveRequest`
@@ -20947,7 +20941,7 @@ await client.ticketing.projects.retrieve("id");
-**requestOptions:** `Projects.RequestOptions` +**requestOptions:** `JobPostings.RequestOptions`
@@ -20958,7 +20952,9 @@ await client.ticketing.projects.retrieve("id");
-
client.ticketing.projects.usersList(parentId, { ...params }) -> Merge.PaginatedUserList +## Ats Jobs + +
client.ats.jobs.list({ ...params }) -> Merge.PaginatedJobList
@@ -20970,7 +20966,7 @@ await client.ticketing.projects.retrieve("id");
-Returns a list of `User` objects. +Returns a list of `Job` objects.
@@ -20986,7 +20982,7 @@ Returns a list of `User` objects.
```typescript -await client.ticketing.projects.usersList("parent_id"); +await client.ats.jobs.list(); ```
@@ -21002,15 +20998,7 @@ await client.ticketing.projects.usersList("parent_id");
-**parentId:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.ProjectsUsersListRequest` +**request:** `Merge.ats.JobsListRequest`
@@ -21018,7 +21006,7 @@ await client.ticketing.projects.usersList("parent_id");
-**requestOptions:** `Projects.RequestOptions` +**requestOptions:** `Jobs.RequestOptions`
@@ -21029,9 +21017,7 @@ await client.ticketing.projects.usersList("parent_id");
-## Ticketing RegenerateKey - -
client.ticketing.regenerateKey.create({ ...params }) -> Merge.RemoteKey +
client.ats.jobs.retrieve(id, { ...params }) -> Merge.Job
@@ -21043,7 +21029,7 @@ await client.ticketing.projects.usersList("parent_id");
-Exchange remote keys. +Returns a `Job` object with the given `id`.
@@ -21059,9 +21045,7 @@ Exchange remote keys.
```typescript -await client.ticketing.regenerateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.ats.jobs.retrieve("id"); ```
@@ -21077,7 +21061,7 @@ await client.ticketing.regenerateKey.create({
-**request:** `Merge.ticketing.RemoteKeyForRegenerationRequest` +**id:** `string`
@@ -21085,7 +21069,15 @@ await client.ticketing.regenerateKey.create({
-**requestOptions:** `RegenerateKey.RequestOptions` +**request:** `Merge.ats.JobsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Jobs.RequestOptions`
@@ -21096,9 +21088,7 @@ await client.ticketing.regenerateKey.create({
-## Ticketing Roles - -
client.ticketing.roles.list({ ...params }) -> Merge.PaginatedRoleList +
client.ats.jobs.screeningQuestionsList(jobId, { ...params }) -> Merge.PaginatedScreeningQuestionList
@@ -21110,7 +21100,7 @@ await client.ticketing.regenerateKey.create({
-Returns a list of `Role` objects. +Returns a list of `ScreeningQuestion` objects.
@@ -21126,7 +21116,7 @@ Returns a list of `Role` objects.
```typescript -await client.ticketing.roles.list(); +await client.ats.jobs.screeningQuestionsList("job_id"); ```
@@ -21142,7 +21132,7 @@ await client.ticketing.roles.list();
-**request:** `Merge.ticketing.RolesListRequest` +**jobId:** `string`
@@ -21150,7 +21140,15 @@ await client.ticketing.roles.list();
-**requestOptions:** `Roles.RequestOptions` +**request:** `Merge.ats.JobsScreeningQuestionsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Jobs.RequestOptions`
@@ -21161,7 +21159,9 @@ await client.ticketing.roles.list();
-
client.ticketing.roles.retrieve(id, { ...params }) -> Merge.Role +## Ats LinkToken + +
client.ats.linkToken.create({ ...params }) -> Merge.LinkToken
@@ -21173,7 +21173,7 @@ await client.ticketing.roles.list();
-Returns a `Role` object with the given `id`. +Creates a link token to be used when linking a new end user.
@@ -21189,7 +21189,12 @@ Returns a `Role` object with the given `id`.
```typescript -await client.ticketing.roles.retrieve("id"); +await client.ats.linkToken.create({ + endUserEmailAddress: "example@gmail.com", + endUserOrganizationName: "Test Organization", + endUserOriginId: "12345", + categories: ["hris", "ats"], +}); ```
@@ -21205,15 +21210,7 @@ await client.ticketing.roles.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.RolesRetrieveRequest` +**request:** `Merge.ats.EndUserDetailsRequest`
@@ -21221,7 +21218,7 @@ await client.ticketing.roles.retrieve("id");
-**requestOptions:** `Roles.RequestOptions` +**requestOptions:** `LinkToken.RequestOptions`
@@ -21232,9 +21229,9 @@ await client.ticketing.roles.retrieve("id");
-## Ticketing SyncStatus +## Ats LinkedAccounts -
client.ticketing.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList +
client.ats.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
@@ -21246,7 +21243,7 @@ await client.ticketing.roles.retrieve("id");
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +List linked accounts for your organization.
@@ -21262,7 +21259,7 @@ Get sync status for the current sync and the most recently finished sync. `last_
```typescript -await client.ticketing.syncStatus.list(); +await client.ats.linkedAccounts.list(); ```
@@ -21278,7 +21275,7 @@ await client.ticketing.syncStatus.list();
-**request:** `Merge.ticketing.SyncStatusListRequest` +**request:** `Merge.ats.LinkedAccountsListRequest`
@@ -21286,7 +21283,7 @@ await client.ticketing.syncStatus.list();
-**requestOptions:** `SyncStatus.RequestOptions` +**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -21297,9 +21294,9 @@ await client.ticketing.syncStatus.list();
-## Ticketing ForceResync +## Ats Offers -
client.ticketing.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[] +
client.ats.offers.list({ ...params }) -> Merge.PaginatedOfferList
@@ -21311,7 +21308,7 @@ await client.ticketing.syncStatus.list();
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Returns a list of `Offer` objects.
@@ -21327,7 +21324,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```typescript -await client.ticketing.forceResync.syncStatusResyncCreate(); +await client.ats.offers.list(); ```
@@ -21343,7 +21340,15 @@ await client.ticketing.forceResync.syncStatusResyncCreate();
-**requestOptions:** `ForceResync.RequestOptions` +**request:** `Merge.ats.OffersListRequest` + +
+
+ +
+
+ +**requestOptions:** `Offers.RequestOptions`
@@ -21354,9 +21359,7 @@ await client.ticketing.forceResync.syncStatusResyncCreate();
-## Ticketing Tags - -
client.ticketing.tags.list({ ...params }) -> Merge.PaginatedTagList +
client.ats.offers.retrieve(id, { ...params }) -> Merge.Offer
@@ -21368,7 +21371,7 @@ await client.ticketing.forceResync.syncStatusResyncCreate();
-Returns a list of `Tag` objects. +Returns an `Offer` object with the given `id`.
@@ -21384,7 +21387,7 @@ Returns a list of `Tag` objects.
```typescript -await client.ticketing.tags.list(); +await client.ats.offers.retrieve("id"); ```
@@ -21400,7 +21403,7 @@ await client.ticketing.tags.list();
-**request:** `Merge.ticketing.TagsListRequest` +**id:** `string`
@@ -21408,7 +21411,15 @@ await client.ticketing.tags.list();
-**requestOptions:** `Tags.RequestOptions` +**request:** `Merge.ats.OffersRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Offers.RequestOptions`
@@ -21419,7 +21430,9 @@ await client.ticketing.tags.list();
-
client.ticketing.tags.retrieve(id, { ...params }) -> Merge.Tag +## Ats Offices + +
client.ats.offices.list({ ...params }) -> Merge.PaginatedOfficeList
@@ -21431,7 +21444,7 @@ await client.ticketing.tags.list();
-Returns a `Tag` object with the given `id`. +Returns a list of `Office` objects.
@@ -21447,7 +21460,7 @@ Returns a `Tag` object with the given `id`.
```typescript -await client.ticketing.tags.retrieve("id"); +await client.ats.offices.list(); ```
@@ -21463,15 +21476,7 @@ await client.ticketing.tags.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.TagsRetrieveRequest` +**request:** `Merge.ats.OfficesListRequest`
@@ -21479,7 +21484,7 @@ await client.ticketing.tags.retrieve("id");
-**requestOptions:** `Tags.RequestOptions` +**requestOptions:** `Offices.RequestOptions`
@@ -21490,9 +21495,7 @@ await client.ticketing.tags.retrieve("id");
-## Ticketing Teams - -
client.ticketing.teams.list({ ...params }) -> Merge.PaginatedTeamList +
client.ats.offices.retrieve(id, { ...params }) -> Merge.Office
@@ -21504,7 +21507,7 @@ await client.ticketing.tags.retrieve("id");
-Returns a list of `Team` objects. +Returns an `Office` object with the given `id`.
@@ -21520,7 +21523,7 @@ Returns a list of `Team` objects.
```typescript -await client.ticketing.teams.list(); +await client.ats.offices.retrieve("id"); ```
@@ -21536,7 +21539,7 @@ await client.ticketing.teams.list();
-**request:** `Merge.ticketing.TeamsListRequest` +**id:** `string`
@@ -21544,7 +21547,15 @@ await client.ticketing.teams.list();
-**requestOptions:** `Teams.RequestOptions` +**request:** `Merge.ats.OfficesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Offices.RequestOptions`
@@ -21555,7 +21566,9 @@ await client.ticketing.teams.list();
-
client.ticketing.teams.retrieve(id, { ...params }) -> Merge.Team +## Ats Passthrough + +
client.ats.passthrough.create({ ...params }) -> Merge.RemoteResponse
@@ -21567,7 +21580,7 @@ await client.ticketing.teams.list();
-Returns a `Team` object with the given `id`. +Pull data from an endpoint not currently supported by Merge.
@@ -21583,7 +21596,10 @@ Returns a `Team` object with the given `id`.
```typescript -await client.ticketing.teams.retrieve("id"); +await client.ats.passthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -21599,15 +21615,7 @@ await client.ticketing.teams.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.TeamsRetrieveRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -21615,7 +21623,7 @@ await client.ticketing.teams.retrieve("id");
-**requestOptions:** `Teams.RequestOptions` +**requestOptions:** `Passthrough.RequestOptions`
@@ -21626,9 +21634,9 @@ await client.ticketing.teams.retrieve("id");
-## Ticketing Tickets +## Ats RegenerateKey -
client.ticketing.tickets.list({ ...params }) -> Merge.PaginatedTicketList +
client.ats.regenerateKey.create({ ...params }) -> Merge.RemoteKey
@@ -21640,7 +21648,7 @@ await client.ticketing.teams.retrieve("id");
-Returns a list of `Ticket` objects. +Exchange remote keys.
@@ -21656,7 +21664,9 @@ Returns a list of `Ticket` objects.
```typescript -await client.ticketing.tickets.list(); +await client.ats.regenerateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -21672,7 +21682,7 @@ await client.ticketing.tickets.list();
-**request:** `Merge.ticketing.TicketsListRequest` +**request:** `Merge.ats.RemoteKeyForRegenerationRequest`
@@ -21680,7 +21690,7 @@ await client.ticketing.tickets.list();
-**requestOptions:** `Tickets.RequestOptions` +**requestOptions:** `RegenerateKey.RequestOptions`
@@ -21691,7 +21701,9 @@ await client.ticketing.tickets.list();
-
client.ticketing.tickets.create({ ...params }) -> Merge.TicketResponse +## Ats RejectReasons + +
client.ats.rejectReasons.list({ ...params }) -> Merge.PaginatedRejectReasonList
@@ -21703,7 +21715,7 @@ await client.ticketing.tickets.list();
-Creates a `Ticket` object with the given values. +Returns a list of `RejectReason` objects.
@@ -21719,9 +21731,7 @@ Creates a `Ticket` object with the given values.
```typescript -await client.ticketing.tickets.create({ - model: {}, -}); +await client.ats.rejectReasons.list(); ```
@@ -21737,7 +21747,7 @@ await client.ticketing.tickets.create({
-**request:** `Merge.ticketing.TicketEndpointRequest` +**request:** `Merge.ats.RejectReasonsListRequest`
@@ -21745,7 +21755,7 @@ await client.ticketing.tickets.create({
-**requestOptions:** `Tickets.RequestOptions` +**requestOptions:** `RejectReasons.RequestOptions`
@@ -21756,7 +21766,7 @@ await client.ticketing.tickets.create({
-
client.ticketing.tickets.retrieve(id, { ...params }) -> Merge.Ticket +
client.ats.rejectReasons.retrieve(id, { ...params }) -> Merge.RejectReason
@@ -21768,7 +21778,7 @@ await client.ticketing.tickets.create({
-Returns a `Ticket` object with the given `id`. +Returns a `RejectReason` object with the given `id`.
@@ -21784,7 +21794,7 @@ Returns a `Ticket` object with the given `id`.
```typescript -await client.ticketing.tickets.retrieve("id"); +await client.ats.rejectReasons.retrieve("id"); ```
@@ -21808,7 +21818,7 @@ await client.ticketing.tickets.retrieve("id");
-**request:** `Merge.ticketing.TicketsRetrieveRequest` +**request:** `Merge.ats.RejectReasonsRetrieveRequest`
@@ -21816,7 +21826,7 @@ await client.ticketing.tickets.retrieve("id");
-**requestOptions:** `Tickets.RequestOptions` +**requestOptions:** `RejectReasons.RequestOptions`
@@ -21827,7 +21837,9 @@ await client.ticketing.tickets.retrieve("id");
-
client.ticketing.tickets.partialUpdate(id, { ...params }) -> Merge.TicketResponse +## Ats Scorecards + +
client.ats.scorecards.list({ ...params }) -> Merge.PaginatedScorecardList
@@ -21839,7 +21851,7 @@ await client.ticketing.tickets.retrieve("id");
-Updates a `Ticket` object with the given `id`. +Returns a list of `Scorecard` objects.
@@ -21855,9 +21867,7 @@ Updates a `Ticket` object with the given `id`.
```typescript -await client.ticketing.tickets.partialUpdate("id", { - model: {}, -}); +await client.ats.scorecards.list(); ```
@@ -21873,15 +21883,7 @@ await client.ticketing.tickets.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ticketing.PatchedTicketEndpointRequest` +**request:** `Merge.ats.ScorecardsListRequest`
@@ -21889,7 +21891,7 @@ await client.ticketing.tickets.partialUpdate("id", {
-**requestOptions:** `Tickets.RequestOptions` +**requestOptions:** `Scorecards.RequestOptions`
@@ -21900,7 +21902,7 @@ await client.ticketing.tickets.partialUpdate("id", {
-
client.ticketing.tickets.viewersList(ticketId, { ...params }) -> Merge.PaginatedViewerList +
client.ats.scorecards.retrieve(id, { ...params }) -> Merge.Scorecard
@@ -21912,7 +21914,7 @@ await client.ticketing.tickets.partialUpdate("id", {
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) +Returns a `Scorecard` object with the given `id`.
@@ -21928,7 +21930,7 @@ Returns a list of `Viewer` objects that point to a User id or Team id that is ei
```typescript -await client.ticketing.tickets.viewersList("ticket_id"); +await client.ats.scorecards.retrieve("id"); ```
@@ -21944,7 +21946,7 @@ await client.ticketing.tickets.viewersList("ticket_id");
-**ticketId:** `string` +**id:** `string`
@@ -21952,7 +21954,7 @@ await client.ticketing.tickets.viewersList("ticket_id");
-**request:** `Merge.ticketing.TicketsViewersListRequest` +**request:** `Merge.ats.ScorecardsRetrieveRequest`
@@ -21960,7 +21962,7 @@ await client.ticketing.tickets.viewersList("ticket_id");
-**requestOptions:** `Tickets.RequestOptions` +**requestOptions:** `Scorecards.RequestOptions`
@@ -21971,7 +21973,9 @@ await client.ticketing.tickets.viewersList("ticket_id");
-
client.ticketing.tickets.metaPatchRetrieve(id) -> Merge.MetaResponse +## Ats SyncStatus + +
client.ats.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
@@ -21983,7 +21987,7 @@ await client.ticketing.tickets.viewersList("ticket_id");
-Returns metadata for `Ticket` PATCHs. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -21999,7 +22003,7 @@ Returns metadata for `Ticket` PATCHs.
```typescript -await client.ticketing.tickets.metaPatchRetrieve("id"); +await client.ats.syncStatus.list(); ```
@@ -22015,7 +22019,7 @@ await client.ticketing.tickets.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.ats.SyncStatusListRequest`
@@ -22023,7 +22027,7 @@ await client.ticketing.tickets.metaPatchRetrieve("id");
-**requestOptions:** `Tickets.RequestOptions` +**requestOptions:** `SyncStatus.RequestOptions`
@@ -22034,7 +22038,9 @@ await client.ticketing.tickets.metaPatchRetrieve("id");
-
client.ticketing.tickets.metaPostRetrieve({ ...params }) -> Merge.MetaResponse +## Ats ForceResync + +
client.ats.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
@@ -22046,7 +22052,7 @@ await client.ticketing.tickets.metaPatchRetrieve("id");
-Returns metadata for `Ticket` POSTs. +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -22062,7 +22068,7 @@ Returns metadata for `Ticket` POSTs.
```typescript -await client.ticketing.tickets.metaPostRetrieve(); +await client.ats.forceResync.syncStatusResyncCreate(); ```
@@ -22078,15 +22084,7 @@ await client.ticketing.tickets.metaPostRetrieve();
-**request:** `Merge.ticketing.TicketsMetaPostRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Tickets.RequestOptions` +**requestOptions:** `ForceResync.RequestOptions`
@@ -22097,7 +22095,9 @@ await client.ticketing.tickets.metaPostRetrieve();
-
client.ticketing.tickets.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Ats Tags + +
client.ats.tags.list({ ...params }) -> Merge.PaginatedTagList
@@ -22109,7 +22109,7 @@ await client.ticketing.tickets.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Tag` objects.
@@ -22125,7 +22125,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.ticketing.tickets.remoteFieldClassesList(); +await client.ats.tags.list(); ```
@@ -22141,7 +22141,7 @@ await client.ticketing.tickets.remoteFieldClassesList();
-**request:** `Merge.ticketing.TicketsRemoteFieldClassesListRequest` +**request:** `Merge.ats.TagsListRequest`
@@ -22149,7 +22149,7 @@ await client.ticketing.tickets.remoteFieldClassesList();
-**requestOptions:** `Tickets.RequestOptions` +**requestOptions:** `Tags.RequestOptions`
@@ -22160,9 +22160,9 @@ await client.ticketing.tickets.remoteFieldClassesList();
-## Ticketing Users +## Ats Users -
client.ticketing.users.list({ ...params }) -> Merge.PaginatedUserList +
client.ats.users.list({ ...params }) -> Merge.PaginatedRemoteUserList
@@ -22174,7 +22174,7 @@ await client.ticketing.tickets.remoteFieldClassesList();
-Returns a list of `User` objects. +Returns a list of `RemoteUser` objects.
@@ -22190,7 +22190,7 @@ Returns a list of `User` objects.
```typescript -await client.ticketing.users.list(); +await client.ats.users.list(); ```
@@ -22206,7 +22206,7 @@ await client.ticketing.users.list();
-**request:** `Merge.ticketing.UsersListRequest` +**request:** `Merge.ats.UsersListRequest`
@@ -22225,7 +22225,7 @@ await client.ticketing.users.list();
-
client.ticketing.users.retrieve(id, { ...params }) -> Merge.User +
client.ats.users.retrieve(id, { ...params }) -> Merge.RemoteUser
@@ -22237,7 +22237,7 @@ await client.ticketing.users.list();
-Returns a `User` object with the given `id`. +Returns a `RemoteUser` object with the given `id`.
@@ -22253,7 +22253,7 @@ Returns a `User` object with the given `id`.
```typescript -await client.ticketing.users.retrieve("id"); +await client.ats.users.retrieve("id"); ```
@@ -22277,7 +22277,7 @@ await client.ticketing.users.retrieve("id");
-**request:** `Merge.ticketing.UsersRetrieveRequest` +**request:** `Merge.ats.UsersRetrieveRequest`
@@ -22296,9 +22296,9 @@ await client.ticketing.users.retrieve("id");
-## Ticketing WebhookReceivers +## Ats WebhookReceivers -
client.ticketing.webhookReceivers.list() -> Merge.WebhookReceiver[] +
client.ats.webhookReceivers.list() -> Merge.WebhookReceiver[]
@@ -22326,7 +22326,7 @@ Returns a list of `WebhookReceiver` objects.
```typescript -await client.ticketing.webhookReceivers.list(); +await client.ats.webhookReceivers.list(); ```
@@ -22353,7 +22353,7 @@ await client.ticketing.webhookReceivers.list();
-
client.ticketing.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver +
client.ats.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
@@ -22381,7 +22381,7 @@ Creates a `WebhookReceiver` object with the given values.
```typescript -await client.ticketing.webhookReceivers.create({ +await client.ats.webhookReceivers.create({ event: "event", isActive: true, }); @@ -22400,7 +22400,7 @@ await client.ticketing.webhookReceivers.create({
-**request:** `Merge.ticketing.WebhookReceiverRequest` +**request:** `Merge.ats.WebhookReceiverRequest`
diff --git a/src/Client.ts b/src/Client.ts index aa561cad6..4310f57d0 100644 --- a/src/Client.ts +++ b/src/Client.ts @@ -5,11 +5,11 @@ import * as environments from "./environments"; import * as core from "./core"; import { mergeHeaders } from "./core/headers.js"; -import { Ats } from "./api/resources/ats/client/Client"; -import { Crm } from "./api/resources/crm/client/Client"; import { Filestorage } from "./api/resources/filestorage/client/Client"; import { Hris } from "./api/resources/hris/client/Client"; import { Ticketing } from "./api/resources/ticketing/client/Client"; +import { Crm } from "./api/resources/crm/client/Client"; +import { Ats } from "./api/resources/ats/client/Client"; import { Accounting } from "./api/resources/accounting/client/Client"; export declare namespace MergeClient { @@ -41,11 +41,11 @@ export declare namespace MergeClient { export class MergeClient { protected readonly _options: MergeClient.Options; - protected _ats: Ats | undefined; - protected _crm: Crm | undefined; protected _filestorage: Filestorage | undefined; protected _hris: Hris | undefined; protected _ticketing: Ticketing | undefined; + protected _crm: Crm | undefined; + protected _ats: Ats | undefined; protected _accounting: Accounting | undefined; constructor(_options: MergeClient.Options) { @@ -56,8 +56,8 @@ export class MergeClient { "X-Account-Token": _options?.accountToken, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@mergeapi/merge-node-client", - "X-Fern-SDK-Version": "2.0.0", - "User-Agent": "@mergeapi/merge-node-client/2.0.0", + "X-Fern-SDK-Version": "2.0.1", + "User-Agent": "@mergeapi/merge-node-client/2.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, }, @@ -66,14 +66,6 @@ export class MergeClient { }; } - public get ats(): Ats { - return (this._ats ??= new Ats(this._options)); - } - - public get crm(): Crm { - return (this._crm ??= new Crm(this._options)); - } - public get filestorage(): Filestorage { return (this._filestorage ??= new Filestorage(this._options)); } @@ -86,6 +78,14 @@ export class MergeClient { return (this._ticketing ??= new Ticketing(this._options)); } + public get crm(): Crm { + return (this._crm ??= new Crm(this._options)); + } + + public get ats(): Ats { + return (this._ats ??= new Ats(this._options)); + } + public get accounting(): Accounting { return (this._accounting ??= new Accounting(this._options)); } diff --git a/src/api/resources/accounting/resources/employees/client/Client.ts b/src/api/resources/accounting/resources/employees/client/Client.ts index 0371801c9..fc2c420ed 100644 --- a/src/api/resources/accounting/resources/employees/client/Client.ts +++ b/src/api/resources/accounting/resources/employees/client/Client.ts @@ -64,8 +64,33 @@ export class Employees { request: Merge.accounting.EmployeesListRequest = {}, requestOptions?: Employees.RequestOptions, ): Promise> { - const { cursor, expand, includeDeletedData, includeRemoteData, includeShellData, pageSize } = request; + const { + companyId, + createdAfter, + createdBefore, + cursor, + expand, + includeDeletedData, + includeRemoteData, + includeShellData, + modifiedAfter, + modifiedBefore, + pageSize, + remoteId, + } = request; const _queryParams: Record = {}; + if (companyId != null) { + _queryParams["company_id"] = companyId; + } + + if (createdAfter != null) { + _queryParams["created_after"] = createdAfter.toISOString(); + } + + if (createdBefore != null) { + _queryParams["created_before"] = createdBefore.toISOString(); + } + if (cursor != null) { _queryParams["cursor"] = cursor; } @@ -86,10 +111,22 @@ export class Employees { _queryParams["include_shell_data"] = includeShellData.toString(); } + if (modifiedAfter != null) { + _queryParams["modified_after"] = modifiedAfter.toISOString(); + } + + if (modifiedBefore != null) { + _queryParams["modified_before"] = modifiedBefore.toISOString(); + } + if (pageSize != null) { _queryParams["page_size"] = pageSize.toString(); } + if (remoteId != null) { + _queryParams["remote_id"] = remoteId; + } + const _response = await (this._options.fetcher ?? core.fetcher)({ url: urlJoin( (await core.Supplier.get(this._options.baseUrl)) ?? diff --git a/src/api/resources/accounting/resources/employees/client/requests/EmployeesListRequest.ts b/src/api/resources/accounting/resources/employees/client/requests/EmployeesListRequest.ts index a406dbcb3..e644c0753 100644 --- a/src/api/resources/accounting/resources/employees/client/requests/EmployeesListRequest.ts +++ b/src/api/resources/accounting/resources/employees/client/requests/EmployeesListRequest.ts @@ -7,6 +7,18 @@ * {} */ export interface EmployeesListRequest { + /** + * If provided, will only return employees for this company. + */ + companyId?: string; + /** + * If provided, will only return objects created after this datetime. + */ + createdAfter?: Date; + /** + * If provided, will only return objects created before this datetime. + */ + createdBefore?: Date; /** * The pagination cursor value. */ @@ -27,8 +39,20 @@ export interface EmployeesListRequest { * Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). */ includeShellData?: boolean; + /** + * If provided, only objects synced by Merge after this date time will be returned. + */ + modifiedAfter?: Date; + /** + * If provided, only objects synced by Merge before this date time will be returned. + */ + modifiedBefore?: Date; /** * Number of results to return per page. */ pageSize?: number; + /** + * The API provider's ID for the given object. + */ + remoteId?: string; } diff --git a/src/api/resources/accounting/resources/projects/client/Client.ts b/src/api/resources/accounting/resources/projects/client/Client.ts index 0c54d00dc..416a6bde6 100644 --- a/src/api/resources/accounting/resources/projects/client/Client.ts +++ b/src/api/resources/accounting/resources/projects/client/Client.ts @@ -64,8 +64,33 @@ export class Projects { request: Merge.accounting.ProjectsListRequest = {}, requestOptions?: Projects.RequestOptions, ): Promise> { - const { cursor, expand, includeDeletedData, includeRemoteData, includeShellData, pageSize } = request; + const { + companyId, + createdAfter, + createdBefore, + cursor, + expand, + includeDeletedData, + includeRemoteData, + includeShellData, + modifiedAfter, + modifiedBefore, + pageSize, + remoteId, + } = request; const _queryParams: Record = {}; + if (companyId != null) { + _queryParams["company_id"] = companyId; + } + + if (createdAfter != null) { + _queryParams["created_after"] = createdAfter.toISOString(); + } + + if (createdBefore != null) { + _queryParams["created_before"] = createdBefore.toISOString(); + } + if (cursor != null) { _queryParams["cursor"] = cursor; } @@ -88,10 +113,22 @@ export class Projects { _queryParams["include_shell_data"] = includeShellData.toString(); } + if (modifiedAfter != null) { + _queryParams["modified_after"] = modifiedAfter.toISOString(); + } + + if (modifiedBefore != null) { + _queryParams["modified_before"] = modifiedBefore.toISOString(); + } + if (pageSize != null) { _queryParams["page_size"] = pageSize.toString(); } + if (remoteId != null) { + _queryParams["remote_id"] = remoteId; + } + const _response = await (this._options.fetcher ?? core.fetcher)({ url: urlJoin( (await core.Supplier.get(this._options.baseUrl)) ?? diff --git a/src/api/resources/accounting/resources/projects/client/requests/ProjectsListRequest.ts b/src/api/resources/accounting/resources/projects/client/requests/ProjectsListRequest.ts index 2ef87a8fd..4e6077e46 100644 --- a/src/api/resources/accounting/resources/projects/client/requests/ProjectsListRequest.ts +++ b/src/api/resources/accounting/resources/projects/client/requests/ProjectsListRequest.ts @@ -9,6 +9,18 @@ import * as Merge from "../../../../../../index"; * {} */ export interface ProjectsListRequest { + /** + * If provided, will only return projects for this company. + */ + companyId?: string; + /** + * If provided, will only return objects created after this datetime. + */ + createdAfter?: Date; + /** + * If provided, will only return objects created before this datetime. + */ + createdBefore?: Date; /** * The pagination cursor value. */ @@ -29,8 +41,20 @@ export interface ProjectsListRequest { * Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). */ includeShellData?: boolean; + /** + * If provided, only objects synced by Merge after this date time will be returned. + */ + modifiedAfter?: Date; + /** + * If provided, only objects synced by Merge before this date time will be returned. + */ + modifiedBefore?: Date; /** * Number of results to return per page. */ pageSize?: number; + /** + * The API provider's ID for the given object. + */ + remoteId?: string; } diff --git a/src/api/resources/index.ts b/src/api/resources/index.ts index 2be011c93..00e3bf2a9 100644 --- a/src/api/resources/index.ts +++ b/src/api/resources/index.ts @@ -1,6 +1,6 @@ -export * as ats from "./ats"; -export * as crm from "./crm"; export * as filestorage from "./filestorage"; export * as hris from "./hris"; export * as ticketing from "./ticketing"; +export * as crm from "./crm"; +export * as ats from "./ats"; export * as accounting from "./accounting"; diff --git a/src/serialization/resources/index.ts b/src/serialization/resources/index.ts index 2be011c93..00e3bf2a9 100644 --- a/src/serialization/resources/index.ts +++ b/src/serialization/resources/index.ts @@ -1,6 +1,6 @@ -export * as ats from "./ats"; -export * as crm from "./crm"; export * as filestorage from "./filestorage"; export * as hris from "./hris"; export * as ticketing from "./ticketing"; +export * as crm from "./crm"; +export * as ats from "./ats"; export * as accounting from "./accounting"; diff --git a/src/version.ts b/src/version.ts index 478f50d17..85cbd4ff5 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const SDK_VERSION = "2.0.0"; +export const SDK_VERSION = "2.0.1"; diff --git a/yarn.lock b/yarn.lock index dcb3f1cb4..0b4f8680a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -20,32 +20,32 @@ picocolors "^1.1.1" "@babel/compat-data@^7.27.2": - version "7.27.5" - resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.27.5.tgz#7d0658ec1a8420fc866d1df1b03bea0e79934c82" - integrity sha512-KiRAp/VoJaWkkte84TvUd9qjdbZAdiqyvMxrGl1N6vzFogKmaLgoM3L1kgtLicp2HP5fBJS8JrZKLVIZGVJAVg== + version "7.27.7" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.27.7.tgz#7fd698e531050cce432b073ab64857b99e0f3804" + integrity sha512-xgu/ySj2mTiUFmdE9yCMfBxLp4DHd5DwmbbD05YAuICfodYT3VvRxbrh81LGQ/8UpSdtMdfKMn3KouYDX59DGQ== "@babel/core@^7.11.6", "@babel/core@^7.12.3", "@babel/core@^7.23.9": - version "7.27.4" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.27.4.tgz#cc1fc55d0ce140a1828d1dd2a2eba285adbfb3ce" - integrity sha512-bXYxrXFubeYdvB0NhD/NBB3Qi6aZeV20GOWVI47t2dkecCEoneR4NPVcb7abpXDEvejgrUfFtG6vG/zxAKmg+g== + version "7.27.7" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.27.7.tgz#0ddeab1e7b17317dad8c3c3a887716f66b5c4428" + integrity sha512-BU2f9tlKQ5CAthiMIgpzAh4eDTLWo1mqi9jqE2OxMG0E/OM199VJt2q8BztTxpnSW0i1ymdwLXRJnYzvDM5r2w== dependencies: "@ampproject/remapping" "^2.2.0" "@babel/code-frame" "^7.27.1" - "@babel/generator" "^7.27.3" + "@babel/generator" "^7.27.5" "@babel/helper-compilation-targets" "^7.27.2" "@babel/helper-module-transforms" "^7.27.3" - "@babel/helpers" "^7.27.4" - "@babel/parser" "^7.27.4" + "@babel/helpers" "^7.27.6" + "@babel/parser" "^7.27.7" "@babel/template" "^7.27.2" - "@babel/traverse" "^7.27.4" - "@babel/types" "^7.27.3" + "@babel/traverse" "^7.27.7" + "@babel/types" "^7.27.7" convert-source-map "^2.0.0" debug "^4.1.0" gensync "^1.0.0-beta.2" json5 "^2.2.3" semver "^6.3.1" -"@babel/generator@^7.27.3", "@babel/generator@^7.7.2": +"@babel/generator@^7.27.5", "@babel/generator@^7.7.2": version "7.27.5" resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.27.5.tgz#3eb01866b345ba261b04911020cbe22dd4be8c8c" integrity sha512-ZGhA37l0e/g2s1Cnzdix0O3aLYm66eF8aufiVteOgnwxgnRP8GoyMj7VWsgWnQbVKXyge7hqrFh2K2TQM6t1Hw== @@ -104,7 +104,7 @@ resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz#fa52f5b1e7db1ab049445b421c4471303897702f" integrity sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg== -"@babel/helpers@^7.27.4": +"@babel/helpers@^7.27.6": version "7.27.6" resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.27.6.tgz#6456fed15b2cb669d2d1fabe84b66b34991d812c" integrity sha512-muE8Tt8M22638HU31A3CgfSUciwz1fhATfoVai05aPXGor//CdWDCbnlY1yvBPo07njuVOCNGCSp/GTt12lIug== @@ -112,12 +112,12 @@ "@babel/template" "^7.27.2" "@babel/types" "^7.27.6" -"@babel/parser@^7.1.0", "@babel/parser@^7.14.7", "@babel/parser@^7.20.7", "@babel/parser@^7.23.9", "@babel/parser@^7.27.2", "@babel/parser@^7.27.4", "@babel/parser@^7.27.5": - version "7.27.5" - resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.27.5.tgz#ed22f871f110aa285a6fd934a0efed621d118826" - integrity sha512-OsQd175SxWkGlzbny8J3K8TnnDD0N3lrIUtB92xwyRpzaenGZhxDvxN/JgU00U3CDZNj9tPuDJ5H0WS4Nt3vKg== +"@babel/parser@^7.1.0", "@babel/parser@^7.14.7", "@babel/parser@^7.20.7", "@babel/parser@^7.23.9", "@babel/parser@^7.27.2", "@babel/parser@^7.27.5", "@babel/parser@^7.27.7": + version "7.27.7" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.27.7.tgz#1687f5294b45039c159730e3b9c1f1b242e425e9" + integrity sha512-qnzXzDXdr/po3bOTbTIQZ7+TxNKxpkN5IifVLXS+r7qwynkZfPyjZfE7hCXbo7IoO9TNcSyibgONsf2HauUd3Q== dependencies: - "@babel/types" "^7.27.3" + "@babel/types" "^7.27.7" "@babel/plugin-syntax-async-generators@^7.8.4": version "7.8.4" @@ -247,23 +247,23 @@ "@babel/parser" "^7.27.2" "@babel/types" "^7.27.1" -"@babel/traverse@^7.27.1", "@babel/traverse@^7.27.3", "@babel/traverse@^7.27.4": - version "7.27.4" - resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.27.4.tgz#b0045ac7023c8472c3d35effd7cc9ebd638da6ea" - integrity sha512-oNcu2QbHqts9BtOWJosOVJapWjBDSxGCpFvikNR5TGDYDQf3JwpIoMzIKrvfoti93cLfPJEG4tH9SPVeyCGgdA== +"@babel/traverse@^7.27.1", "@babel/traverse@^7.27.3", "@babel/traverse@^7.27.7": + version "7.27.7" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.27.7.tgz#8355c39be6818362eace058cf7f3e25ac2ec3b55" + integrity sha512-X6ZlfR/O/s5EQ/SnUSLzr+6kGnkg8HXGMzpgsMsrJVcfDtH1vIp6ctCN4eZ1LS5c0+te5Cb6Y514fASjMRJ1nw== dependencies: "@babel/code-frame" "^7.27.1" - "@babel/generator" "^7.27.3" - "@babel/parser" "^7.27.4" + "@babel/generator" "^7.27.5" + "@babel/parser" "^7.27.7" "@babel/template" "^7.27.2" - "@babel/types" "^7.27.3" + "@babel/types" "^7.27.7" debug "^4.3.1" globals "^11.1.0" -"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.27.1", "@babel/types@^7.27.3", "@babel/types@^7.27.6", "@babel/types@^7.3.3": - version "7.27.6" - resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.27.6.tgz#a434ca7add514d4e646c80f7375c0aa2befc5535" - integrity sha512-ETyHEk2VHHvl9b9jZP5IHPavHYk57EhanlRRuae9XCpb/j5bDCbPPMOBfCWhnl/7EDJz0jEMCi/RhccCE8r1+Q== +"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.27.1", "@babel/types@^7.27.3", "@babel/types@^7.27.6", "@babel/types@^7.27.7", "@babel/types@^7.3.3": + version "7.27.7" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.27.7.tgz#40eabd562049b2ee1a205fa589e629f945dce20f" + integrity sha512-8OLQgDScAOHXnAz2cV+RfzzNMipuLVBz2biuAJFMV9bfkNf393je3VM8CLkjQodW5+iWsSJdSgSWT6rsZoXHPw== dependencies: "@babel/helper-string-parser" "^7.27.1" "@babel/helper-validator-identifier" "^7.27.1" @@ -296,17 +296,17 @@ tough-cookie "^4.1.4" "@inquirer/confirm@^5.0.0": - version "5.1.12" - resolved "https://registry.yarnpkg.com/@inquirer/confirm/-/confirm-5.1.12.tgz#387037889a5a558ceefe52e978228630aa6e7d0e" - integrity sha512-dpq+ielV9/bqgXRUbNH//KsY6WEw9DrGPmipkpmgC1Y46cwuBTNx7PXFWTjc3MQ+urcc0QxoVHcMI0FW4Ok0hg== + version "5.1.13" + resolved "https://registry.yarnpkg.com/@inquirer/confirm/-/confirm-5.1.13.tgz#4931515edc63e25d833c9a40ccf1855e8e822dbc" + integrity sha512-EkCtvp67ICIVVzjsquUiVSd+V5HRGOGQfsqA4E4vMWhYnB7InUL0pa0TIWt1i+OfP16Gkds8CdIu6yGZwOM1Yw== dependencies: - "@inquirer/core" "^10.1.13" + "@inquirer/core" "^10.1.14" "@inquirer/type" "^3.0.7" -"@inquirer/core@^10.1.13": - version "10.1.13" - resolved "https://registry.yarnpkg.com/@inquirer/core/-/core-10.1.13.tgz#8f1ecfaba288fd2d705c7ac0690371464cf687b0" - integrity sha512-1viSxebkYN2nJULlzCxES6G9/stgHSepZ9LqqfdIGPHj5OHhiBUXVS0a6R0bEC2A+VL4D9w6QB66ebCr6HGllA== +"@inquirer/core@^10.1.14": + version "10.1.14" + resolved "https://registry.yarnpkg.com/@inquirer/core/-/core-10.1.14.tgz#7678b2daaecf32fa2f6e02a03dc235f9620e197f" + integrity sha512-Ma+ZpOJPewtIYl6HZHZckeX1STvDnHTCB2GVINNUlSEn2Am6LddWwfPkIGY0IUFVjUUrr/93XlBwTK6mfLjf0A== dependencies: "@inquirer/figures" "^1.0.12" "@inquirer/type" "^3.0.7" @@ -536,12 +536,11 @@ chalk "^4.0.0" "@jridgewell/gen-mapping@^0.3.5": - version "0.3.8" - resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.8.tgz#4f0e06362e01362f823d348f1872b08f666d8142" - integrity sha512-imAbBGkb+ebQyxKgzv5Hu2nmROxoDOXHh80evxdoXNOrvAnVx7zimzc1Oo5h9RlfV4vPXaE2iM5pOFbvOCClWA== + version "0.3.12" + resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.12.tgz#2234ce26c62889f03db3d7fea43c1932ab3e927b" + integrity sha512-OuLGC46TjB5BbN1dH8JULVVZY4WTdkF7tV9Ys6wLL1rubZnCMstOhNHueU5bLCrnRuDhKPDM4g6sw4Bel5Gzqg== dependencies: - "@jridgewell/set-array" "^1.2.1" - "@jridgewell/sourcemap-codec" "^1.4.10" + "@jridgewell/sourcemap-codec" "^1.5.0" "@jridgewell/trace-mapping" "^0.3.24" "@jridgewell/resolve-uri@^3.1.0": @@ -549,28 +548,23 @@ resolved "https://registry.yarnpkg.com/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz#7a0ee601f60f99a20c7c7c5ff0c80388c1189bd6" integrity sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw== -"@jridgewell/set-array@^1.2.1": - version "1.2.1" - resolved "https://registry.yarnpkg.com/@jridgewell/set-array/-/set-array-1.2.1.tgz#558fb6472ed16a4c850b889530e6b36438c49280" - integrity sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A== - "@jridgewell/source-map@^0.3.3": - version "0.3.6" - resolved "https://registry.yarnpkg.com/@jridgewell/source-map/-/source-map-0.3.6.tgz#9d71ca886e32502eb9362c9a74a46787c36df81a" - integrity sha512-1ZJTZebgqllO79ue2bm3rIGud/bOe0pP5BjSRCRxxYkEZS8STV7zN84UBbiYu7jy+eCKSnVIUgoWWE/tt+shMQ== + version "0.3.10" + resolved "https://registry.yarnpkg.com/@jridgewell/source-map/-/source-map-0.3.10.tgz#a35714446a2e84503ff9bfe66f1d1d4846f2075b" + integrity sha512-0pPkgz9dY+bijgistcTTJ5mR+ocqRXLuhXHYdzoMmmoJ2C9S46RCm2GMUbatPEUK9Yjy26IrAy8D/M00lLkv+Q== dependencies: "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.25" -"@jridgewell/sourcemap-codec@^1.4.10", "@jridgewell/sourcemap-codec@^1.4.14": - version "1.5.0" - resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz#3188bcb273a414b0d215fd22a58540b989b9409a" - integrity sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ== +"@jridgewell/sourcemap-codec@^1.4.14", "@jridgewell/sourcemap-codec@^1.5.0": + version "1.5.4" + resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.4.tgz#7358043433b2e5da569aa02cbc4c121da3af27d7" + integrity sha512-VT2+G1VQs/9oz078bLrYbecdZKs912zQlkelYpuf+SXF+QvZDYJlbx/LSx+meSAwdDFnF8FVXW92AVjjkVmgFw== "@jridgewell/trace-mapping@^0.3.12", "@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.25": - version "0.3.25" - resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz#15f190e98895f3fc23276ee14bc76b675c2e50f0" - integrity sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ== + version "0.3.29" + resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.29.tgz#a58d31eaadaf92c6695680b2e1d464a9b8fbf7fc" + integrity sha512-uw6guiW/gcAGPDhLmd77/6lW8QLeiV5RUTsAX46Db6oLhGaVj4lhnPwb184s1bkc8kdVg/+h988dro8GRDpmYQ== dependencies: "@jridgewell/resolve-uri" "^3.1.0" "@jridgewell/sourcemap-codec" "^1.4.14" @@ -745,16 +739,16 @@ form-data "^4.0.0" "@types/node@*": - version "24.0.1" - resolved "https://registry.yarnpkg.com/@types/node/-/node-24.0.1.tgz#e9bfcb1c35547437c294403b7bec497772a88b0a" - integrity sha512-MX4Zioh39chHlDJbKmEgydJDS3tspMP/lnQC67G3SWsTnb9NeYVWOjkxpOSy4oMfPs4StcWHwBrvUb4ybfnuaw== + version "24.0.10" + resolved "https://registry.yarnpkg.com/@types/node/-/node-24.0.10.tgz#f65a169779bf0d70203183a1890be7bee8ca2ddb" + integrity sha512-ENHwaH+JIRTDIEEbDK6QSQntAYGtbvdDXnMXnZaZ6k13Du1dPMmprkEHIL7ok2Wl2aZevetwTAb5S+7yIF+enA== dependencies: undici-types "~7.8.0" "@types/node@^18.19.70": - version "18.19.111" - resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.111.tgz#e95b89efc24cc625834b43bcd70bd5591a5dfba5" - integrity sha512-90sGdgA+QLJr1F9X79tQuEut0gEYIfkX9pydI4XGRgvFo9g2JWswefI+WUSUHPYVBHYSEfTEqBxA5hQvAZB3Mw== + version "18.19.115" + resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.115.tgz#cd94caf14472021b4443c99bcd7aac6bb5c4f672" + integrity sha512-kNrFiTgG4a9JAn1LMQeLOv3MvXIPokzXziohMrMsvpYgLpdEt/mMiVYc4sGKtDfyxM5gIDF4VgrPRyCw4fHOYg== dependencies: undici-types "~5.26.4" @@ -1141,12 +1135,12 @@ braces@^3.0.3: fill-range "^7.1.1" browserslist@^4.24.0: - version "4.25.0" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.25.0.tgz#986aa9c6d87916885da2b50d8eb577ac8d133b2c" - integrity sha512-PJ8gYKeS5e/whHBh8xrwYK+dAvEj7JXtz6uTucnMRB8OiGTsKccFekoRrjajPBHV8oOY+2tI4uxeceSimKwMFA== + version "4.25.1" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.25.1.tgz#ba9e8e6f298a1d86f829c9b975e07948967bb111" + integrity sha512-KGj0KoOMXLpSNkkEI6Z6mShmQy0bc1I+T7K9N81k4WWMrfz+6fQ6es80B/YLAeRoKvjYE1YSHHOW1qe9xIVzHw== dependencies: - caniuse-lite "^1.0.30001718" - electron-to-chromium "^1.5.160" + caniuse-lite "^1.0.30001726" + electron-to-chromium "^1.5.173" node-releases "^2.0.19" update-browserslist-db "^1.1.3" @@ -1208,10 +1202,10 @@ camelcase@^6.2.0: resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-6.3.0.tgz#5685b95eb209ac9c0c177467778c9c84df58ba9a" integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== -caniuse-lite@^1.0.30001718: - version "1.0.30001722" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001722.tgz#ec25a2b3085b25b9079b623db83c22a70882ce85" - integrity sha512-DCQHBBZtiK6JVkAGw7drvAMK0Q0POD/xZvEmDp6baiMMP6QXXk9HpD6mNYBZWhOPG6LvIDb82ITqtWjhDckHCA== +caniuse-lite@^1.0.30001726: + version "1.0.30001726" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001726.tgz#a15bd87d5a4bf01f6b6f70ae7c97fdfd28b5ae47" + integrity sha512-VQAUIUzBiZ/UnlM28fSp2CRF3ivUn1BWEvxMcVTNwpw91Py1pGbPIyIKtd+tzct9C3ouceCVdGAXxZOpZAsgdw== chalk@^4.0.0, chalk@^4.0.2, chalk@^4.1.0: version "4.1.2" @@ -1412,10 +1406,10 @@ ejs@^3.1.10: dependencies: jake "^10.8.5" -electron-to-chromium@^1.5.160: - version "1.5.166" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.166.tgz#3fff386ed473cc2169dbe2d3ace9592262601114" - integrity sha512-QPWqHL0BglzPYyJJ1zSSmwFFL6MFXhbACOCcsCdUMCkzPdS9/OIBVxg516X/Ado2qwAq8k0nJJ7phQPCqiaFAw== +electron-to-chromium@^1.5.173: + version "1.5.178" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.178.tgz#6fc4d69eb5275bb13068931448fd822458901fbb" + integrity sha512-wObbz/ar3Bc6e4X5vf0iO8xTN8YAjN/tgiAOJLr7yjYFtP9wAjq8Mb5h0yn6kResir+VYx2DXBj9NNobs0ETSA== emittery@^0.13.1: version "0.13.1" @@ -1428,9 +1422,9 @@ emoji-regex@^8.0.0: integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== enhanced-resolve@^5.0.0, enhanced-resolve@^5.17.1: - version "5.18.1" - resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.1.tgz#728ab082f8b7b6836de51f1637aab5d3b9568faf" - integrity sha512-ZSW3ma5GkcQBIpwZTSRAI8N71Uuwgs93IezB7mf7R60tC8ZbJideoDNKjHn2O9KIlx6rkGTTEk1xUCK2E1Y2Yg== + version "5.18.2" + resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.2.tgz#7903c5b32ffd4b2143eeb4b92472bd68effd5464" + integrity sha512-6Jw4sE1maoRJo3q8MsSIn2onJFbLTOjY9hlx4DZXmOKvLRd1Ok2kXmAGXaafL2+ijsJZ1ClYbl/pmqr9+k4iUQ== dependencies: graceful-fs "^4.2.4" tapable "^2.2.0" @@ -2694,9 +2688,9 @@ pkg-dir@^4.2.0: find-up "^4.0.0" prettier@^3.4.2: - version "3.5.3" - resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.5.3.tgz#4fc2ce0d657e7a02e602549f053b239cb7dfe1b5" - integrity sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw== + version "3.6.2" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.6.2.tgz#ccda02a1003ebbb2bfda6f83a074978f608b9393" + integrity sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ== pretty-format@^29.0.0, pretty-format@^29.7.0: version "29.7.0" @@ -3064,9 +3058,9 @@ terser-webpack-plugin@^5.3.11: terser "^5.31.1" terser@^5.31.1: - version "5.42.0" - resolved "https://registry.yarnpkg.com/terser/-/terser-5.42.0.tgz#1db8493aa0f3f866e488ec0fcf7e0c28eb43a2f5" - integrity sha512-UYCvU9YQW2f/Vwl+P0GfhxJxbUGLwd+5QrrGgLajzWAtC/23AX0vcise32kkP7Eu0Wu9VlzzHAXkLObgjQfFlQ== + version "5.43.1" + resolved "https://registry.yarnpkg.com/terser/-/terser-5.43.1.tgz#88387f4f9794ff1a29e7ad61fb2932e25b4fdb6d" + integrity sha512-+6erLbBm0+LROX2sPXlUYx/ux5PyE9K/a92Wrt6oA+WDAoFTdpHE5tCYCI5PNzq2y8df4rA+QgHLJuR4jNymsg== dependencies: "@jridgewell/source-map" "^0.3.3" acorn "^8.14.0" @@ -3240,9 +3234,9 @@ webidl-conversions@^7.0.0: integrity sha512-VwddBukDzu71offAQR975unBIGqfKZpM+8ZX6ySk8nYhVoo5CYaZyzt3YBvYtRtO+aoGlqxPg/B87NGVZ/fu6g== webpack-sources@^3.2.3: - version "3.3.2" - resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.3.2.tgz#0ab55ab0b380ce53c45ca40cb7b33bab3149ea85" - integrity sha512-ykKKus8lqlgXX/1WjudpIEjqsafjOTcOJqxnAbMLAu/KCsDCJ6GBtvscewvTkrn24HsnvFwrSCbenFrhtcCsAA== + version "3.3.3" + resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-3.3.3.tgz#d4bf7f9909675d7a070ff14d0ef2a4f3c982c723" + integrity sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg== webpack@^5.97.1: version "5.99.9" @@ -3341,9 +3335,9 @@ write-file-atomic@^4.0.2: signal-exit "^3.0.7" ws@^8.11.0: - version "8.18.2" - resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.2.tgz#42738b2be57ced85f46154320aabb51ab003705a" - integrity sha512-DMricUmwGZUVr++AEAe2uiVM7UoO9MAVZMDu05UQOaUII0lp+zOzLLU4Xqh/JvTqklB1T4uELaaPBKyjE1r4fQ== + version "8.18.3" + resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.3.tgz#b56b88abffde62791c639170400c93dcb0c95472" + integrity sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg== xml-name-validator@^4.0.0: version "4.0.0"