diff --git a/.mock/definition/accounting/__package__.yml b/.mock/definition/accounting/__package__.yml index 3a198d776..c4e8cb248 100644 --- a/.mock/definition/accounting/__package__.yml +++ b/.mock/definition/accounting/__package__.yml @@ -51609,6 +51609,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional diff --git a/.mock/definition/accounting/contacts.yml b/.mock/definition/accounting/contacts.yml index ba75cfb47..c4b6af242 100644 --- a/.mock/definition/accounting/contacts.yml +++ b/.mock/definition/accounting/contacts.yml @@ -593,6 +593,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/expenseReports.yml b/.mock/definition/accounting/expenseReports.yml index d87949802..af9085aeb 100644 --- a/.mock/definition/accounting/expenseReports.yml +++ b/.mock/definition/accounting/expenseReports.yml @@ -680,6 +680,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -929,6 +930,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/expenses.yml b/.mock/definition/accounting/expenses.yml index 98c48edfd..a4c1bc4b3 100644 --- a/.mock/definition/accounting/expenses.yml +++ b/.mock/definition/accounting/expenses.yml @@ -706,6 +706,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -955,6 +956,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/invoices.yml b/.mock/definition/accounting/invoices.yml index a3d880120..e11794784 100644 --- a/.mock/definition/accounting/invoices.yml +++ b/.mock/definition/accounting/invoices.yml @@ -27654,6 +27654,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -28091,6 +28092,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/journalEntries.yml b/.mock/definition/accounting/journalEntries.yml index feb7bad36..625e4f6ee 100644 --- a/.mock/definition/accounting/journalEntries.yml +++ b/.mock/definition/accounting/journalEntries.yml @@ -701,6 +701,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -950,6 +951,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/payments.yml b/.mock/definition/accounting/payments.yml index be829a43a..8f52bb355 100644 --- a/.mock/definition/accounting/payments.yml +++ b/.mock/definition/accounting/payments.yml @@ -1036,6 +1036,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -1473,6 +1474,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/accounting/purchaseOrders.yml b/.mock/definition/accounting/purchaseOrders.yml index e0157639d..0e34e2edc 100644 --- a/.mock/definition/accounting/purchaseOrders.yml +++ b/.mock/definition/accounting/purchaseOrders.yml @@ -1031,6 +1031,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string @@ -1280,6 +1281,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/__package__.yml b/.mock/definition/crm/__package__.yml index 4ad8f75de..adb6df8b1 100644 --- a/.mock/definition/crm/__package__.yml +++ b/.mock/definition/crm/__package__.yml @@ -5158,6 +5158,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional diff --git a/.mock/definition/crm/accounts.yml b/.mock/definition/crm/accounts.yml index e29591157..f7fccdff3 100644 --- a/.mock/definition/crm/accounts.yml +++ b/.mock/definition/crm/accounts.yml @@ -837,6 +837,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/contacts.yml b/.mock/definition/crm/contacts.yml index b9f0b0f07..4fefc64ae 100644 --- a/.mock/definition/crm/contacts.yml +++ b/.mock/definition/crm/contacts.yml @@ -891,6 +891,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/customObjects.yml b/.mock/definition/crm/customObjects.yml index d4904e56f..4680ae98e 100644 --- a/.mock/definition/crm/customObjects.yml +++ b/.mock/definition/crm/customObjects.yml @@ -467,6 +467,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/engagementTypes.yml b/.mock/definition/crm/engagementTypes.yml index 2070b2ef8..3dae18435 100644 --- a/.mock/definition/crm/engagementTypes.yml +++ b/.mock/definition/crm/engagementTypes.yml @@ -195,6 +195,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/engagements.yml b/.mock/definition/crm/engagements.yml index aaf88ac03..de2229131 100644 --- a/.mock/definition/crm/engagements.yml +++ b/.mock/definition/crm/engagements.yml @@ -846,6 +846,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/leads.yml b/.mock/definition/crm/leads.yml index 1f1e46d19..d12db2896 100644 --- a/.mock/definition/crm/leads.yml +++ b/.mock/definition/crm/leads.yml @@ -617,6 +617,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/notes.yml b/.mock/definition/crm/notes.yml index df9293aad..b0acff5e5 100644 --- a/.mock/definition/crm/notes.yml +++ b/.mock/definition/crm/notes.yml @@ -568,6 +568,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/opportunities.yml b/.mock/definition/crm/opportunities.yml index 4a0253aae..88e8e9016 100644 --- a/.mock/definition/crm/opportunities.yml +++ b/.mock/definition/crm/opportunities.yml @@ -859,6 +859,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/stages.yml b/.mock/definition/crm/stages.yml index a8676fa5f..b9e114d9d 100644 --- a/.mock/definition/crm/stages.yml +++ b/.mock/definition/crm/stages.yml @@ -213,6 +213,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/tasks.yml b/.mock/definition/crm/tasks.yml index befb0c548..ece065166 100644 --- a/.mock/definition/crm/tasks.yml +++ b/.mock/definition/crm/tasks.yml @@ -798,6 +798,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/crm/users.yml b/.mock/definition/crm/users.yml index 6762984a7..05ddcfc50 100644 --- a/.mock/definition/crm/users.yml +++ b/.mock/definition/crm/users.yml @@ -242,6 +242,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: string field_format: string diff --git a/.mock/definition/ticketing/__package__.yml b/.mock/definition/ticketing/__package__.yml index fef97a5f1..845b06999 100644 --- a/.mock/definition/ticketing/__package__.yml +++ b/.mock/definition/ticketing/__package__.yml @@ -2319,6 +2319,7 @@ types: remote_key_name: optional description: optional is_custom: optional + is_common_model_field: optional is_required: optional field_type: optional field_format: optional diff --git a/.mock/definition/ticketing/tickets.yml b/.mock/definition/ticketing/tickets.yml index 8177b0bf7..8b7632a58 100644 --- a/.mock/definition/ticketing/tickets.yml +++ b/.mock/definition/ticketing/tickets.yml @@ -2142,6 +2142,7 @@ service: remote_key_name: remote_key_name description: description is_custom: true + is_common_model_field: true is_required: true field_type: field_type field_format: field_format diff --git a/package.json b/package.json index 9a1eca2bf..dc8ace4f4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@mergeapi/merge-node-client", - "version": "2.1.1", + "version": "2.1.2", "private": false, "repository": "github:merge-api/merge-node-client", "main": "./index.js", diff --git a/reference.md b/reference.md index 77948e02a..7da5d9f3a 100644 --- a/reference.md +++ b/reference.md @@ -1,8 +1,8 @@ # Reference -## Crm AccountDetails +## Ats AccountDetails -
client.crm.accountDetails.retrieve() -> Merge.AccountDetails +
client.ats.accountDetails.retrieve() -> Merge.AccountDetails
@@ -30,7 +30,7 @@ Get details for a linked account.
```typescript -await client.crm.accountDetails.retrieve(); +await client.ats.accountDetails.retrieve(); ```
@@ -57,9 +57,9 @@ await client.crm.accountDetails.retrieve();
-## Crm AccountToken +## Ats AccountToken -
client.crm.accountToken.retrieve(publicToken) -> Merge.AccountToken +
client.ats.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.crm.accountToken.retrieve("public_token"); +await client.ats.accountToken.retrieve("public_token"); ```
@@ -122,9 +122,9 @@ await client.crm.accountToken.retrieve("public_token");
-## Crm Accounts +## Ats Activities -
client.crm.accounts.list({ ...params }) -> Merge.PaginatedAccountList +
client.ats.activities.list({ ...params }) -> Merge.PaginatedActivityList
@@ -136,7 +136,7 @@ await client.crm.accountToken.retrieve("public_token");
-Returns a list of `Account` objects. +Returns a list of `Activity` objects.
@@ -152,7 +152,7 @@ Returns a list of `Account` objects.
```typescript -await client.crm.accounts.list(); +await client.ats.activities.list(); ```
@@ -168,7 +168,7 @@ await client.crm.accounts.list();
-**request:** `Merge.crm.AccountsListRequest` +**request:** `Merge.ats.ActivitiesListRequest`
@@ -176,7 +176,7 @@ await client.crm.accounts.list();
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Activities.RequestOptions`
@@ -187,7 +187,7 @@ await client.crm.accounts.list();
-
client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse +
client.ats.activities.create({ ...params }) -> Merge.ActivityResponse
@@ -199,7 +199,7 @@ await client.crm.accounts.list();
-Creates an `Account` object with the given values. +Creates an `Activity` object with the given values.
@@ -215,8 +215,9 @@ Creates an `Account` object with the given values.
```typescript -await client.crm.accounts.create({ +await client.ats.activities.create({ model: {}, + remoteUserId: "remote_user_id", }); ``` @@ -233,7 +234,7 @@ await client.crm.accounts.create({
-**request:** `Merge.crm.CrmAccountEndpointRequest` +**request:** `Merge.ats.ActivityEndpointRequest`
@@ -241,7 +242,7 @@ await client.crm.accounts.create({
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Activities.RequestOptions`
@@ -252,7 +253,7 @@ await client.crm.accounts.create({
-
client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account +
client.ats.activities.retrieve(id, { ...params }) -> Merge.Activity
@@ -264,7 +265,7 @@ await client.crm.accounts.create({
-Returns an `Account` object with the given `id`. +Returns an `Activity` object with the given `id`.
@@ -280,7 +281,7 @@ Returns an `Account` object with the given `id`.
```typescript -await client.crm.accounts.retrieve("id"); +await client.ats.activities.retrieve("id"); ```
@@ -304,7 +305,7 @@ await client.crm.accounts.retrieve("id");
-**request:** `Merge.crm.AccountsRetrieveRequest` +**request:** `Merge.ats.ActivitiesRetrieveRequest`
@@ -312,7 +313,7 @@ await client.crm.accounts.retrieve("id");
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Activities.RequestOptions`
@@ -323,7 +324,7 @@ await client.crm.accounts.retrieve("id");
-
client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse +
client.ats.activities.metaPostRetrieve() -> Merge.MetaResponse
@@ -335,7 +336,7 @@ await client.crm.accounts.retrieve("id");
-Updates an `Account` object with the given `id`. +Returns metadata for `Activity` POSTs.
@@ -351,9 +352,7 @@ Updates an `Account` object with the given `id`.
```typescript -await client.crm.accounts.partialUpdate("id", { - model: {}, -}); +await client.ats.activities.metaPostRetrieve(); ```
@@ -369,23 +368,7 @@ await client.crm.accounts.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedCrmAccountEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Activities.RequestOptions`
@@ -396,7 +379,9 @@ await client.crm.accounts.partialUpdate("id", {
-
client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse +## Ats Applications + +
client.ats.applications.list({ ...params }) -> Merge.PaginatedApplicationList
@@ -408,7 +393,7 @@ await client.crm.accounts.partialUpdate("id", {
-Returns metadata for `CRMAccount` PATCHs. +Returns a list of `Application` objects.
@@ -424,7 +409,7 @@ Returns metadata for `CRMAccount` PATCHs.
```typescript -await client.crm.accounts.metaPatchRetrieve("id"); +await client.ats.applications.list(); ```
@@ -440,7 +425,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.ats.ApplicationsListRequest`
@@ -448,7 +433,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Applications.RequestOptions`
@@ -459,7 +444,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-
client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse +
client.ats.applications.create({ ...params }) -> Merge.ApplicationResponse
@@ -471,7 +456,10 @@ await client.crm.accounts.metaPatchRetrieve("id");
-Returns metadata for `CRMAccount` POSTs. +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.
@@ -487,7 +475,10 @@ Returns metadata for `CRMAccount` POSTs.
```typescript -await client.crm.accounts.metaPostRetrieve(); +await client.ats.applications.create({ + model: {}, + remoteUserId: "remote_user_id", +}); ```
@@ -503,7 +494,15 @@ await client.crm.accounts.metaPostRetrieve();
-**requestOptions:** `Accounts.RequestOptions` +**request:** `Merge.ats.ApplicationEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Applications.RequestOptions`
@@ -514,7 +513,7 @@ await client.crm.accounts.metaPostRetrieve();
-
client.crm.accounts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.ats.applications.retrieve(id, { ...params }) -> Merge.Application
@@ -526,7 +525,7 @@ await client.crm.accounts.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Returns an `Application` object with the given `id`.
@@ -542,7 +541,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.accounts.remoteFieldClassesList(); +await client.ats.applications.retrieve("id"); ```
@@ -558,7 +557,7 @@ await client.crm.accounts.remoteFieldClassesList();
-**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest` +**id:** `string`
@@ -566,7 +565,15 @@ await client.crm.accounts.remoteFieldClassesList();
-**requestOptions:** `Accounts.RequestOptions` +**request:** `Merge.ats.ApplicationsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Applications.RequestOptions`
@@ -577,9 +584,7 @@ await client.crm.accounts.remoteFieldClassesList();
-## Crm AsyncPassthrough - -
client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept +
client.ats.applications.changeStageCreate(id, { ...params }) -> Merge.ApplicationResponse
@@ -591,7 +596,7 @@ await client.crm.accounts.remoteFieldClassesList();
-Asynchronously pull data from an endpoint not currently supported by Merge. +Updates the `current_stage` field of an `Application` object
@@ -607,10 +612,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```typescript -await client.crm.asyncPassthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.ats.applications.changeStageCreate("id"); ```
@@ -626,7 +628,7 @@ await client.crm.asyncPassthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**id:** `string`
@@ -634,7 +636,15 @@ await client.crm.asyncPassthrough.create({
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**request:** `Merge.ats.UpdateApplicationStageRequest` + +
+
+ +
+
+ +**requestOptions:** `Applications.RequestOptions`
@@ -645,7 +655,7 @@ await client.crm.asyncPassthrough.create({
-
client.crm.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse +
client.ats.applications.metaPostRetrieve({ ...params }) -> Merge.MetaResponse
@@ -657,7 +667,7 @@ await client.crm.asyncPassthrough.create({
-Retrieves data from earlier async-passthrough POST request +Returns metadata for `Application` POSTs.
@@ -673,7 +683,7 @@ Retrieves data from earlier async-passthrough POST request
```typescript -await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id"); +await client.ats.applications.metaPostRetrieve(); ```
@@ -689,7 +699,7 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**asyncPassthroughReceiptId:** `string` +**request:** `Merge.ats.ApplicationsMetaPostRetrieveRequest`
@@ -697,7 +707,7 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `Applications.RequestOptions`
@@ -708,9 +718,9 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-## Crm AuditTrail +## Ats AsyncPassthrough -
client.crm.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList +
client.ats.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
@@ -722,7 +732,7 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-Gets a list of audit trail events. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -738,7 +748,10 @@ Gets a list of audit trail events.
```typescript -await client.crm.auditTrail.list(); +await client.ats.asyncPassthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -754,7 +767,7 @@ await client.crm.auditTrail.list();
-**request:** `Merge.crm.AuditTrailListRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -762,7 +775,7 @@ await client.crm.auditTrail.list();
-**requestOptions:** `AuditTrail.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -773,9 +786,7 @@ await client.crm.auditTrail.list();
-## Crm AvailableActions - -
client.crm.availableActions.retrieve() -> Merge.AvailableActions +
client.ats.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
@@ -787,7 +798,7 @@ await client.crm.auditTrail.list();
-Returns a list of models and actions available for an account. +Retrieves data from earlier async-passthrough POST request
@@ -803,7 +814,7 @@ Returns a list of models and actions available for an account.
```typescript -await client.crm.availableActions.retrieve(); +await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
@@ -819,7 +830,15 @@ await client.crm.availableActions.retrieve();
-**requestOptions:** `AvailableActions.RequestOptions` +**asyncPassthroughReceiptId:** `string` + +
+
+ +
+
+ +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -830,9 +849,9 @@ await client.crm.availableActions.retrieve();
-## Crm Contacts +## Ats Attachments -
client.crm.contacts.list({ ...params }) -> Merge.PaginatedContactList +
client.ats.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList
@@ -844,7 +863,7 @@ await client.crm.availableActions.retrieve();
-Returns a list of `Contact` objects. +Returns a list of `Attachment` objects.
@@ -860,7 +879,7 @@ Returns a list of `Contact` objects.
```typescript -await client.crm.contacts.list(); +await client.ats.attachments.list(); ```
@@ -876,7 +895,7 @@ await client.crm.contacts.list();
-**request:** `Merge.crm.ContactsListRequest` +**request:** `Merge.ats.AttachmentsListRequest`
@@ -884,7 +903,7 @@ await client.crm.contacts.list();
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -895,7 +914,7 @@ await client.crm.contacts.list();
-
client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse +
client.ats.attachments.create({ ...params }) -> Merge.AttachmentResponse
@@ -907,7 +926,7 @@ await client.crm.contacts.list();
-Creates a `Contact` object with the given values. +Creates an `Attachment` object with the given values.
@@ -923,8 +942,9 @@ Creates a `Contact` object with the given values.
```typescript -await client.crm.contacts.create({ +await client.ats.attachments.create({ model: {}, + remoteUserId: "remote_user_id", }); ``` @@ -941,7 +961,7 @@ await client.crm.contacts.create({
-**request:** `Merge.crm.CrmContactEndpointRequest` +**request:** `Merge.ats.AttachmentEndpointRequest`
@@ -949,7 +969,7 @@ await client.crm.contacts.create({
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -960,7 +980,7 @@ await client.crm.contacts.create({
-
client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact +
client.ats.attachments.retrieve(id, { ...params }) -> Merge.Attachment
@@ -972,7 +992,7 @@ await client.crm.contacts.create({
-Returns a `Contact` object with the given `id`. +Returns an `Attachment` object with the given `id`.
@@ -988,7 +1008,7 @@ Returns a `Contact` object with the given `id`.
```typescript -await client.crm.contacts.retrieve("id"); +await client.ats.attachments.retrieve("id"); ```
@@ -1012,7 +1032,7 @@ await client.crm.contacts.retrieve("id");
-**request:** `Merge.crm.ContactsRetrieveRequest` +**request:** `Merge.ats.AttachmentsRetrieveRequest`
@@ -1020,7 +1040,7 @@ await client.crm.contacts.retrieve("id");
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -1031,7 +1051,7 @@ await client.crm.contacts.retrieve("id");
-
client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse +
client.ats.attachments.metaPostRetrieve() -> Merge.MetaResponse
@@ -1043,7 +1063,7 @@ await client.crm.contacts.retrieve("id");
-Updates a `Contact` object with the given `id`. +Returns metadata for `Attachment` POSTs.
@@ -1059,9 +1079,7 @@ Updates a `Contact` object with the given `id`.
```typescript -await client.crm.contacts.partialUpdate("id", { - model: {}, -}); +await client.ats.attachments.metaPostRetrieve(); ```
@@ -1077,23 +1095,7 @@ await client.crm.contacts.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedCrmContactEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Attachments.RequestOptions`
@@ -1104,7 +1106,9 @@ await client.crm.contacts.partialUpdate("id", {
-
client.crm.contacts.ignoreCreate(modelId, { ...params }) -> void +## Ats AuditTrail + +
client.ats.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
@@ -1116,7 +1120,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. +Gets a list of audit trail events.
@@ -1132,9 +1136,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.ats.auditTrail.list(); ```
@@ -1150,15 +1152,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-**modelId:** `string` - -
-
- -
-
- -**request:** `Merge.IgnoreCommonModelRequest` +**request:** `Merge.ats.AuditTrailListRequest`
@@ -1166,7 +1160,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `AuditTrail.RequestOptions`
@@ -1177,7 +1171,9 @@ await client.crm.contacts.ignoreCreate("model_id", {
-
client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse +## Ats AvailableActions + +
client.ats.availableActions.retrieve() -> Merge.AvailableActions
@@ -1189,7 +1185,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-Returns metadata for `CRMContact` PATCHs. +Returns a list of models and actions available for an account.
@@ -1205,7 +1201,7 @@ Returns metadata for `CRMContact` PATCHs.
```typescript -await client.crm.contacts.metaPatchRetrieve("id"); +await client.ats.availableActions.retrieve(); ```
@@ -1221,15 +1217,7 @@ await client.crm.contacts.metaPatchRetrieve("id");
-**id:** `string` - -
-
- -
-
- -**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `AvailableActions.RequestOptions`
@@ -1240,7 +1228,9 @@ await client.crm.contacts.metaPatchRetrieve("id");
-
client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse +## Ats Candidates + +
client.ats.candidates.list({ ...params }) -> Merge.PaginatedCandidateList
@@ -1252,7 +1242,7 @@ await client.crm.contacts.metaPatchRetrieve("id");
-Returns metadata for `CRMContact` POSTs. +Returns a list of `Candidate` objects.
@@ -1268,7 +1258,7 @@ Returns metadata for `CRMContact` POSTs.
```typescript -await client.crm.contacts.metaPostRetrieve(); +await client.ats.candidates.list(); ```
@@ -1284,7 +1274,15 @@ await client.crm.contacts.metaPostRetrieve();
-**requestOptions:** `Contacts.RequestOptions` +**request:** `Merge.ats.CandidatesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Candidates.RequestOptions`
@@ -1295,7 +1293,7 @@ await client.crm.contacts.metaPostRetrieve();
-
client.crm.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.ats.candidates.create({ ...params }) -> Merge.CandidateResponse
@@ -1307,7 +1305,7 @@ await client.crm.contacts.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Creates a `Candidate` object with the given values.
@@ -1323,7 +1321,10 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.contacts.remoteFieldClassesList(); +await client.ats.candidates.create({ + model: {}, + remoteUserId: "remote_user_id", +}); ```
@@ -1339,7 +1340,7 @@ await client.crm.contacts.remoteFieldClassesList();
-**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest` +**request:** `Merge.ats.CandidateEndpointRequest`
@@ -1347,7 +1348,7 @@ await client.crm.contacts.remoteFieldClassesList();
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Candidates.RequestOptions`
@@ -1358,9 +1359,7 @@ await client.crm.contacts.remoteFieldClassesList();
-## Crm CustomObjectClasses - -
client.crm.customObjectClasses.list({ ...params }) -> Merge.PaginatedCustomObjectClassList +
client.ats.candidates.retrieve(id, { ...params }) -> Merge.Candidate
@@ -1372,7 +1371,7 @@ await client.crm.contacts.remoteFieldClassesList();
-Returns a list of `CustomObjectClass` objects. +Returns a `Candidate` object with the given `id`.
@@ -1388,7 +1387,7 @@ Returns a list of `CustomObjectClass` objects.
```typescript -await client.crm.customObjectClasses.list(); +await client.ats.candidates.retrieve("id"); ```
@@ -1404,7 +1403,7 @@ await client.crm.customObjectClasses.list();
-**request:** `Merge.crm.CustomObjectClassesListRequest` +**id:** `string`
@@ -1412,7 +1411,15 @@ await client.crm.customObjectClasses.list();
-**requestOptions:** `CustomObjectClasses.RequestOptions` +**request:** `Merge.ats.CandidatesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Candidates.RequestOptions`
@@ -1423,7 +1430,7 @@ await client.crm.customObjectClasses.list();
-
client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass +
client.ats.candidates.partialUpdate(id, { ...params }) -> Merge.CandidateResponse
@@ -1435,7 +1442,7 @@ await client.crm.customObjectClasses.list();
-Returns a `CustomObjectClass` object with the given `id`. +Updates a `Candidate` object with the given `id`.
@@ -1451,7 +1458,10 @@ Returns a `CustomObjectClass` object with the given `id`.
```typescript -await client.crm.customObjectClasses.retrieve("id"); +await client.ats.candidates.partialUpdate("id", { + model: {}, + remoteUserId: "remote_user_id", +}); ```
@@ -1475,7 +1485,7 @@ await client.crm.customObjectClasses.retrieve("id");
-**request:** `Merge.crm.CustomObjectClassesRetrieveRequest` +**request:** `Merge.ats.PatchedCandidateEndpointRequest`
@@ -1483,7 +1493,7 @@ await client.crm.customObjectClasses.retrieve("id");
-**requestOptions:** `CustomObjectClasses.RequestOptions` +**requestOptions:** `Candidates.RequestOptions`
@@ -1494,9 +1504,7 @@ await client.crm.customObjectClasses.retrieve("id");
-## Crm AssociationTypes - -
client.crm.associationTypes.customObjectClassesAssociationTypesList(customObjectClassId, { ...params }) -> Merge.PaginatedAssociationTypeList +
client.ats.candidates.ignoreCreate(modelId, { ...params }) -> void
@@ -1508,7 +1516,7 @@ await client.crm.customObjectClasses.retrieve("id");
-Returns a list of `AssociationType` 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.
@@ -1524,7 +1532,9 @@ Returns a list of `AssociationType` objects.
```typescript -await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id"); +await client.ats.candidates.ignoreCreate("model_id", { + reason: "GENERAL_CUSTOMER_REQUEST", +}); ```
@@ -1540,7 +1550,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-**customObjectClassId:** `string` +**modelId:** `string`
@@ -1548,7 +1558,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest` +**request:** `Merge.ats.IgnoreCommonModelRequest`
@@ -1556,7 +1566,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-**requestOptions:** `AssociationTypes.RequestOptions` +**requestOptions:** `Candidates.RequestOptions`
@@ -1567,7 +1577,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-
client.crm.associationTypes.customObjectClassesAssociationTypesCreate(customObjectClassId, { ...params }) -> Merge.CrmAssociationTypeResponse +
client.ats.candidates.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -1579,7 +1589,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-Creates an `AssociationType` object with the given values. +Returns metadata for `Candidate` PATCHs.
@@ -1595,21 +1605,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.ats.candidates.metaPatchRetrieve("id"); ```
@@ -1625,15 +1621,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-**customObjectClassId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CrmAssociationTypeEndpointRequest` +**id:** `string`
@@ -1641,7 +1629,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-**requestOptions:** `AssociationTypes.RequestOptions` +**requestOptions:** `Candidates.RequestOptions`
@@ -1652,7 +1640,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-
client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(customObjectClassId, id, { ...params }) -> Merge.AssociationType +
client.ats.candidates.metaPostRetrieve() -> Merge.MetaResponse
@@ -1664,7 +1652,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-Returns an `AssociationType` object with the given `id`. +Returns metadata for `Candidate` POSTs.
@@ -1680,7 +1668,7 @@ Returns an `AssociationType` object with the given `id`.
```typescript -await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id"); +await client.ats.candidates.metaPostRetrieve(); ```
@@ -1696,31 +1684,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-**customObjectClassId:** `string` - -
-
- -
-
- -**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `AssociationTypes.RequestOptions` +**requestOptions:** `Candidates.RequestOptions`
@@ -1731,7 +1695,9 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-
client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse +## Ats Scopes + +
client.ats.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -1743,7 +1709,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-Returns metadata for `CRMAssociationType` POSTs. +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).
@@ -1759,7 +1725,7 @@ Returns metadata for `CRMAssociationType` POSTs.
```typescript -await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id"); +await client.ats.scopes.defaultScopesRetrieve(); ```
@@ -1775,15 +1741,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-**customObjectClassId:** `string` - -
-
- -
-
- -**requestOptions:** `AssociationTypes.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -1794,9 +1752,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-## Crm CustomObjects - -
client.crm.customObjects.customObjectClassesCustomObjectsList(customObjectClassId, { ...params }) -> Merge.PaginatedCustomObjectList +
client.ats.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -1808,7 +1764,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-Returns a list of `CustomObject` 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).
@@ -1824,7 +1780,7 @@ Returns a list of `CustomObject` objects.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id"); +await client.ats.scopes.linkedAccountScopesRetrieve(); ```
@@ -1840,23 +1796,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-**customObjectClassId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest` - -
-
- -
-
- -**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -1867,7 +1807,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-
client.crm.customObjects.customObjectClassesCustomObjectsCreate(customObjectClassId, { ...params }) -> Merge.CrmCustomObjectResponse +
client.ats.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
@@ -1879,7 +1819,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-Creates a `CustomObject` object with the given values. +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)
@@ -1895,12 +1835,32 @@ 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.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, + }, + }, + }, + ], }); ``` @@ -1917,7 +1877,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-**customObjectClassId:** `string` +**request:** `Merge.ats.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -1925,15 +1885,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-**request:** `Merge.crm.CrmCustomObjectEndpointRequest` - -
-
- -
-
- -**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -1944,7 +1896,9 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-
client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(customObjectClassId, id, { ...params }) -> Merge.CustomObject +## Ats DeleteAccount + +
client.ats.deleteAccount.delete() -> void
@@ -1956,7 +1910,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-Returns a `CustomObject` object with the given `id`. +Delete a linked account.
@@ -1972,7 +1926,7 @@ Returns a `CustomObject` object with the given `id`.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id"); +await client.ats.deleteAccount.delete(); ```
@@ -1988,31 +1942,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-**customObjectClassId:** `string` - -
-
- -
-
- -**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `DeleteAccount.RequestOptions`
@@ -2023,7 +1953,9 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-
client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse +## Ats Departments + +
client.ats.departments.list({ ...params }) -> Merge.PaginatedDepartmentList
@@ -2035,7 +1967,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-Returns metadata for `CRMCustomObject` POSTs. +Returns a list of `Department` objects.
@@ -2051,7 +1983,7 @@ Returns metadata for `CRMCustomObject` POSTs.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id"); +await client.ats.departments.list(); ```
@@ -2067,7 +1999,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-**customObjectClassId:** `string` +**request:** `Merge.ats.DepartmentsListRequest`
@@ -2075,7 +2007,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `Departments.RequestOptions`
@@ -2086,7 +2018,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-
client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.ats.departments.retrieve(id, { ...params }) -> Merge.Department
@@ -2098,7 +2030,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-Returns a list of `RemoteFieldClass` objects. +Returns a `Department` object with the given `id`.
@@ -2114,7 +2046,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList(); +await client.ats.departments.retrieve("id"); ```
@@ -2130,7 +2062,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest` +**id:** `string`
@@ -2138,7 +2070,15 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-**requestOptions:** `CustomObjects.RequestOptions` +**request:** `Merge.ats.DepartmentsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Departments.RequestOptions`
@@ -2149,9 +2089,9 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-## Crm Associations +## Ats Eeocs -
client.crm.associations.customObjectClassesCustomObjectsAssociationsList(customObjectClassId, objectId, { ...params }) -> Merge.PaginatedAssociationList +
client.ats.eeocs.list({ ...params }) -> Merge.PaginatedEeocList
@@ -2163,7 +2103,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-Returns a list of `Association` objects. +Returns a list of `EEOC` objects.
@@ -2179,7 +2119,7 @@ Returns a list of `Association` objects.
```typescript -await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id"); +await client.ats.eeocs.list(); ```
@@ -2195,23 +2135,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-**customObjectClassId:** `string` - -
-
- -
-
- -**objectId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest` +**request:** `Merge.ats.EeocsListRequest`
@@ -2219,7 +2143,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-**requestOptions:** `Associations.RequestOptions` +**requestOptions:** `Eeocs.RequestOptions`
@@ -2230,7 +2154,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-
client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(associationTypeId, sourceClassId, sourceObjectId, targetClassId, targetObjectId, { ...params }) -> Merge.Association +
client.ats.eeocs.retrieve(id, { ...params }) -> Merge.Eeoc
@@ -2242,7 +2166,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`. +Returns an `EEOC` object with the given `id`.
@@ -2258,13 +2182,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.ats.eeocs.retrieve("id"); ```
@@ -2280,7 +2198,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-**associationTypeId:** `string` +**id:** `string`
@@ -2288,7 +2206,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-**sourceClassId:** `string` +**request:** `Merge.ats.EeocsRetrieveRequest`
@@ -2296,31 +2214,64 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-**sourceObjectId:** `string` +**requestOptions:** `Eeocs.RequestOptions`
+ +
+ + + +
+ +## Ats FieldMapping +
client.ats.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
-**targetClassId:** `string` +#### 📝 Description + +
+
+ +
+
+ +Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+ +#### 🔌 Usage
-**targetObjectId:** `string` +
+
+ +```typescript +await client.ats.fieldMapping.fieldMappingsRetrieve(); +``` +
+
+#### ⚙️ Parameters +
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest` +
+
+ +**request:** `Merge.ats.FieldMappingsRetrieveRequest`
@@ -2328,7 +2279,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-**requestOptions:** `Associations.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -2339,9 +2290,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-## Crm Scopes - -
client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi +
client.ats.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
@@ -2353,7 +2302,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). +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.
@@ -2369,7 +2318,14 @@ Get the default permissions for Merge Common Models and fields across all Linked
```typescript -await client.crm.scopes.defaultScopesRetrieve(); +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", +}); ```
@@ -2385,7 +2341,15 @@ await client.crm.scopes.defaultScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**request:** `Merge.ats.CreateFieldMappingRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -2396,7 +2360,7 @@ await client.crm.scopes.defaultScopesRetrieve();
-
client.crm.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi +
client.ats.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
@@ -2408,7 +2372,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). +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.
@@ -2424,7 +2388,7 @@ Get all available permissions for Merge Common Models and fields for a single Li
```typescript -await client.crm.scopes.linkedAccountScopesRetrieve(); +await client.ats.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
@@ -2440,7 +2404,15 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**fieldMappingId:** `string` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -2451,7 +2423,7 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-
client.crm.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi +
client.ats.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
@@ -2463,7 +2435,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) +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.
@@ -2479,33 +2451,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.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); ```
@@ -2521,7 +2467,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest` +**fieldMappingId:** `string`
@@ -2529,7 +2475,15 @@ await client.crm.scopes.linkedAccountScopesCreate({
-**requestOptions:** `Scopes.RequestOptions` +**request:** `Merge.ats.PatchedEditFieldMappingRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -2540,9 +2494,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-## Crm DeleteAccount - -
client.crm.deleteAccount.delete() -> void +
client.ats.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
@@ -2554,7 +2506,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-Delete a linked account. +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -2570,7 +2522,7 @@ Delete a linked account.
```typescript -await client.crm.deleteAccount.delete(); +await client.ats.fieldMapping.remoteFieldsRetrieve(); ```
@@ -2586,7 +2538,15 @@ await client.crm.deleteAccount.delete();
-**requestOptions:** `DeleteAccount.RequestOptions` +**request:** `Merge.ats.RemoteFieldsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -2597,9 +2557,7 @@ await client.crm.deleteAccount.delete();
-## Crm EngagementTypes - -
client.crm.engagementTypes.list({ ...params }) -> Merge.PaginatedEngagementTypeList +
client.ats.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
@@ -2611,7 +2569,7 @@ await client.crm.deleteAccount.delete();
-Returns a list of `EngagementType` objects. +Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -2627,7 +2585,7 @@ Returns a list of `EngagementType` objects.
```typescript -await client.crm.engagementTypes.list(); +await client.ats.fieldMapping.targetFieldsRetrieve(); ```
@@ -2643,15 +2601,7 @@ await client.crm.engagementTypes.list();
-**request:** `Merge.crm.EngagementTypesListRequest` - -
-
- -
-
- -**requestOptions:** `EngagementTypes.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -2662,7 +2612,9 @@ await client.crm.engagementTypes.list();
-
client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType +## Ats GenerateKey + +
client.ats.generateKey.create({ ...params }) -> Merge.RemoteKey
@@ -2674,7 +2626,7 @@ await client.crm.engagementTypes.list();
-Returns an `EngagementType` object with the given `id`. +Create a remote key.
@@ -2690,7 +2642,9 @@ Returns an `EngagementType` object with the given `id`.
```typescript -await client.crm.engagementTypes.retrieve("id"); +await client.ats.generateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -2706,15 +2660,7 @@ await client.crm.engagementTypes.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.EngagementTypesRetrieveRequest` +**request:** `Merge.ats.GenerateRemoteKeyRequest`
@@ -2722,7 +2668,7 @@ await client.crm.engagementTypes.retrieve("id");
-**requestOptions:** `EngagementTypes.RequestOptions` +**requestOptions:** `GenerateKey.RequestOptions`
@@ -2733,7 +2679,9 @@ await client.crm.engagementTypes.retrieve("id");
-
client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Ats Interviews + +
client.ats.interviews.list({ ...params }) -> Merge.PaginatedScheduledInterviewList
@@ -2745,7 +2693,7 @@ await client.crm.engagementTypes.retrieve("id");
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `ScheduledInterview` objects.
@@ -2761,7 +2709,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.engagementTypes.remoteFieldClassesList(); +await client.ats.interviews.list(); ```
@@ -2777,7 +2725,7 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest` +**request:** `Merge.ats.InterviewsListRequest`
@@ -2785,7 +2733,7 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-**requestOptions:** `EngagementTypes.RequestOptions` +**requestOptions:** `Interviews.RequestOptions`
@@ -2796,9 +2744,7 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-## Crm Engagements - -
client.crm.engagements.list({ ...params }) -> Merge.PaginatedEngagementList +
client.ats.interviews.create({ ...params }) -> Merge.ScheduledInterviewResponse
@@ -2810,7 +2756,7 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-Returns a list of `Engagement` objects. +Creates a `ScheduledInterview` object with the given values.
@@ -2826,7 +2772,10 @@ Returns a list of `Engagement` objects.
```typescript -await client.crm.engagements.list(); +await client.ats.interviews.create({ + model: {}, + remoteUserId: "remote_user_id", +}); ```
@@ -2842,7 +2791,7 @@ await client.crm.engagements.list();
-**request:** `Merge.crm.EngagementsListRequest` +**request:** `Merge.ats.ScheduledInterviewEndpointRequest`
@@ -2850,7 +2799,7 @@ await client.crm.engagements.list();
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Interviews.RequestOptions`
@@ -2861,7 +2810,7 @@ await client.crm.engagements.list();
-
client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse +
client.ats.interviews.retrieve(id, { ...params }) -> Merge.ScheduledInterview
@@ -2873,7 +2822,7 @@ await client.crm.engagements.list();
-Creates an `Engagement` object with the given values. +Returns a `ScheduledInterview` object with the given `id`.
@@ -2889,9 +2838,7 @@ Creates an `Engagement` object with the given values.
```typescript -await client.crm.engagements.create({ - model: {}, -}); +await client.ats.interviews.retrieve("id"); ```
@@ -2907,7 +2854,7 @@ await client.crm.engagements.create({
-**request:** `Merge.crm.EngagementEndpointRequest` +**id:** `string`
@@ -2915,7 +2862,15 @@ await client.crm.engagements.create({
-**requestOptions:** `Engagements.RequestOptions` +**request:** `Merge.ats.InterviewsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Interviews.RequestOptions`
@@ -2926,7 +2881,7 @@ await client.crm.engagements.create({
-
client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement +
client.ats.interviews.metaPostRetrieve() -> Merge.MetaResponse
@@ -2938,7 +2893,7 @@ await client.crm.engagements.create({
-Returns an `Engagement` object with the given `id`. +Returns metadata for `ScheduledInterview` POSTs.
@@ -2954,7 +2909,7 @@ Returns an `Engagement` object with the given `id`.
```typescript -await client.crm.engagements.retrieve("id"); +await client.ats.interviews.metaPostRetrieve(); ```
@@ -2970,23 +2925,7 @@ await client.crm.engagements.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.EngagementsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Interviews.RequestOptions`
@@ -2997,7 +2936,9 @@ await client.crm.engagements.retrieve("id");
-
client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse +## Ats Issues + +
client.ats.issues.list({ ...params }) -> Merge.PaginatedIssueList
@@ -3009,7 +2950,7 @@ await client.crm.engagements.retrieve("id");
-Updates an `Engagement` object with the given `id`. +Gets all issues for Organization.
@@ -3025,9 +2966,7 @@ Updates an `Engagement` object with the given `id`.
```typescript -await client.crm.engagements.partialUpdate("id", { - model: {}, -}); +await client.ats.issues.list(); ```
@@ -3043,15 +2982,7 @@ await client.crm.engagements.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedEngagementEndpointRequest` +**request:** `Merge.ats.IssuesListRequest`
@@ -3059,7 +2990,7 @@ await client.crm.engagements.partialUpdate("id", {
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -3070,7 +3001,7 @@ await client.crm.engagements.partialUpdate("id", {
-
client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse +
client.ats.issues.retrieve(id) -> Merge.Issue
@@ -3082,7 +3013,7 @@ await client.crm.engagements.partialUpdate("id", {
-Returns metadata for `Engagement` PATCHs. +Get a specific issue.
@@ -3098,7 +3029,7 @@ Returns metadata for `Engagement` PATCHs.
```typescript -await client.crm.engagements.metaPatchRetrieve("id"); +await client.ats.issues.retrieve("id"); ```
@@ -3122,7 +3053,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -3133,7 +3064,9 @@ await client.crm.engagements.metaPatchRetrieve("id");
-
client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse +## Ats JobInterviewStages + +
client.ats.jobInterviewStages.list({ ...params }) -> Merge.PaginatedJobInterviewStageList
@@ -3145,7 +3078,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-Returns metadata for `Engagement` POSTs. +Returns a list of `JobInterviewStage` objects.
@@ -3161,7 +3094,7 @@ Returns metadata for `Engagement` POSTs.
```typescript -await client.crm.engagements.metaPostRetrieve(); +await client.ats.jobInterviewStages.list(); ```
@@ -3177,7 +3110,15 @@ await client.crm.engagements.metaPostRetrieve();
-**requestOptions:** `Engagements.RequestOptions` +**request:** `Merge.ats.JobInterviewStagesListRequest` + +
+
+ +
+
+ +**requestOptions:** `JobInterviewStages.RequestOptions`
@@ -3188,7 +3129,7 @@ await client.crm.engagements.metaPostRetrieve();
-
client.crm.engagements.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.ats.jobInterviewStages.retrieve(id, { ...params }) -> Merge.JobInterviewStage
@@ -3200,7 +3141,7 @@ await client.crm.engagements.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Returns a `JobInterviewStage` object with the given `id`.
@@ -3216,7 +3157,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.engagements.remoteFieldClassesList(); +await client.ats.jobInterviewStages.retrieve("id"); ```
@@ -3232,7 +3173,7 @@ await client.crm.engagements.remoteFieldClassesList();
-**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest` +**id:** `string`
@@ -3240,7 +3181,15 @@ await client.crm.engagements.remoteFieldClassesList();
-**requestOptions:** `Engagements.RequestOptions` +**request:** `Merge.ats.JobInterviewStagesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `JobInterviewStages.RequestOptions`
@@ -3251,9 +3200,9 @@ await client.crm.engagements.remoteFieldClassesList();
-## Crm FieldMapping +## Ats JobPostings -
client.crm.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse +
client.ats.jobPostings.list({ ...params }) -> Merge.PaginatedJobPostingList
@@ -3265,7 +3214,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 `JobPosting` objects.
@@ -3281,7 +3230,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```typescript -await client.crm.fieldMapping.fieldMappingsRetrieve(); +await client.ats.jobPostings.list(); ```
@@ -3297,7 +3246,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-**request:** `Merge.crm.FieldMappingsRetrieveRequest` +**request:** `Merge.ats.JobPostingsListRequest`
@@ -3305,7 +3254,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `JobPostings.RequestOptions`
@@ -3316,7 +3265,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-
client.crm.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse +
client.ats.jobPostings.retrieve(id, { ...params }) -> Merge.JobPosting
@@ -3328,7 +3277,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 `JobPosting` object with the given `id`.
@@ -3344,14 +3293,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.ats.jobPostings.retrieve("id"); ```
@@ -3367,7 +3309,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-**request:** `Merge.crm.CreateFieldMappingRequest` +**id:** `string`
@@ -3375,7 +3317,15 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.ats.JobPostingsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `JobPostings.RequestOptions`
@@ -3386,7 +3336,9 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-
client.crm.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse +## Ats Jobs + +
client.ats.jobs.list({ ...params }) -> Merge.PaginatedJobList
@@ -3398,7 +3350,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 `Job` objects.
@@ -3414,7 +3366,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.ats.jobs.list(); ```
@@ -3430,7 +3382,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**fieldMappingId:** `string` +**request:** `Merge.ats.JobsListRequest`
@@ -3438,7 +3390,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Jobs.RequestOptions`
@@ -3449,7 +3401,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
client.crm.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse +
client.ats.jobs.retrieve(id, { ...params }) -> Merge.Job
@@ -3461,7 +3413,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. +Returns a `Job` object with the given `id`.
@@ -3477,7 +3429,7 @@ 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.ats.jobs.retrieve("id"); ```
@@ -3493,7 +3445,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**fieldMappingId:** `string` +**id:** `string`
@@ -3501,7 +3453,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**request:** `Merge.crm.PatchedEditFieldMappingRequest` +**request:** `Merge.ats.JobsRetrieveRequest`
@@ -3509,7 +3461,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Jobs.RequestOptions`
@@ -3520,7 +3472,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
client.crm.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse +
client.ats.jobs.screeningQuestionsList(jobId, { ...params }) -> Merge.PaginatedScreeningQuestionList
@@ -3532,7 +3484,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 list of `ScreeningQuestion` objects.
@@ -3548,7 +3500,7 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```typescript -await client.crm.fieldMapping.remoteFieldsRetrieve(); +await client.ats.jobs.screeningQuestionsList("job_id"); ```
@@ -3564,7 +3516,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-**request:** `Merge.crm.RemoteFieldsRetrieveRequest` +**jobId:** `string`
@@ -3572,7 +3524,15 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.ats.JobsScreeningQuestionsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Jobs.RequestOptions`
@@ -3583,7 +3543,9 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-
client.crm.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse +## Ats LinkToken + +
client.ats.linkToken.create({ ...params }) -> Merge.LinkToken
@@ -3595,7 +3557,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/). +Creates a link token to be used when linking a new end user.
@@ -3611,7 +3573,12 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```typescript -await client.crm.fieldMapping.targetFieldsRetrieve(); +await client.ats.linkToken.create({ + endUserEmailAddress: "example@gmail.com", + endUserOrganizationName: "Test Organization", + endUserOriginId: "12345", + categories: ["hris", "ats"], +}); ```
@@ -3627,7 +3594,15 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.ats.EndUserDetailsRequest` + +
+
+ +
+
+ +**requestOptions:** `LinkToken.RequestOptions`
@@ -3638,9 +3613,9 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-## Crm GenerateKey +## Ats LinkedAccounts -
client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey +
client.ats.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
@@ -3652,7 +3627,7 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-Create a remote key. +List linked accounts for your organization.
@@ -3668,9 +3643,7 @@ Create a remote key.
```typescript -await client.crm.generateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.ats.linkedAccounts.list(); ```
@@ -3686,7 +3659,7 @@ await client.crm.generateKey.create({
-**request:** `Merge.crm.GenerateRemoteKeyRequest` +**request:** `Merge.ats.LinkedAccountsListRequest`
@@ -3694,7 +3667,7 @@ await client.crm.generateKey.create({
-**requestOptions:** `GenerateKey.RequestOptions` +**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -3705,9 +3678,9 @@ await client.crm.generateKey.create({
-## Crm Issues +## Ats Offers -
client.crm.issues.list({ ...params }) -> Merge.PaginatedIssueList +
client.ats.offers.list({ ...params }) -> Merge.PaginatedOfferList
@@ -3719,7 +3692,7 @@ await client.crm.generateKey.create({
-Gets all issues for Organization. +Returns a list of `Offer` objects.
@@ -3735,7 +3708,7 @@ Gets all issues for Organization.
```typescript -await client.crm.issues.list(); +await client.ats.offers.list(); ```
@@ -3751,7 +3724,7 @@ await client.crm.issues.list();
-**request:** `Merge.crm.IssuesListRequest` +**request:** `Merge.ats.OffersListRequest`
@@ -3759,7 +3732,7 @@ await client.crm.issues.list();
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `Offers.RequestOptions`
@@ -3770,7 +3743,7 @@ await client.crm.issues.list();
-
client.crm.issues.retrieve(id) -> Merge.Issue +
client.ats.offers.retrieve(id, { ...params }) -> Merge.Offer
@@ -3782,7 +3755,7 @@ await client.crm.issues.list();
-Get a specific issue. +Returns an `Offer` object with the given `id`.
@@ -3798,7 +3771,7 @@ Get a specific issue.
```typescript -await client.crm.issues.retrieve("id"); +await client.ats.offers.retrieve("id"); ```
@@ -3822,7 +3795,15 @@ await client.crm.issues.retrieve("id");
-**requestOptions:** `Issues.RequestOptions` +**request:** `Merge.ats.OffersRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Offers.RequestOptions`
@@ -3833,9 +3814,9 @@ await client.crm.issues.retrieve("id");
-## Crm Leads +## Ats Offices -
client.crm.leads.list({ ...params }) -> Merge.PaginatedLeadList +
client.ats.offices.list({ ...params }) -> Merge.PaginatedOfficeList
@@ -3847,7 +3828,7 @@ await client.crm.issues.retrieve("id");
-Returns a list of `Lead` objects. +Returns a list of `Office` objects.
@@ -3863,7 +3844,7 @@ Returns a list of `Lead` objects.
```typescript -await client.crm.leads.list(); +await client.ats.offices.list(); ```
@@ -3879,7 +3860,7 @@ await client.crm.leads.list();
-**request:** `Merge.crm.LeadsListRequest` +**request:** `Merge.ats.OfficesListRequest`
@@ -3887,7 +3868,7 @@ await client.crm.leads.list();
-**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `Offices.RequestOptions`
@@ -3898,7 +3879,7 @@ await client.crm.leads.list();
-
client.crm.leads.create({ ...params }) -> Merge.LeadResponse +
client.ats.offices.retrieve(id, { ...params }) -> Merge.Office
@@ -3910,7 +3891,7 @@ await client.crm.leads.list();
-Creates a `Lead` object with the given values. +Returns an `Office` object with the given `id`.
@@ -3926,9 +3907,7 @@ Creates a `Lead` object with the given values.
```typescript -await client.crm.leads.create({ - model: {}, -}); +await client.ats.offices.retrieve("id"); ```
@@ -3944,7 +3923,7 @@ await client.crm.leads.create({
-**request:** `Merge.crm.LeadEndpointRequest` +**id:** `string`
@@ -3952,7 +3931,15 @@ await client.crm.leads.create({
-**requestOptions:** `Leads.RequestOptions` +**request:** `Merge.ats.OfficesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Offices.RequestOptions`
@@ -3963,7 +3950,9 @@ await client.crm.leads.create({
-
client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead +## Ats Passthrough + +
client.ats.passthrough.create({ ...params }) -> Merge.RemoteResponse
@@ -3975,7 +3964,7 @@ await client.crm.leads.create({
-Returns a `Lead` object with the given `id`. +Pull data from an endpoint not currently supported by Merge.
@@ -3991,7 +3980,10 @@ Returns a `Lead` object with the given `id`.
```typescript -await client.crm.leads.retrieve("id"); +await client.ats.passthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -4007,15 +3999,7 @@ await client.crm.leads.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.LeadsRetrieveRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -4023,7 +4007,7 @@ await client.crm.leads.retrieve("id");
-**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `Passthrough.RequestOptions`
@@ -4034,7 +4018,9 @@ await client.crm.leads.retrieve("id");
-
client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse +## Ats RegenerateKey + +
client.ats.regenerateKey.create({ ...params }) -> Merge.RemoteKey
@@ -4046,7 +4032,7 @@ await client.crm.leads.retrieve("id");
-Returns metadata for `Lead` POSTs. +Exchange remote keys.
@@ -4062,7 +4048,9 @@ Returns metadata for `Lead` POSTs.
```typescript -await client.crm.leads.metaPostRetrieve(); +await client.ats.regenerateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -4078,7 +4066,15 @@ await client.crm.leads.metaPostRetrieve();
-**requestOptions:** `Leads.RequestOptions` +**request:** `Merge.ats.RemoteKeyForRegenerationRequest` + +
+
+ +
+
+ +**requestOptions:** `RegenerateKey.RequestOptions`
@@ -4089,7 +4085,9 @@ await client.crm.leads.metaPostRetrieve();
-
client.crm.leads.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Ats RejectReasons + +
client.ats.rejectReasons.list({ ...params }) -> Merge.PaginatedRejectReasonList
@@ -4101,7 +4099,7 @@ await client.crm.leads.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `RejectReason` objects.
@@ -4117,7 +4115,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.leads.remoteFieldClassesList(); +await client.ats.rejectReasons.list(); ```
@@ -4133,7 +4131,7 @@ await client.crm.leads.remoteFieldClassesList();
-**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest` +**request:** `Merge.ats.RejectReasonsListRequest`
@@ -4141,7 +4139,7 @@ await client.crm.leads.remoteFieldClassesList();
-**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `RejectReasons.RequestOptions`
@@ -4152,9 +4150,7 @@ await client.crm.leads.remoteFieldClassesList();
-## Crm LinkToken - -
client.crm.linkToken.create({ ...params }) -> Merge.LinkToken +
client.ats.rejectReasons.retrieve(id, { ...params }) -> Merge.RejectReason
@@ -4166,7 +4162,7 @@ await client.crm.leads.remoteFieldClassesList();
-Creates a link token to be used when linking a new end user. +Returns a `RejectReason` object with the given `id`.
@@ -4182,12 +4178,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.ats.rejectReasons.retrieve("id"); ```
@@ -4203,7 +4194,7 @@ await client.crm.linkToken.create({
-**request:** `Merge.crm.EndUserDetailsRequest` +**id:** `string`
@@ -4211,7 +4202,15 @@ await client.crm.linkToken.create({
-**requestOptions:** `LinkToken.RequestOptions` +**request:** `Merge.ats.RejectReasonsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `RejectReasons.RequestOptions`
@@ -4222,9 +4221,9 @@ await client.crm.linkToken.create({
-## Crm LinkedAccounts +## Ats Scorecards -
client.crm.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList +
client.ats.scorecards.list({ ...params }) -> Merge.PaginatedScorecardList
@@ -4236,7 +4235,7 @@ await client.crm.linkToken.create({
-List linked accounts for your organization. +Returns a list of `Scorecard` objects.
@@ -4252,7 +4251,7 @@ List linked accounts for your organization.
```typescript -await client.crm.linkedAccounts.list(); +await client.ats.scorecards.list(); ```
@@ -4268,7 +4267,7 @@ await client.crm.linkedAccounts.list();
-**request:** `Merge.crm.LinkedAccountsListRequest` +**request:** `Merge.ats.ScorecardsListRequest`
@@ -4276,7 +4275,7 @@ await client.crm.linkedAccounts.list();
-**requestOptions:** `LinkedAccounts.RequestOptions` +**requestOptions:** `Scorecards.RequestOptions`
@@ -4287,9 +4286,7 @@ await client.crm.linkedAccounts.list();
-## Crm Notes - -
client.crm.notes.list({ ...params }) -> Merge.PaginatedNoteList +
client.ats.scorecards.retrieve(id, { ...params }) -> Merge.Scorecard
@@ -4301,7 +4298,7 @@ await client.crm.linkedAccounts.list();
-Returns a list of `Note` objects. +Returns a `Scorecard` object with the given `id`.
@@ -4317,7 +4314,7 @@ Returns a list of `Note` objects.
```typescript -await client.crm.notes.list(); +await client.ats.scorecards.retrieve("id"); ```
@@ -4333,7 +4330,7 @@ await client.crm.notes.list();
-**request:** `Merge.crm.NotesListRequest` +**id:** `string`
@@ -4341,7 +4338,15 @@ await client.crm.notes.list();
-**requestOptions:** `Notes.RequestOptions` +**request:** `Merge.ats.ScorecardsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Scorecards.RequestOptions`
@@ -4352,7 +4357,9 @@ await client.crm.notes.list();
-
client.crm.notes.create({ ...params }) -> Merge.NoteResponse +## Ats SyncStatus + +
client.ats.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
@@ -4364,7 +4371,7 @@ await client.crm.notes.list();
-Creates a `Note` object with the given values. +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).
@@ -4380,9 +4387,7 @@ Creates a `Note` object with the given values.
```typescript -await client.crm.notes.create({ - model: {}, -}); +await client.ats.syncStatus.list(); ```
@@ -4398,7 +4403,7 @@ await client.crm.notes.create({
-**request:** `Merge.crm.NoteEndpointRequest` +**request:** `Merge.ats.SyncStatusListRequest`
@@ -4406,7 +4411,7 @@ await client.crm.notes.create({
-**requestOptions:** `Notes.RequestOptions` +**requestOptions:** `SyncStatus.RequestOptions`
@@ -4417,7 +4422,9 @@ await client.crm.notes.create({
-
client.crm.notes.retrieve(id, { ...params }) -> Merge.Note +## Ats ForceResync + +
client.ats.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
@@ -4429,7 +4436,7 @@ await client.crm.notes.create({
-Returns a `Note` object with the given `id`. +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.
@@ -4445,7 +4452,7 @@ Returns a `Note` object with the given `id`.
```typescript -await client.crm.notes.retrieve("id"); +await client.ats.forceResync.syncStatusResyncCreate(); ```
@@ -4461,38 +4468,39 @@ await client.crm.notes.retrieve("id");
-**id:** `string` +**requestOptions:** `ForceResync.RequestOptions` + +
+
+ +
+
+ +## Ats Tags +
client.ats.tags.list({ ...params }) -> Merge.PaginatedTagList
-**request:** `Merge.crm.NotesRetrieveRequest` +#### 📝 Description -
-
+
+
-**requestOptions:** `Notes.RequestOptions` +Returns a list of `Tag` objects.
- - -
- -
client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse -
-
- -#### 📝 Description +#### 🔌 Usage
@@ -4500,14 +4508,16 @@ await client.crm.notes.retrieve("id");
-Returns metadata for `Note` POSTs. +```typescript +await client.ats.tags.list(); +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -4515,24 +4525,15 @@ Returns metadata for `Note` POSTs.
-```typescript -await client.crm.notes.metaPostRetrieve(); -``` +**request:** `Merge.ats.TagsListRequest` -
-
-#### ⚙️ Parameters - -
-
-
-**requestOptions:** `Notes.RequestOptions` +**requestOptions:** `Tags.RequestOptions`
@@ -4543,7 +4544,9 @@ await client.crm.notes.metaPostRetrieve();
-
client.crm.notes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Ats Users + +
client.ats.users.list({ ...params }) -> Merge.PaginatedRemoteUserList
@@ -4555,7 +4558,7 @@ await client.crm.notes.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `RemoteUser` objects.
@@ -4571,7 +4574,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.notes.remoteFieldClassesList(); +await client.ats.users.list(); ```
@@ -4587,7 +4590,7 @@ await client.crm.notes.remoteFieldClassesList();
-**request:** `Merge.crm.NotesRemoteFieldClassesListRequest` +**request:** `Merge.ats.UsersListRequest`
@@ -4595,7 +4598,7 @@ await client.crm.notes.remoteFieldClassesList();
-**requestOptions:** `Notes.RequestOptions` +**requestOptions:** `Users.RequestOptions`
@@ -4606,9 +4609,7 @@ await client.crm.notes.remoteFieldClassesList();
-## Crm Opportunities - -
client.crm.opportunities.list({ ...params }) -> Merge.PaginatedOpportunityList +
client.ats.users.retrieve(id, { ...params }) -> Merge.RemoteUser
@@ -4620,7 +4621,7 @@ await client.crm.notes.remoteFieldClassesList();
-Returns a list of `Opportunity` objects. +Returns a `RemoteUser` object with the given `id`.
@@ -4636,7 +4637,7 @@ Returns a list of `Opportunity` objects.
```typescript -await client.crm.opportunities.list(); +await client.ats.users.retrieve("id"); ```
@@ -4652,7 +4653,7 @@ await client.crm.opportunities.list();
-**request:** `Merge.crm.OpportunitiesListRequest` +**id:** `string`
@@ -4660,7 +4661,15 @@ await client.crm.opportunities.list();
-**requestOptions:** `Opportunities.RequestOptions` +**request:** `Merge.ats.UsersRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions`
@@ -4671,7 +4680,9 @@ await client.crm.opportunities.list();
-
client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse +## Ats WebhookReceivers + +
client.ats.webhookReceivers.list() -> Merge.WebhookReceiver[]
@@ -4683,7 +4694,7 @@ await client.crm.opportunities.list();
-Creates an `Opportunity` object with the given values. +Returns a list of `WebhookReceiver` objects.
@@ -4699,9 +4710,7 @@ Creates an `Opportunity` object with the given values.
```typescript -await client.crm.opportunities.create({ - model: {}, -}); +await client.ats.webhookReceivers.list(); ```
@@ -4717,15 +4726,7 @@ await client.crm.opportunities.create({
-**request:** `Merge.crm.OpportunityEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -4736,7 +4737,7 @@ await client.crm.opportunities.create({
-
client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity +
client.ats.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
@@ -4748,7 +4749,7 @@ await client.crm.opportunities.create({
-Returns an `Opportunity` object with the given `id`. +Creates a `WebhookReceiver` object with the given values.
@@ -4764,7 +4765,10 @@ Returns an `Opportunity` object with the given `id`.
```typescript -await client.crm.opportunities.retrieve("id"); +await client.ats.webhookReceivers.create({ + event: "event", + isActive: true, +}); ```
@@ -4780,15 +4784,7 @@ await client.crm.opportunities.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.OpportunitiesRetrieveRequest` +**request:** `Merge.ats.WebhookReceiverRequest`
@@ -4796,7 +4792,7 @@ await client.crm.opportunities.retrieve("id");
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -4807,7 +4803,9 @@ await client.crm.opportunities.retrieve("id");
-
client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse +## Crm AccountDetails + +
client.crm.accountDetails.retrieve() -> Merge.AccountDetails
@@ -4819,7 +4817,7 @@ await client.crm.opportunities.retrieve("id");
-Updates an `Opportunity` object with the given `id`. +Get details for a linked account.
@@ -4835,9 +4833,7 @@ Updates an `Opportunity` object with the given `id`.
```typescript -await client.crm.opportunities.partialUpdate("id", { - model: {}, -}); +await client.crm.accountDetails.retrieve(); ```
@@ -4853,23 +4849,7 @@ await client.crm.opportunities.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedOpportunityEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `AccountDetails.RequestOptions`
@@ -4880,7 +4860,9 @@ await client.crm.opportunities.partialUpdate("id", {
-
client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse +## Crm AccountToken + +
client.crm.accountToken.retrieve(publicToken) -> Merge.AccountToken
@@ -4892,7 +4874,7 @@ await client.crm.opportunities.partialUpdate("id", {
-Returns metadata for `Opportunity` PATCHs. +Returns the account token for the end user with the provided public token.
@@ -4908,7 +4890,7 @@ Returns metadata for `Opportunity` PATCHs.
```typescript -await client.crm.opportunities.metaPatchRetrieve("id"); +await client.crm.accountToken.retrieve("public_token"); ```
@@ -4924,7 +4906,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-**id:** `string` +**publicToken:** `string`
@@ -4932,7 +4914,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `AccountToken.RequestOptions`
@@ -4943,7 +4925,9 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-
client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse +## Crm Accounts + +
client.crm.accounts.list({ ...params }) -> Merge.PaginatedAccountList
@@ -4955,7 +4939,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-Returns metadata for `Opportunity` POSTs. +Returns a list of `Account` objects.
@@ -4971,7 +4955,7 @@ Returns metadata for `Opportunity` POSTs.
```typescript -await client.crm.opportunities.metaPostRetrieve(); +await client.crm.accounts.list(); ```
@@ -4987,7 +4971,15 @@ await client.crm.opportunities.metaPostRetrieve();
-**requestOptions:** `Opportunities.RequestOptions` +**request:** `Merge.crm.AccountsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -4998,7 +4990,7 @@ await client.crm.opportunities.metaPostRetrieve();
-
client.crm.opportunities.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse
@@ -5010,7 +5002,7 @@ await client.crm.opportunities.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Creates an `Account` object with the given values.
@@ -5026,7 +5018,9 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.opportunities.remoteFieldClassesList(); +await client.crm.accounts.create({ + model: {}, +}); ```
@@ -5042,7 +5036,7 @@ await client.crm.opportunities.remoteFieldClassesList();
-**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest` +**request:** `Merge.crm.CrmAccountEndpointRequest`
@@ -5050,7 +5044,7 @@ await client.crm.opportunities.remoteFieldClassesList();
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -5061,9 +5055,7 @@ await client.crm.opportunities.remoteFieldClassesList();
-## Crm Passthrough - -
client.crm.passthrough.create({ ...params }) -> Merge.RemoteResponse +
client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account
@@ -5075,7 +5067,7 @@ await client.crm.opportunities.remoteFieldClassesList();
-Pull data from an endpoint not currently supported by Merge. +Returns an `Account` object with the given `id`.
@@ -5091,10 +5083,7 @@ Pull data from an endpoint not currently supported by Merge.
```typescript -await client.crm.passthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.crm.accounts.retrieve("id"); ```
@@ -5110,7 +5099,7 @@ await client.crm.passthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**id:** `string`
@@ -5118,7 +5107,15 @@ await client.crm.passthrough.create({
-**requestOptions:** `Passthrough.RequestOptions` +**request:** `Merge.crm.AccountsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -5129,9 +5126,7 @@ await client.crm.passthrough.create({
-## Crm RegenerateKey - -
client.crm.regenerateKey.create({ ...params }) -> Merge.RemoteKey +
client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse
@@ -5143,7 +5138,7 @@ await client.crm.passthrough.create({
-Exchange remote keys. +Updates an `Account` object with the given `id`.
@@ -5159,8 +5154,8 @@ Exchange remote keys.
```typescript -await client.crm.regenerateKey.create({ - name: "Remote Deployment Key 1", +await client.crm.accounts.partialUpdate("id", { + model: {}, }); ``` @@ -5177,7 +5172,7 @@ await client.crm.regenerateKey.create({
-**request:** `Merge.crm.RemoteKeyForRegenerationRequest` +**id:** `string`
@@ -5185,7 +5180,15 @@ await client.crm.regenerateKey.create({
-**requestOptions:** `RegenerateKey.RequestOptions` +**request:** `Merge.crm.PatchedCrmAccountEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -5196,9 +5199,7 @@ await client.crm.regenerateKey.create({
-## Crm Stages - -
client.crm.stages.list({ ...params }) -> Merge.PaginatedStageList +
client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -5210,7 +5211,7 @@ await client.crm.regenerateKey.create({
-Returns a list of `Stage` objects. +Returns metadata for `CRMAccount` PATCHs.
@@ -5226,7 +5227,7 @@ Returns a list of `Stage` objects.
```typescript -await client.crm.stages.list(); +await client.crm.accounts.metaPatchRetrieve("id"); ```
@@ -5242,7 +5243,7 @@ await client.crm.stages.list();
-**request:** `Merge.crm.StagesListRequest` +**id:** `string`
@@ -5250,7 +5251,7 @@ await client.crm.stages.list();
-**requestOptions:** `Stages.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -5261,7 +5262,7 @@ await client.crm.stages.list();
-
client.crm.stages.retrieve(id, { ...params }) -> Merge.Stage +
client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse
@@ -5273,7 +5274,7 @@ await client.crm.stages.list();
-Returns a `Stage` object with the given `id`. +Returns metadata for `CRMAccount` POSTs.
@@ -5289,7 +5290,7 @@ Returns a `Stage` object with the given `id`.
```typescript -await client.crm.stages.retrieve("id"); +await client.crm.accounts.metaPostRetrieve(); ```
@@ -5305,46 +5306,30 @@ await client.crm.stages.retrieve("id");
-**id:** `string` +**requestOptions:** `Accounts.RequestOptions` + +
+
+ +
+
+
client.crm.accounts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-**request:** `Merge.crm.StagesRetrieveRequest` +#### 📝 Description -
-
+
+
-**requestOptions:** `Stages.RequestOptions` - -
-
-
-
- - - -
- -
client.crm.stages.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `RemoteFieldClass` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -5360,7 +5345,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.stages.remoteFieldClassesList(); +await client.crm.accounts.remoteFieldClassesList(); ```
@@ -5376,7 +5361,7 @@ await client.crm.stages.remoteFieldClassesList();
-**request:** `Merge.crm.StagesRemoteFieldClassesListRequest` +**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest`
@@ -5384,7 +5369,7 @@ await client.crm.stages.remoteFieldClassesList();
-**requestOptions:** `Stages.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -5395,9 +5380,9 @@ await client.crm.stages.remoteFieldClassesList();
-## Crm SyncStatus +## Crm AsyncPassthrough -
client.crm.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList +
client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
@@ -5409,7 +5394,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). +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -5425,7 +5410,10 @@ Get sync status for the current sync and the most recently finished sync. `last_
```typescript -await client.crm.syncStatus.list(); +await client.crm.asyncPassthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -5441,7 +5429,7 @@ await client.crm.syncStatus.list();
-**request:** `Merge.crm.SyncStatusListRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -5449,7 +5437,7 @@ await client.crm.syncStatus.list();
-**requestOptions:** `SyncStatus.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -5460,9 +5448,7 @@ await client.crm.syncStatus.list();
-## Crm ForceResync - -
client.crm.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[] +
client.crm.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
@@ -5474,7 +5460,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. +Retrieves data from earlier async-passthrough POST request
@@ -5490,7 +5476,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```typescript -await client.crm.forceResync.syncStatusResyncCreate(); +await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
@@ -5506,7 +5492,15 @@ await client.crm.forceResync.syncStatusResyncCreate();
-**requestOptions:** `ForceResync.RequestOptions` +**asyncPassthroughReceiptId:** `string` + +
+
+ +
+
+ +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -5517,9 +5511,9 @@ await client.crm.forceResync.syncStatusResyncCreate();
-## Crm Tasks +## Crm AuditTrail -
client.crm.tasks.list({ ...params }) -> Merge.PaginatedTaskList +
client.crm.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
@@ -5531,7 +5525,7 @@ await client.crm.forceResync.syncStatusResyncCreate();
-Returns a list of `Task` objects. +Gets a list of audit trail events.
@@ -5547,7 +5541,7 @@ Returns a list of `Task` objects.
```typescript -await client.crm.tasks.list(); +await client.crm.auditTrail.list(); ```
@@ -5563,7 +5557,7 @@ await client.crm.tasks.list();
-**request:** `Merge.crm.TasksListRequest` +**request:** `Merge.crm.AuditTrailListRequest`
@@ -5571,7 +5565,7 @@ await client.crm.tasks.list();
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `AuditTrail.RequestOptions`
@@ -5582,7 +5576,9 @@ await client.crm.tasks.list();
-
client.crm.tasks.create({ ...params }) -> Merge.TaskResponse +## Crm AvailableActions + +
client.crm.availableActions.retrieve() -> Merge.AvailableActions
@@ -5594,7 +5590,7 @@ await client.crm.tasks.list();
-Creates a `Task` object with the given values. +Returns a list of models and actions available for an account.
@@ -5610,9 +5606,7 @@ Creates a `Task` object with the given values.
```typescript -await client.crm.tasks.create({ - model: {}, -}); +await client.crm.availableActions.retrieve(); ```
@@ -5628,15 +5622,7 @@ await client.crm.tasks.create({
-**request:** `Merge.crm.TaskEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `AvailableActions.RequestOptions`
@@ -5647,7 +5633,9 @@ await client.crm.tasks.create({
-
client.crm.tasks.retrieve(id, { ...params }) -> Merge.Task +## Crm Contacts + +
client.crm.contacts.list({ ...params }) -> Merge.PaginatedContactList
@@ -5659,7 +5647,7 @@ await client.crm.tasks.create({
-Returns a `Task` object with the given `id`. +Returns a list of `Contact` objects.
@@ -5675,7 +5663,7 @@ Returns a `Task` object with the given `id`.
```typescript -await client.crm.tasks.retrieve("id"); +await client.crm.contacts.list(); ```
@@ -5691,15 +5679,7 @@ await client.crm.tasks.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.TasksRetrieveRequest` +**request:** `Merge.crm.ContactsListRequest`
@@ -5707,7 +5687,7 @@ await client.crm.tasks.retrieve("id");
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -5718,7 +5698,7 @@ await client.crm.tasks.retrieve("id");
-
client.crm.tasks.partialUpdate(id, { ...params }) -> Merge.TaskResponse +
client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse
@@ -5730,7 +5710,7 @@ await client.crm.tasks.retrieve("id");
-Updates a `Task` object with the given `id`. +Creates a `Contact` object with the given values.
@@ -5746,7 +5726,7 @@ Updates a `Task` object with the given `id`.
```typescript -await client.crm.tasks.partialUpdate("id", { +await client.crm.contacts.create({ model: {}, }); ``` @@ -5764,15 +5744,7 @@ await client.crm.tasks.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedTaskEndpointRequest` +**request:** `Merge.crm.CrmContactEndpointRequest`
@@ -5780,7 +5752,7 @@ await client.crm.tasks.partialUpdate("id", {
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -5791,7 +5763,7 @@ await client.crm.tasks.partialUpdate("id", {
-
client.crm.tasks.metaPatchRetrieve(id) -> Merge.MetaResponse +
client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact
@@ -5803,7 +5775,7 @@ await client.crm.tasks.partialUpdate("id", {
-Returns metadata for `Task` PATCHs. +Returns a `Contact` object with the given `id`.
@@ -5819,7 +5791,7 @@ Returns metadata for `Task` PATCHs.
```typescript -await client.crm.tasks.metaPatchRetrieve("id"); +await client.crm.contacts.retrieve("id"); ```
@@ -5843,7 +5815,15 @@ await client.crm.tasks.metaPatchRetrieve("id");
-**requestOptions:** `Tasks.RequestOptions` +**request:** `Merge.crm.ContactsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Contacts.RequestOptions`
@@ -5854,7 +5834,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-
client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse +
client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse
@@ -5866,7 +5846,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-Returns metadata for `Task` POSTs. +Updates a `Contact` object with the given `id`.
@@ -5882,7 +5862,9 @@ Returns metadata for `Task` POSTs.
```typescript -await client.crm.tasks.metaPostRetrieve(); +await client.crm.contacts.partialUpdate("id", { + model: {}, +}); ```
@@ -5898,7 +5880,23 @@ await client.crm.tasks.metaPostRetrieve();
-**requestOptions:** `Tasks.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.PatchedCrmContactEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Contacts.RequestOptions`
@@ -5909,7 +5907,7 @@ await client.crm.tasks.metaPostRetrieve();
-
client.crm.tasks.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.crm.contacts.ignoreCreate(modelId, { ...params }) -> void
@@ -5921,7 +5919,7 @@ await client.crm.tasks.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` 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.
@@ -5937,7 +5935,9 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.tasks.remoteFieldClassesList(); +await client.crm.contacts.ignoreCreate("model_id", { + reason: "GENERAL_CUSTOMER_REQUEST", +}); ```
@@ -5953,7 +5953,7 @@ await client.crm.tasks.remoteFieldClassesList();
-**request:** `Merge.crm.TasksRemoteFieldClassesListRequest` +**modelId:** `string`
@@ -5961,7 +5961,15 @@ await client.crm.tasks.remoteFieldClassesList();
-**requestOptions:** `Tasks.RequestOptions` +**request:** `Merge.IgnoreCommonModelRequest` + +
+
+ +
+
+ +**requestOptions:** `Contacts.RequestOptions`
@@ -5972,9 +5980,7 @@ await client.crm.tasks.remoteFieldClassesList();
-## Crm Users - -
client.crm.users.list({ ...params }) -> Merge.PaginatedUserList +
client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -5986,7 +5992,7 @@ await client.crm.tasks.remoteFieldClassesList();
-Returns a list of `User` objects. +Returns metadata for `CRMContact` PATCHs.
@@ -6002,7 +6008,7 @@ Returns a list of `User` objects.
```typescript -await client.crm.users.list(); +await client.crm.contacts.metaPatchRetrieve("id"); ```
@@ -6018,7 +6024,7 @@ await client.crm.users.list();
-**request:** `Merge.crm.UsersListRequest` +**id:** `string`
@@ -6026,7 +6032,7 @@ await client.crm.users.list();
-**requestOptions:** `Users.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -6037,7 +6043,7 @@ await client.crm.users.list();
-
client.crm.users.retrieve(id, { ...params }) -> Merge.User +
client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse
@@ -6049,7 +6055,7 @@ await client.crm.users.list();
-Returns a `User` object with the given `id`. +Returns metadata for `CRMContact` POSTs.
@@ -6065,7 +6071,7 @@ Returns a `User` object with the given `id`.
```typescript -await client.crm.users.retrieve("id"); +await client.crm.contacts.metaPostRetrieve(); ```
@@ -6081,23 +6087,7 @@ await client.crm.users.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.UsersRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Users.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -6108,7 +6098,7 @@ await client.crm.users.retrieve("id");
-
client.crm.users.ignoreCreate(modelId, { ...params }) -> void +
client.crm.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -6120,7 +6110,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 a list of `RemoteFieldClass` objects.
@@ -6136,9 +6126,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.crm.contacts.remoteFieldClassesList(); ```
@@ -6154,15 +6142,7 @@ await client.crm.users.ignoreCreate("model_id", {
-**modelId:** `string` - -
-
- -
-
- -**request:** `Merge.IgnoreCommonModelRequest` +**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest`
@@ -6170,7 +6150,7 @@ await client.crm.users.ignoreCreate("model_id", {
-**requestOptions:** `Users.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -6181,7 +6161,9 @@ await client.crm.users.ignoreCreate("model_id", {
-
client.crm.users.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Crm CustomObjectClasses + +
client.crm.customObjectClasses.list({ ...params }) -> Merge.PaginatedCustomObjectClassList
@@ -6193,7 +6175,7 @@ await client.crm.users.ignoreCreate("model_id", {
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `CustomObjectClass` objects.
@@ -6209,7 +6191,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.users.remoteFieldClassesList(); +await client.crm.customObjectClasses.list(); ```
@@ -6225,7 +6207,7 @@ await client.crm.users.remoteFieldClassesList();
-**request:** `Merge.crm.UsersRemoteFieldClassesListRequest` +**request:** `Merge.crm.CustomObjectClassesListRequest`
@@ -6233,7 +6215,7 @@ await client.crm.users.remoteFieldClassesList();
-**requestOptions:** `Users.RequestOptions` +**requestOptions:** `CustomObjectClasses.RequestOptions`
@@ -6244,9 +6226,7 @@ await client.crm.users.remoteFieldClassesList();
-## Crm WebhookReceivers - -
client.crm.webhookReceivers.list() -> Merge.WebhookReceiver[] +
client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass
@@ -6258,7 +6238,7 @@ await client.crm.users.remoteFieldClassesList();
-Returns a list of `WebhookReceiver` objects. +Returns a `CustomObjectClass` object with the given `id`.
@@ -6274,7 +6254,7 @@ Returns a list of `WebhookReceiver` objects.
```typescript -await client.crm.webhookReceivers.list(); +await client.crm.customObjectClasses.retrieve("id"); ```
@@ -6290,7 +6270,23 @@ await client.crm.webhookReceivers.list();
-**requestOptions:** `WebhookReceivers.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.CustomObjectClassesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjectClasses.RequestOptions`
@@ -6301,7 +6297,9 @@ await client.crm.webhookReceivers.list();
-
client.crm.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver +## Crm AssociationTypes + +
client.crm.associationTypes.customObjectClassesAssociationTypesList(customObjectClassId, { ...params }) -> Merge.PaginatedAssociationTypeList
@@ -6313,7 +6311,7 @@ await client.crm.webhookReceivers.list();
-Creates a `WebhookReceiver` object with the given values. +Returns a list of `AssociationType` objects.
@@ -6329,10 +6327,7 @@ Creates a `WebhookReceiver` object with the given values.
```typescript -await client.crm.webhookReceivers.create({ - event: "event", - isActive: true, -}); +await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id"); ```
@@ -6348,7 +6343,7 @@ await client.crm.webhookReceivers.create({
-**request:** `Merge.crm.WebhookReceiverRequest` +**customObjectClassId:** `string`
@@ -6356,7 +6351,15 @@ await client.crm.webhookReceivers.create({
-**requestOptions:** `WebhookReceivers.RequestOptions` +**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest` + +
+
+ +
+
+ +**requestOptions:** `AssociationTypes.RequestOptions`
@@ -6367,9 +6370,7 @@ await client.crm.webhookReceivers.create({
-## Filestorage AccountDetails - -
client.filestorage.accountDetails.retrieve() -> Merge.AccountDetails +
client.crm.associationTypes.customObjectClassesAssociationTypesCreate(customObjectClassId, { ...params }) -> Merge.CrmAssociationTypeResponse
@@ -6381,7 +6382,7 @@ await client.crm.webhookReceivers.create({
-Get details for a linked account. +Creates an `AssociationType` object with the given values.
@@ -6397,7 +6398,21 @@ Get details for a linked account.
```typescript -await client.filestorage.accountDetails.retrieve(); +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", + }, +}); ```
@@ -6413,7 +6428,23 @@ await client.filestorage.accountDetails.retrieve();
-**requestOptions:** `AccountDetails.RequestOptions` +**customObjectClassId:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.CrmAssociationTypeEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `AssociationTypes.RequestOptions`
@@ -6424,9 +6455,7 @@ await client.filestorage.accountDetails.retrieve();
-## Filestorage AccountToken - -
client.filestorage.accountToken.retrieve(publicToken) -> Merge.AccountToken +
client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(customObjectClassId, id, { ...params }) -> Merge.AssociationType
@@ -6438,7 +6467,7 @@ await client.filestorage.accountDetails.retrieve();
-Returns the account token for the end user with the provided public token. +Returns an `AssociationType` object with the given `id`.
@@ -6454,7 +6483,7 @@ Returns the account token for the end user with the provided public token.
```typescript -await client.filestorage.accountToken.retrieve("public_token"); +await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id"); ```
@@ -6470,7 +6499,7 @@ await client.filestorage.accountToken.retrieve("public_token");
-**publicToken:** `string` +**customObjectClassId:** `string`
@@ -6478,20 +6507,34 @@ await client.filestorage.accountToken.retrieve("public_token");
-**requestOptions:** `AccountToken.RequestOptions` +**id:** `string`
+ +
+
+ +**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest` +
+
+
+ +**requestOptions:** `AssociationTypes.RequestOptions` + +
+
-
-## Filestorage AsyncPassthrough + + +
-
client.filestorage.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept +
client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
@@ -6503,7 +6546,7 @@ await client.filestorage.accountToken.retrieve("public_token");
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns metadata for `CRMAssociationType` POSTs.
@@ -6519,10 +6562,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.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id"); ```
@@ -6538,7 +6578,7 @@ await client.filestorage.asyncPassthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**customObjectClassId:** `string`
@@ -6546,7 +6586,7 @@ await client.filestorage.asyncPassthrough.create({
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `AssociationTypes.RequestOptions`
@@ -6557,7 +6597,9 @@ await client.filestorage.asyncPassthrough.create({
-
client.filestorage.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse +## Crm CustomObjects + +
client.crm.customObjects.customObjectClassesCustomObjectsList(customObjectClassId, { ...params }) -> Merge.PaginatedCustomObjectList
@@ -6569,7 +6611,7 @@ await client.filestorage.asyncPassthrough.create({
-Retrieves data from earlier async-passthrough POST request +Returns a list of `CustomObject` objects.
@@ -6585,7 +6627,7 @@ Retrieves data from earlier async-passthrough POST request
```typescript -await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id"); +await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id"); ```
@@ -6601,7 +6643,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-**asyncPassthroughReceiptId:** `string` +**customObjectClassId:** `string`
@@ -6609,7 +6651,15 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjects.RequestOptions`
@@ -6620,9 +6670,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-## Filestorage AuditTrail - -
client.filestorage.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList +
client.crm.customObjects.customObjectClassesCustomObjectsCreate(customObjectClassId, { ...params }) -> Merge.CrmCustomObjectResponse
@@ -6634,7 +6682,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-Gets a list of audit trail events. +Creates a `CustomObject` object with the given values.
@@ -6650,7 +6698,13 @@ Gets a list of audit trail events.
```typescript -await client.filestorage.auditTrail.list(); +await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", { + model: { + fields: { + test_field: "hello", + }, + }, +}); ```
@@ -6666,7 +6720,7 @@ await client.filestorage.auditTrail.list();
-**request:** `Merge.filestorage.AuditTrailListRequest` +**customObjectClassId:** `string`
@@ -6674,7 +6728,15 @@ await client.filestorage.auditTrail.list();
-**requestOptions:** `AuditTrail.RequestOptions` +**request:** `Merge.crm.CrmCustomObjectEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjects.RequestOptions`
@@ -6685,9 +6747,7 @@ await client.filestorage.auditTrail.list();
-## Filestorage AvailableActions - -
client.filestorage.availableActions.retrieve() -> Merge.AvailableActions +
client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(customObjectClassId, id, { ...params }) -> Merge.CustomObject
@@ -6699,7 +6759,7 @@ await client.filestorage.auditTrail.list();
-Returns a list of models and actions available for an account. +Returns a `CustomObject` object with the given `id`.
@@ -6715,7 +6775,7 @@ Returns a list of models and actions available for an account.
```typescript -await client.filestorage.availableActions.retrieve(); +await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id"); ```
@@ -6731,20 +6791,42 @@ await client.filestorage.availableActions.retrieve();
-**requestOptions:** `AvailableActions.RequestOptions` +**customObjectClassId:** `string`
+ +
+
+ +**id:** `string` +
+
+
+ +**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest` +
-
-## Filestorage Scopes +
+
-
client.filestorage.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi +**requestOptions:** `CustomObjects.RequestOptions` + +
+
+ + + + + +
+ +
client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
@@ -6756,7 +6838,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 metadata for `CRMCustomObject` POSTs.
@@ -6772,7 +6854,7 @@ Get the default permissions for Merge Common Models and fields across all Linked
```typescript -await client.filestorage.scopes.defaultScopesRetrieve(); +await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id"); ```
@@ -6788,7 +6870,15 @@ await client.filestorage.scopes.defaultScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**customObjectClassId:** `string` + +
+
+ +
+
+ +**requestOptions:** `CustomObjects.RequestOptions`
@@ -6799,7 +6889,7 @@ await client.filestorage.scopes.defaultScopesRetrieve();
-
client.filestorage.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi +
client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -6811,7 +6901,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). +Returns a list of `RemoteFieldClass` objects.
@@ -6827,7 +6917,7 @@ Get all available permissions for Merge Common Models and fields for a single Li
```typescript -await client.filestorage.scopes.linkedAccountScopesRetrieve(); +await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList(); ```
@@ -6843,7 +6933,15 @@ await client.filestorage.scopes.linkedAccountScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjects.RequestOptions`
@@ -6854,7 +6952,9 @@ await client.filestorage.scopes.linkedAccountScopesRetrieve();
-
client.filestorage.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi +## Crm Associations + +
client.crm.associations.customObjectClassesCustomObjectsAssociationsList(customObjectClassId, objectId, { ...params }) -> Merge.PaginatedAssociationList
@@ -6866,7 +6966,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 a list of `Association` objects.
@@ -6882,33 +6982,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.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id"); ```
@@ -6924,7 +6998,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-**request:** `Merge.filestorage.LinkedAccountCommonModelScopeDeserializerRequest` +**customObjectClassId:** `string`
@@ -6932,7 +7006,23 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-**requestOptions:** `Scopes.RequestOptions` +**objectId:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Associations.RequestOptions`
@@ -6943,9 +7033,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-## Filestorage DeleteAccount - -
client.filestorage.deleteAccount.delete() -> void +
client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(associationTypeId, sourceClassId, sourceObjectId, targetClassId, targetObjectId, { ...params }) -> Merge.Association
@@ -6957,7 +7045,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-Delete a linked account. +Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -6973,7 +7061,13 @@ Delete a linked account.
```typescript -await client.filestorage.deleteAccount.delete(); +await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate( + "association_type_id", + "source_class_id", + "source_object_id", + "target_class_id", + "target_object_id", +); ```
@@ -6989,64 +7083,47 @@ await client.filestorage.deleteAccount.delete();
-**requestOptions:** `DeleteAccount.RequestOptions` - -
-
- -
+**associationTypeId:** `string` -
- -## Filestorage Drives -
client.filestorage.drives.list({ ...params }) -> Merge.PaginatedDriveList
-#### 📝 Description +**sourceClassId:** `string` -
-
+
+
-Returns a list of `Drive` objects. +**sourceObjectId:** `string`
-
-
- -#### 🔌 Usage - -
-
-```typescript -await client.filestorage.drives.list(); -``` +**targetClassId:** `string`
-
-
- -#### ⚙️ Parameters
+**targetObjectId:** `string` + +
+
+
-**request:** `Merge.filestorage.DrivesListRequest` +**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest`
@@ -7054,7 +7131,7 @@ await client.filestorage.drives.list();
-**requestOptions:** `Drives.RequestOptions` +**requestOptions:** `Associations.RequestOptions`
@@ -7065,7 +7142,9 @@ await client.filestorage.drives.list();
-
client.filestorage.drives.retrieve(id, { ...params }) -> Merge.Drive +## Crm Scopes + +
client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -7077,7 +7156,7 @@ await client.filestorage.drives.list();
-Returns a `Drive` object with the given `id`. +Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -7093,7 +7172,7 @@ Returns a `Drive` object with the given `id`.
```typescript -await client.filestorage.drives.retrieve("id"); +await client.crm.scopes.defaultScopesRetrieve(); ```
@@ -7109,23 +7188,7 @@ await client.filestorage.drives.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.DrivesRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Drives.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -7136,9 +7199,7 @@ await client.filestorage.drives.retrieve("id");
-## Filestorage FieldMapping - -
client.filestorage.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse +
client.crm.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -7150,7 +7211,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/). +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).
@@ -7166,7 +7227,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```typescript -await client.filestorage.fieldMapping.fieldMappingsRetrieve(); +await client.crm.scopes.linkedAccountScopesRetrieve(); ```
@@ -7182,15 +7243,7 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve();
-**request:** `Merge.filestorage.FieldMappingsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -7201,7 +7254,7 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve();
-
client.filestorage.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse +
client.crm.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
@@ -7213,7 +7266,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. +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)
@@ -7229,13 +7282,32 @@ 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.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, + }, + }, + }, + ], }); ``` @@ -7252,7 +7324,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-**request:** `Merge.filestorage.CreateFieldMappingRequest` +**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -7260,7 +7332,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -7271,7 +7343,9 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-
client.filestorage.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse +## Crm DeleteAccount + +
client.crm.deleteAccount.delete() -> void
@@ -7283,7 +7357,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. +Delete a linked account.
@@ -7299,7 +7373,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.deleteAccount.delete(); ```
@@ -7315,15 +7389,7 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**fieldMappingId:** `string` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `DeleteAccount.RequestOptions`
@@ -7334,7 +7400,9 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
client.filestorage.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse +## Crm EngagementTypes + +
client.crm.engagementTypes.list({ ...params }) -> Merge.PaginatedEngagementTypeList
@@ -7346,7 +7414,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 `EngagementType` objects.
@@ -7362,7 +7430,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.engagementTypes.list(); ```
@@ -7378,15 +7446,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-**fieldMappingId:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.PatchedEditFieldMappingRequest` +**request:** `Merge.crm.EngagementTypesListRequest`
@@ -7394,7 +7454,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `EngagementTypes.RequestOptions`
@@ -7405,7 +7465,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-
client.filestorage.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse +
client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType
@@ -7417,7 +7477,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/). +Returns an `EngagementType` object with the given `id`.
@@ -7433,7 +7493,7 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```typescript -await client.filestorage.fieldMapping.remoteFieldsRetrieve(); +await client.crm.engagementTypes.retrieve("id"); ```
@@ -7449,7 +7509,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve();
-**request:** `Merge.filestorage.RemoteFieldsRetrieveRequest` +**id:** `string`
@@ -7457,7 +7517,15 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.crm.EngagementTypesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `EngagementTypes.RequestOptions`
@@ -7468,7 +7536,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve();
-
client.filestorage.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse +
client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -7480,7 +7548,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 list of `RemoteFieldClass` objects.
@@ -7496,7 +7564,7 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```typescript -await client.filestorage.fieldMapping.targetFieldsRetrieve(); +await client.crm.engagementTypes.remoteFieldClassesList(); ```
@@ -7512,7 +7580,15 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest` + +
+
+ +
+
+ +**requestOptions:** `EngagementTypes.RequestOptions`
@@ -7523,9 +7599,9 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-## Filestorage Files +## Crm Engagements -
client.filestorage.files.list({ ...params }) -> Merge.PaginatedFileList +
client.crm.engagements.list({ ...params }) -> Merge.PaginatedEngagementList
@@ -7537,7 +7613,7 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-Returns a list of `File` objects. +Returns a list of `Engagement` objects.
@@ -7553,7 +7629,7 @@ Returns a list of `File` objects.
```typescript -await client.filestorage.files.list(); +await client.crm.engagements.list(); ```
@@ -7569,7 +7645,7 @@ await client.filestorage.files.list();
-**request:** `Merge.filestorage.FilesListRequest` +**request:** `Merge.crm.EngagementsListRequest`
@@ -7577,7 +7653,7 @@ await client.filestorage.files.list();
-**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7588,7 +7664,7 @@ await client.filestorage.files.list();
-
client.filestorage.files.create({ ...params }) -> Merge.FileStorageFileResponse +
client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse
@@ -7600,7 +7676,7 @@ await client.filestorage.files.list();
-Creates a `File` object with the given values. +Creates an `Engagement` object with the given values.
@@ -7616,7 +7692,7 @@ Creates a `File` object with the given values.
```typescript -await client.filestorage.files.create({ +await client.crm.engagements.create({ model: {}, }); ``` @@ -7634,7 +7710,7 @@ await client.filestorage.files.create({
-**request:** `Merge.filestorage.FileStorageFileEndpointRequest` +**request:** `Merge.crm.EngagementEndpointRequest`
@@ -7642,7 +7718,7 @@ await client.filestorage.files.create({
-**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7653,7 +7729,7 @@ await client.filestorage.files.create({
-
client.filestorage.files.retrieve(id, { ...params }) -> Merge.File_ +
client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement
@@ -7665,7 +7741,7 @@ await client.filestorage.files.create({
-Returns a `File` object with the given `id`. +Returns an `Engagement` object with the given `id`.
@@ -7681,7 +7757,7 @@ Returns a `File` object with the given `id`.
```typescript -await client.filestorage.files.retrieve("id"); +await client.crm.engagements.retrieve("id"); ```
@@ -7705,7 +7781,7 @@ await client.filestorage.files.retrieve("id");
-**request:** `Merge.filestorage.FilesRetrieveRequest` +**request:** `Merge.crm.EngagementsRetrieveRequest`
@@ -7713,7 +7789,7 @@ await client.filestorage.files.retrieve("id");
-**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7724,7 +7800,7 @@ await client.filestorage.files.retrieve("id");
-
client.filestorage.files.downloadRequestMetaRetrieve(id, { ...params }) -> Merge.DownloadRequestMeta +
client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse
@@ -7736,7 +7812,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. +Updates an `Engagement` object with the given `id`.
@@ -7752,7 +7828,9 @@ Returns metadata to construct an authenticated file download request for a singu
```typescript -await client.filestorage.files.downloadRequestMetaRetrieve("id"); +await client.crm.engagements.partialUpdate("id", { + model: {}, +}); ```
@@ -7776,7 +7854,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id");
-**request:** `Merge.filestorage.FilesDownloadRequestMetaRetrieveRequest` +**request:** `Merge.crm.PatchedEngagementEndpointRequest`
@@ -7784,7 +7862,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id");
-**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7795,7 +7873,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id");
-
client.filestorage.files.downloadRequestMetaList({ ...params }) -> Merge.PaginatedDownloadRequestMetaList +
client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -7807,7 +7885,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 metadata for `Engagement` PATCHs.
@@ -7823,7 +7901,7 @@ Returns metadata to construct authenticated file download requests, allowing you
```typescript -await client.filestorage.files.downloadRequestMetaList(); +await client.crm.engagements.metaPatchRetrieve("id"); ```
@@ -7839,7 +7917,7 @@ await client.filestorage.files.downloadRequestMetaList();
-**request:** `Merge.filestorage.FilesDownloadRequestMetaListRequest` +**id:** `string`
@@ -7847,7 +7925,7 @@ await client.filestorage.files.downloadRequestMetaList();
-**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7858,7 +7936,7 @@ await client.filestorage.files.downloadRequestMetaList();
-
client.filestorage.files.metaPostRetrieve() -> Merge.MetaResponse +
client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse
@@ -7870,7 +7948,7 @@ await client.filestorage.files.downloadRequestMetaList();
-Returns metadata for `FileStorageFile` POSTs. +Returns metadata for `Engagement` POSTs.
@@ -7886,7 +7964,7 @@ Returns metadata for `FileStorageFile` POSTs.
```typescript -await client.filestorage.files.metaPostRetrieve(); +await client.crm.engagements.metaPostRetrieve(); ```
@@ -7902,7 +7980,7 @@ await client.filestorage.files.metaPostRetrieve();
-**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7913,9 +7991,7 @@ await client.filestorage.files.metaPostRetrieve();
-## Filestorage Folders - -
client.filestorage.folders.list({ ...params }) -> Merge.PaginatedFolderList +
client.crm.engagements.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -7927,7 +8003,7 @@ await client.filestorage.files.metaPostRetrieve();
-Returns a list of `Folder` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -7943,7 +8019,7 @@ Returns a list of `Folder` objects.
```typescript -await client.filestorage.folders.list(); +await client.crm.engagements.remoteFieldClassesList(); ```
@@ -7959,7 +8035,7 @@ await client.filestorage.folders.list();
-**request:** `Merge.filestorage.FoldersListRequest` +**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest`
@@ -7967,7 +8043,7 @@ await client.filestorage.folders.list();
-**requestOptions:** `Folders.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7978,7 +8054,9 @@ await client.filestorage.folders.list();
-
client.filestorage.folders.create({ ...params }) -> Merge.FileStorageFolderResponse +## Crm FieldMapping + +
client.crm.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
@@ -7990,7 +8068,7 @@ await client.filestorage.folders.list();
-Creates a `Folder` 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/).
@@ -8006,9 +8084,7 @@ Creates a `Folder` object with the given values.
```typescript -await client.filestorage.folders.create({ - model: {}, -}); +await client.crm.fieldMapping.fieldMappingsRetrieve(); ```
@@ -8024,7 +8100,7 @@ await client.filestorage.folders.create({
-**request:** `Merge.filestorage.FileStorageFolderEndpointRequest` +**request:** `Merge.crm.FieldMappingsRetrieveRequest`
@@ -8032,7 +8108,7 @@ await client.filestorage.folders.create({
-**requestOptions:** `Folders.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8043,7 +8119,7 @@ await client.filestorage.folders.create({
-
client.filestorage.folders.retrieve(id, { ...params }) -> Merge.Folder +
client.crm.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
@@ -8055,7 +8131,7 @@ await client.filestorage.folders.create({
-Returns a `Folder` object with the given `id`. +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -8071,7 +8147,14 @@ Returns a `Folder` object with the given `id`.
```typescript -await client.filestorage.folders.retrieve("id"); +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", +}); ```
@@ -8087,15 +8170,7 @@ await client.filestorage.folders.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.FoldersRetrieveRequest` +**request:** `Merge.crm.CreateFieldMappingRequest`
@@ -8103,7 +8178,7 @@ await client.filestorage.folders.retrieve("id");
-**requestOptions:** `Folders.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8114,7 +8189,7 @@ await client.filestorage.folders.retrieve("id");
-
client.filestorage.folders.metaPostRetrieve() -> Merge.MetaResponse +
client.crm.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
@@ -8126,7 +8201,7 @@ await client.filestorage.folders.retrieve("id");
-Returns metadata for `FileStorageFolder` POSTs. +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.
@@ -8142,7 +8217,7 @@ Returns metadata for `FileStorageFolder` POSTs.
```typescript -await client.filestorage.folders.metaPostRetrieve(); +await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
@@ -8158,7 +8233,15 @@ await client.filestorage.folders.metaPostRetrieve();
-**requestOptions:** `Folders.RequestOptions` +**fieldMappingId:** `string` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8169,9 +8252,7 @@ await client.filestorage.folders.metaPostRetrieve();
-## Filestorage GenerateKey - -
client.filestorage.generateKey.create({ ...params }) -> Merge.RemoteKey +
client.crm.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
@@ -8183,7 +8264,7 @@ await client.filestorage.folders.metaPostRetrieve();
-Create a remote key. +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.
@@ -8199,9 +8280,7 @@ Create a remote key.
```typescript -await client.filestorage.generateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); ```
@@ -8217,7 +8296,7 @@ await client.filestorage.generateKey.create({
-**request:** `Merge.filestorage.GenerateRemoteKeyRequest` +**fieldMappingId:** `string`
@@ -8225,7 +8304,15 @@ await client.filestorage.generateKey.create({
-**requestOptions:** `GenerateKey.RequestOptions` +**request:** `Merge.crm.PatchedEditFieldMappingRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8236,9 +8323,7 @@ await client.filestorage.generateKey.create({
-## Filestorage Groups - -
client.filestorage.groups.list({ ...params }) -> Merge.PaginatedGroupList +
client.crm.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
@@ -8250,7 +8335,7 @@ await client.filestorage.generateKey.create({
-Returns a list of `Group` objects. +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -8266,7 +8351,7 @@ Returns a list of `Group` objects.
```typescript -await client.filestorage.groups.list(); +await client.crm.fieldMapping.remoteFieldsRetrieve(); ```
@@ -8282,7 +8367,7 @@ await client.filestorage.groups.list();
-**request:** `Merge.filestorage.GroupsListRequest` +**request:** `Merge.crm.RemoteFieldsRetrieveRequest`
@@ -8290,7 +8375,7 @@ await client.filestorage.groups.list();
-**requestOptions:** `Groups.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8301,7 +8386,7 @@ await client.filestorage.groups.list();
-
client.filestorage.groups.retrieve(id, { ...params }) -> Merge.Group +
client.crm.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
@@ -8313,7 +8398,7 @@ await client.filestorage.groups.list();
-Returns a `Group` 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/).
@@ -8329,39 +8414,23 @@ Returns a `Group` object with the given `id`.
```typescript -await client.filestorage.groups.retrieve("id"); +await client.crm.fieldMapping.targetFieldsRetrieve(); ```
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `string` - -
-
+
+
+ +#### ⚙️ Parameters
-**request:** `Merge.filestorage.GroupsRetrieveRequest` - -
-
-
-**requestOptions:** `Groups.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8372,9 +8441,9 @@ await client.filestorage.groups.retrieve("id");
-## Filestorage Issues +## Crm GenerateKey -
client.filestorage.issues.list({ ...params }) -> Merge.PaginatedIssueList +
client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey
@@ -8386,7 +8455,7 @@ await client.filestorage.groups.retrieve("id");
-Gets all issues for Organization. +Create a remote key.
@@ -8402,7 +8471,9 @@ Gets all issues for Organization.
```typescript -await client.filestorage.issues.list(); +await client.crm.generateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -8418,7 +8489,7 @@ await client.filestorage.issues.list();
-**request:** `Merge.filestorage.IssuesListRequest` +**request:** `Merge.crm.GenerateRemoteKeyRequest`
@@ -8426,7 +8497,7 @@ await client.filestorage.issues.list();
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `GenerateKey.RequestOptions`
@@ -8437,7 +8508,9 @@ await client.filestorage.issues.list();
-
client.filestorage.issues.retrieve(id) -> Merge.Issue +## Crm Issues + +
client.crm.issues.list({ ...params }) -> Merge.PaginatedIssueList
@@ -8449,7 +8522,7 @@ await client.filestorage.issues.list();
-Get a specific issue. +Gets all issues for Organization.
@@ -8465,7 +8538,7 @@ Get a specific issue.
```typescript -await client.filestorage.issues.retrieve("id"); +await client.crm.issues.list(); ```
@@ -8481,7 +8554,7 @@ await client.filestorage.issues.retrieve("id");
-**id:** `string` +**request:** `Merge.crm.IssuesListRequest`
@@ -8500,9 +8573,7 @@ await client.filestorage.issues.retrieve("id");
-## Filestorage LinkToken - -
client.filestorage.linkToken.create({ ...params }) -> Merge.LinkToken +
client.crm.issues.retrieve(id) -> Merge.Issue
@@ -8514,7 +8585,7 @@ await client.filestorage.issues.retrieve("id");
-Creates a link token to be used when linking a new end user. +Get a specific issue.
@@ -8530,12 +8601,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.issues.retrieve("id"); ```
@@ -8551,7 +8617,7 @@ await client.filestorage.linkToken.create({
-**request:** `Merge.filestorage.EndUserDetailsRequest` +**id:** `string`
@@ -8559,7 +8625,7 @@ await client.filestorage.linkToken.create({
-**requestOptions:** `LinkToken.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -8570,9 +8636,9 @@ await client.filestorage.linkToken.create({
-## Filestorage LinkedAccounts +## Crm Leads -
client.filestorage.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList +
client.crm.leads.list({ ...params }) -> Merge.PaginatedLeadList
@@ -8584,7 +8650,7 @@ await client.filestorage.linkToken.create({
-List linked accounts for your organization. +Returns a list of `Lead` objects.
@@ -8600,7 +8666,7 @@ List linked accounts for your organization.
```typescript -await client.filestorage.linkedAccounts.list(); +await client.crm.leads.list(); ```
@@ -8616,7 +8682,7 @@ await client.filestorage.linkedAccounts.list();
-**request:** `Merge.filestorage.LinkedAccountsListRequest` +**request:** `Merge.crm.LeadsListRequest`
@@ -8624,7 +8690,7 @@ await client.filestorage.linkedAccounts.list();
-**requestOptions:** `LinkedAccounts.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -8635,9 +8701,7 @@ await client.filestorage.linkedAccounts.list();
-## Filestorage Passthrough - -
client.filestorage.passthrough.create({ ...params }) -> Merge.RemoteResponse +
client.crm.leads.create({ ...params }) -> Merge.LeadResponse
@@ -8649,7 +8713,7 @@ await client.filestorage.linkedAccounts.list();
-Pull data from an endpoint not currently supported by Merge. +Creates a `Lead` object with the given values.
@@ -8665,9 +8729,8 @@ Pull data from an endpoint not currently supported by Merge.
```typescript -await client.filestorage.passthrough.create({ - method: "GET", - path: "/scooters", +await client.crm.leads.create({ + model: {}, }); ``` @@ -8684,7 +8747,7 @@ await client.filestorage.passthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**request:** `Merge.crm.LeadEndpointRequest`
@@ -8692,7 +8755,7 @@ await client.filestorage.passthrough.create({
-**requestOptions:** `Passthrough.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -8703,9 +8766,7 @@ await client.filestorage.passthrough.create({
-## Filestorage RegenerateKey - -
client.filestorage.regenerateKey.create({ ...params }) -> Merge.RemoteKey +
client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead
@@ -8717,7 +8778,7 @@ await client.filestorage.passthrough.create({
-Exchange remote keys. +Returns a `Lead` object with the given `id`.
@@ -8733,9 +8794,7 @@ Exchange remote keys.
```typescript -await client.filestorage.regenerateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.crm.leads.retrieve("id"); ```
@@ -8751,7 +8810,7 @@ await client.filestorage.regenerateKey.create({
-**request:** `Merge.filestorage.RemoteKeyForRegenerationRequest` +**id:** `string`
@@ -8759,7 +8818,15 @@ await client.filestorage.regenerateKey.create({
-**requestOptions:** `RegenerateKey.RequestOptions` +**request:** `Merge.crm.LeadsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Leads.RequestOptions`
@@ -8770,9 +8837,7 @@ await client.filestorage.regenerateKey.create({
-## Filestorage SyncStatus - -
client.filestorage.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList +
client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse
@@ -8784,7 +8849,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). +Returns metadata for `Lead` POSTs.
@@ -8800,7 +8865,7 @@ Get sync status for the current sync and the most recently finished sync. `last_
```typescript -await client.filestorage.syncStatus.list(); +await client.crm.leads.metaPostRetrieve(); ```
@@ -8816,15 +8881,7 @@ await client.filestorage.syncStatus.list();
-**request:** `Merge.filestorage.SyncStatusListRequest` - -
-
- -
-
- -**requestOptions:** `SyncStatus.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -8835,9 +8892,7 @@ await client.filestorage.syncStatus.list();
-## Filestorage ForceResync - -
client.filestorage.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[] +
client.crm.leads.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -8849,7 +8904,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. +Returns a list of `RemoteFieldClass` objects.
@@ -8865,7 +8920,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```typescript -await client.filestorage.forceResync.syncStatusResyncCreate(); +await client.crm.leads.remoteFieldClassesList(); ```
@@ -8881,7 +8936,15 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-**requestOptions:** `ForceResync.RequestOptions` +**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Leads.RequestOptions`
@@ -8892,9 +8955,9 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-## Filestorage Users +## Crm LinkToken -
client.filestorage.users.list({ ...params }) -> Merge.PaginatedUserList +
client.crm.linkToken.create({ ...params }) -> Merge.LinkToken
@@ -8906,7 +8969,7 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-Returns a list of `User` objects. +Creates a link token to be used when linking a new end user.
@@ -8922,7 +8985,12 @@ Returns a list of `User` objects.
```typescript -await client.filestorage.users.list(); +await client.crm.linkToken.create({ + endUserEmailAddress: "example@gmail.com", + endUserOrganizationName: "Test Organization", + endUserOriginId: "12345", + categories: ["hris", "ats"], +}); ```
@@ -8938,7 +9006,7 @@ await client.filestorage.users.list();
-**request:** `Merge.filestorage.UsersListRequest` +**request:** `Merge.crm.EndUserDetailsRequest`
@@ -8946,7 +9014,7 @@ await client.filestorage.users.list();
-**requestOptions:** `Users.RequestOptions` +**requestOptions:** `LinkToken.RequestOptions`
@@ -8957,7 +9025,9 @@ await client.filestorage.users.list();
-
client.filestorage.users.retrieve(id, { ...params }) -> Merge.User +## Crm LinkedAccounts + +
client.crm.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
@@ -8969,7 +9039,7 @@ await client.filestorage.users.list();
-Returns a `User` object with the given `id`. +List linked accounts for your organization.
@@ -8985,7 +9055,7 @@ Returns a `User` object with the given `id`.
```typescript -await client.filestorage.users.retrieve("id"); +await client.crm.linkedAccounts.list(); ```
@@ -9001,15 +9071,7 @@ await client.filestorage.users.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.UsersRetrieveRequest` +**request:** `Merge.crm.LinkedAccountsListRequest`
@@ -9017,7 +9079,7 @@ await client.filestorage.users.retrieve("id");
-**requestOptions:** `Users.RequestOptions` +**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -9028,9 +9090,9 @@ await client.filestorage.users.retrieve("id");
-## Filestorage WebhookReceivers +## Crm Notes -
client.filestorage.webhookReceivers.list() -> Merge.WebhookReceiver[] +
client.crm.notes.list({ ...params }) -> Merge.PaginatedNoteList
@@ -9042,7 +9104,7 @@ await client.filestorage.users.retrieve("id");
-Returns a list of `WebhookReceiver` objects. +Returns a list of `Note` objects.
@@ -9058,7 +9120,7 @@ Returns a list of `WebhookReceiver` objects.
```typescript -await client.filestorage.webhookReceivers.list(); +await client.crm.notes.list(); ```
@@ -9074,7 +9136,15 @@ await client.filestorage.webhookReceivers.list();
-**requestOptions:** `WebhookReceivers.RequestOptions` +**request:** `Merge.crm.NotesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Notes.RequestOptions`
@@ -9085,7 +9155,7 @@ await client.filestorage.webhookReceivers.list();
-
client.filestorage.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver +
client.crm.notes.create({ ...params }) -> Merge.NoteResponse
@@ -9097,7 +9167,7 @@ await client.filestorage.webhookReceivers.list();
-Creates a `WebhookReceiver` object with the given values. +Creates a `Note` object with the given values.
@@ -9113,9 +9183,8 @@ Creates a `WebhookReceiver` object with the given values.
```typescript -await client.filestorage.webhookReceivers.create({ - event: "event", - isActive: true, +await client.crm.notes.create({ + model: {}, }); ``` @@ -9132,7 +9201,7 @@ await client.filestorage.webhookReceivers.create({
-**request:** `Merge.filestorage.WebhookReceiverRequest` +**request:** `Merge.crm.NoteEndpointRequest`
@@ -9140,7 +9209,7 @@ await client.filestorage.webhookReceivers.create({
-**requestOptions:** `WebhookReceivers.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -9151,9 +9220,7 @@ await client.filestorage.webhookReceivers.create({
-## Ats AccountDetails - -
client.ats.accountDetails.retrieve() -> Merge.AccountDetails +
client.crm.notes.retrieve(id, { ...params }) -> Merge.Note
@@ -9165,7 +9232,7 @@ await client.filestorage.webhookReceivers.create({
-Get details for a linked account. +Returns a `Note` object with the given `id`.
@@ -9181,7 +9248,7 @@ Get details for a linked account.
```typescript -await client.ats.accountDetails.retrieve(); +await client.crm.notes.retrieve("id"); ```
@@ -9197,7 +9264,23 @@ await client.ats.accountDetails.retrieve();
-**requestOptions:** `AccountDetails.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.NotesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Notes.RequestOptions`
@@ -9208,9 +9291,7 @@ await client.ats.accountDetails.retrieve();
-## Ats AccountToken - -
client.ats.accountToken.retrieve(publicToken) -> Merge.AccountToken +
client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse
@@ -9222,7 +9303,7 @@ await client.ats.accountDetails.retrieve();
-Returns the account token for the end user with the provided public token. +Returns metadata for `Note` POSTs.
@@ -9238,7 +9319,7 @@ Returns the account token for the end user with the provided public token.
```typescript -await client.ats.accountToken.retrieve("public_token"); +await client.crm.notes.metaPostRetrieve(); ```
@@ -9254,15 +9335,7 @@ await client.ats.accountToken.retrieve("public_token");
-**publicToken:** `string` - -
-
- -
-
- -**requestOptions:** `AccountToken.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -9273,9 +9346,7 @@ await client.ats.accountToken.retrieve("public_token");
-## Ats Activities - -
client.ats.activities.list({ ...params }) -> Merge.PaginatedActivityList +
client.crm.notes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -9287,7 +9358,7 @@ await client.ats.accountToken.retrieve("public_token");
-Returns a list of `Activity` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -9303,7 +9374,7 @@ Returns a list of `Activity` objects.
```typescript -await client.ats.activities.list(); +await client.crm.notes.remoteFieldClassesList(); ```
@@ -9319,7 +9390,7 @@ await client.ats.activities.list();
-**request:** `Merge.ats.ActivitiesListRequest` +**request:** `Merge.crm.NotesRemoteFieldClassesListRequest`
@@ -9327,7 +9398,7 @@ await client.ats.activities.list();
-**requestOptions:** `Activities.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -9338,7 +9409,9 @@ await client.ats.activities.list();
-
client.ats.activities.create({ ...params }) -> Merge.ActivityResponse +## Crm Opportunities + +
client.crm.opportunities.list({ ...params }) -> Merge.PaginatedOpportunityList
@@ -9350,7 +9423,7 @@ await client.ats.activities.list();
-Creates an `Activity` object with the given values. +Returns a list of `Opportunity` objects.
@@ -9366,10 +9439,7 @@ Creates an `Activity` object with the given values.
```typescript -await client.ats.activities.create({ - model: {}, - remoteUserId: "remote_user_id", -}); +await client.crm.opportunities.list(); ```
@@ -9385,7 +9455,7 @@ await client.ats.activities.create({
-**request:** `Merge.ats.ActivityEndpointRequest` +**request:** `Merge.crm.OpportunitiesListRequest`
@@ -9393,7 +9463,7 @@ await client.ats.activities.create({
-**requestOptions:** `Activities.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9404,7 +9474,7 @@ await client.ats.activities.create({
-
client.ats.activities.retrieve(id, { ...params }) -> Merge.Activity +
client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse
@@ -9416,7 +9486,7 @@ await client.ats.activities.create({
-Returns an `Activity` object with the given `id`. +Creates an `Opportunity` object with the given values.
@@ -9432,7 +9502,9 @@ Returns an `Activity` object with the given `id`.
```typescript -await client.ats.activities.retrieve("id"); +await client.crm.opportunities.create({ + model: {}, +}); ```
@@ -9448,15 +9520,7 @@ await client.ats.activities.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.ActivitiesRetrieveRequest` +**request:** `Merge.crm.OpportunityEndpointRequest`
@@ -9464,7 +9528,7 @@ await client.ats.activities.retrieve("id");
-**requestOptions:** `Activities.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9475,7 +9539,7 @@ await client.ats.activities.retrieve("id");
-
client.ats.activities.metaPostRetrieve() -> Merge.MetaResponse +
client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity
@@ -9487,7 +9551,7 @@ await client.ats.activities.retrieve("id");
-Returns metadata for `Activity` POSTs. +Returns an `Opportunity` object with the given `id`.
@@ -9503,7 +9567,7 @@ Returns metadata for `Activity` POSTs.
```typescript -await client.ats.activities.metaPostRetrieve(); +await client.crm.opportunities.retrieve("id"); ```
@@ -9519,20 +9583,34 @@ await client.ats.activities.metaPostRetrieve();
-**requestOptions:** `Activities.RequestOptions` +**id:** `string`
+ +
+
+ +**request:** `Merge.crm.OpportunitiesRetrieveRequest` +
+
+
+ +**requestOptions:** `Opportunities.RequestOptions` + +
+
-
-## Ats Applications + + +
-
client.ats.applications.list({ ...params }) -> Merge.PaginatedApplicationList +
client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse
@@ -9544,7 +9622,7 @@ await client.ats.activities.metaPostRetrieve();
-Returns a list of `Application` objects. +Updates an `Opportunity` object with the given `id`.
@@ -9560,7 +9638,9 @@ Returns a list of `Application` objects.
```typescript -await client.ats.applications.list(); +await client.crm.opportunities.partialUpdate("id", { + model: {}, +}); ```
@@ -9576,7 +9656,7 @@ await client.ats.applications.list();
-**request:** `Merge.ats.ApplicationsListRequest` +**id:** `string`
@@ -9584,7 +9664,15 @@ await client.ats.applications.list();
-**requestOptions:** `Applications.RequestOptions` +**request:** `Merge.crm.PatchedOpportunityEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Opportunities.RequestOptions`
@@ -9595,7 +9683,7 @@ await client.ats.applications.list();
-
client.ats.applications.create({ ...params }) -> Merge.ApplicationResponse +
client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -9607,10 +9695,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. +Returns metadata for `Opportunity` PATCHs.
@@ -9626,10 +9711,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.crm.opportunities.metaPatchRetrieve("id"); ```
@@ -9645,7 +9727,7 @@ await client.ats.applications.create({
-**request:** `Merge.ats.ApplicationEndpointRequest` +**id:** `string`
@@ -9653,7 +9735,7 @@ await client.ats.applications.create({
-**requestOptions:** `Applications.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9664,7 +9746,7 @@ await client.ats.applications.create({
-
client.ats.applications.retrieve(id, { ...params }) -> Merge.Application +
client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse
@@ -9676,7 +9758,7 @@ await client.ats.applications.create({
-Returns an `Application` object with the given `id`. +Returns metadata for `Opportunity` POSTs.
@@ -9692,7 +9774,7 @@ Returns an `Application` object with the given `id`.
```typescript -await client.ats.applications.retrieve("id"); +await client.crm.opportunities.metaPostRetrieve(); ```
@@ -9708,23 +9790,7 @@ await client.ats.applications.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.ApplicationsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Applications.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9735,7 +9801,7 @@ await client.ats.applications.retrieve("id");
-
client.ats.applications.changeStageCreate(id, { ...params }) -> Merge.ApplicationResponse +
client.crm.opportunities.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -9747,7 +9813,7 @@ await client.ats.applications.retrieve("id");
-Updates the `current_stage` field of an `Application` object +Returns a list of `RemoteFieldClass` objects.
@@ -9763,7 +9829,7 @@ Updates the `current_stage` field of an `Application` object
```typescript -await client.ats.applications.changeStageCreate("id"); +await client.crm.opportunities.remoteFieldClassesList(); ```
@@ -9779,15 +9845,7 @@ await client.ats.applications.changeStageCreate("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.UpdateApplicationStageRequest` +**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest`
@@ -9795,7 +9853,7 @@ await client.ats.applications.changeStageCreate("id");
-**requestOptions:** `Applications.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9806,7 +9864,9 @@ await client.ats.applications.changeStageCreate("id");
-
client.ats.applications.metaPostRetrieve({ ...params }) -> Merge.MetaResponse +## Crm Passthrough + +
client.crm.passthrough.create({ ...params }) -> Merge.RemoteResponse
@@ -9818,7 +9878,7 @@ await client.ats.applications.changeStageCreate("id");
-Returns metadata for `Application` POSTs. +Pull data from an endpoint not currently supported by Merge.
@@ -9834,7 +9894,10 @@ Returns metadata for `Application` POSTs.
```typescript -await client.ats.applications.metaPostRetrieve(); +await client.crm.passthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -9850,7 +9913,7 @@ await client.ats.applications.metaPostRetrieve();
-**request:** `Merge.ats.ApplicationsMetaPostRetrieveRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -9858,7 +9921,7 @@ await client.ats.applications.metaPostRetrieve();
-**requestOptions:** `Applications.RequestOptions` +**requestOptions:** `Passthrough.RequestOptions`
@@ -9869,9 +9932,9 @@ await client.ats.applications.metaPostRetrieve();
-## Ats AsyncPassthrough +## Crm RegenerateKey -
client.ats.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept +
client.crm.regenerateKey.create({ ...params }) -> Merge.RemoteKey
@@ -9883,7 +9946,7 @@ await client.ats.applications.metaPostRetrieve();
-Asynchronously pull data from an endpoint not currently supported by Merge. +Exchange remote keys.
@@ -9899,9 +9962,8 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```typescript -await client.ats.asyncPassthrough.create({ - method: "GET", - path: "/scooters", +await client.crm.regenerateKey.create({ + name: "Remote Deployment Key 1", }); ``` @@ -9918,7 +9980,7 @@ await client.ats.asyncPassthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**request:** `Merge.crm.RemoteKeyForRegenerationRequest`
@@ -9926,7 +9988,7 @@ await client.ats.asyncPassthrough.create({
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `RegenerateKey.RequestOptions`
@@ -9937,7 +9999,9 @@ await client.ats.asyncPassthrough.create({
-
client.ats.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse +## Crm Stages + +
client.crm.stages.list({ ...params }) -> Merge.PaginatedStageList
@@ -9949,7 +10013,7 @@ await client.ats.asyncPassthrough.create({
-Retrieves data from earlier async-passthrough POST request +Returns a list of `Stage` objects.
@@ -9965,7 +10029,7 @@ Retrieves data from earlier async-passthrough POST request
```typescript -await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id"); +await client.crm.stages.list(); ```
@@ -9981,7 +10045,7 @@ await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**asyncPassthroughReceiptId:** `string` +**request:** `Merge.crm.StagesListRequest`
@@ -9989,7 +10053,7 @@ await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `Stages.RequestOptions`
@@ -10000,9 +10064,7 @@ await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-## Ats Attachments - -
client.ats.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList +
client.crm.stages.retrieve(id, { ...params }) -> Merge.Stage
@@ -10014,7 +10076,7 @@ await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-Returns a list of `Attachment` objects. +Returns a `Stage` object with the given `id`.
@@ -10030,7 +10092,7 @@ Returns a list of `Attachment` objects.
```typescript -await client.ats.attachments.list(); +await client.crm.stages.retrieve("id"); ```
@@ -10046,7 +10108,7 @@ await client.ats.attachments.list();
-**request:** `Merge.ats.AttachmentsListRequest` +**id:** `string`
@@ -10054,7 +10116,15 @@ await client.ats.attachments.list();
-**requestOptions:** `Attachments.RequestOptions` +**request:** `Merge.crm.StagesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Stages.RequestOptions`
@@ -10065,7 +10135,7 @@ await client.ats.attachments.list();
-
client.ats.attachments.create({ ...params }) -> Merge.AttachmentResponse +
client.crm.stages.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -10077,7 +10147,7 @@ await client.ats.attachments.list();
-Creates an `Attachment` object with the given values. +Returns a list of `RemoteFieldClass` objects.
@@ -10093,10 +10163,7 @@ Creates an `Attachment` object with the given values.
```typescript -await client.ats.attachments.create({ - model: {}, - remoteUserId: "remote_user_id", -}); +await client.crm.stages.remoteFieldClassesList(); ```
@@ -10112,7 +10179,7 @@ await client.ats.attachments.create({
-**request:** `Merge.ats.AttachmentEndpointRequest` +**request:** `Merge.crm.StagesRemoteFieldClassesListRequest`
@@ -10120,7 +10187,7 @@ await client.ats.attachments.create({
-**requestOptions:** `Attachments.RequestOptions` +**requestOptions:** `Stages.RequestOptions`
@@ -10131,7 +10198,9 @@ await client.ats.attachments.create({
-
client.ats.attachments.retrieve(id, { ...params }) -> Merge.Attachment +## Crm SyncStatus + +
client.crm.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
@@ -10143,7 +10212,7 @@ await client.ats.attachments.create({
-Returns an `Attachment` object with the given `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).
@@ -10159,7 +10228,7 @@ Returns an `Attachment` object with the given `id`.
```typescript -await client.ats.attachments.retrieve("id"); +await client.crm.syncStatus.list(); ```
@@ -10175,15 +10244,7 @@ await client.ats.attachments.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.AttachmentsRetrieveRequest` +**request:** `Merge.crm.SyncStatusListRequest`
@@ -10191,7 +10252,7 @@ await client.ats.attachments.retrieve("id");
-**requestOptions:** `Attachments.RequestOptions` +**requestOptions:** `SyncStatus.RequestOptions`
@@ -10202,7 +10263,9 @@ await client.ats.attachments.retrieve("id");
-
client.ats.attachments.metaPostRetrieve() -> Merge.MetaResponse +## Crm ForceResync + +
client.crm.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
@@ -10214,7 +10277,7 @@ await client.ats.attachments.retrieve("id");
-Returns metadata for `Attachment` 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.
@@ -10230,7 +10293,7 @@ Returns metadata for `Attachment` POSTs.
```typescript -await client.ats.attachments.metaPostRetrieve(); +await client.crm.forceResync.syncStatusResyncCreate(); ```
@@ -10246,7 +10309,7 @@ await client.ats.attachments.metaPostRetrieve();
-**requestOptions:** `Attachments.RequestOptions` +**requestOptions:** `ForceResync.RequestOptions`
@@ -10257,9 +10320,9 @@ await client.ats.attachments.metaPostRetrieve();
-## Ats AuditTrail +## Crm Tasks -
client.ats.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList +
client.crm.tasks.list({ ...params }) -> Merge.PaginatedTaskList
@@ -10271,7 +10334,7 @@ await client.ats.attachments.metaPostRetrieve();
-Gets a list of audit trail events. +Returns a list of `Task` objects.
@@ -10287,7 +10350,7 @@ Gets a list of audit trail events.
```typescript -await client.ats.auditTrail.list(); +await client.crm.tasks.list(); ```
@@ -10303,7 +10366,7 @@ await client.ats.auditTrail.list();
-**request:** `Merge.ats.AuditTrailListRequest` +**request:** `Merge.crm.TasksListRequest`
@@ -10311,7 +10374,7 @@ await client.ats.auditTrail.list();
-**requestOptions:** `AuditTrail.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -10322,9 +10385,7 @@ await client.ats.auditTrail.list();
-## Ats AvailableActions - -
client.ats.availableActions.retrieve() -> Merge.AvailableActions +
client.crm.tasks.create({ ...params }) -> Merge.TaskResponse
@@ -10336,7 +10397,7 @@ await client.ats.auditTrail.list();
-Returns a list of models and actions available for an account. +Creates a `Task` object with the given values.
@@ -10352,7 +10413,9 @@ Returns a list of models and actions available for an account.
```typescript -await client.ats.availableActions.retrieve(); +await client.crm.tasks.create({ + model: {}, +}); ```
@@ -10368,7 +10431,15 @@ await client.ats.availableActions.retrieve();
-**requestOptions:** `AvailableActions.RequestOptions` +**request:** `Merge.crm.TaskEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Tasks.RequestOptions`
@@ -10379,9 +10450,7 @@ await client.ats.availableActions.retrieve();
-## Ats Candidates - -
client.ats.candidates.list({ ...params }) -> Merge.PaginatedCandidateList +
client.crm.tasks.retrieve(id, { ...params }) -> Merge.Task
@@ -10393,7 +10462,7 @@ await client.ats.availableActions.retrieve();
-Returns a list of `Candidate` objects. +Returns a `Task` object with the given `id`.
@@ -10409,7 +10478,7 @@ Returns a list of `Candidate` objects.
```typescript -await client.ats.candidates.list(); +await client.crm.tasks.retrieve("id"); ```
@@ -10425,7 +10494,7 @@ await client.ats.candidates.list();
-**request:** `Merge.ats.CandidatesListRequest` +**id:** `string`
@@ -10433,7 +10502,15 @@ await client.ats.candidates.list();
-**requestOptions:** `Candidates.RequestOptions` +**request:** `Merge.crm.TasksRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Tasks.RequestOptions`
@@ -10444,7 +10521,7 @@ await client.ats.candidates.list();
-
client.ats.candidates.create({ ...params }) -> Merge.CandidateResponse +
client.crm.tasks.partialUpdate(id, { ...params }) -> Merge.TaskResponse
@@ -10456,7 +10533,7 @@ await client.ats.candidates.list();
-Creates a `Candidate` object with the given values. +Updates a `Task` object with the given `id`.
@@ -10472,9 +10549,8 @@ Creates a `Candidate` object with the given values.
```typescript -await client.ats.candidates.create({ +await client.crm.tasks.partialUpdate("id", { model: {}, - remoteUserId: "remote_user_id", }); ``` @@ -10491,7 +10567,7 @@ await client.ats.candidates.create({
-**request:** `Merge.ats.CandidateEndpointRequest` +**id:** `string`
@@ -10499,7 +10575,15 @@ await client.ats.candidates.create({
-**requestOptions:** `Candidates.RequestOptions` +**request:** `Merge.crm.PatchedTaskEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Tasks.RequestOptions`
@@ -10510,7 +10594,7 @@ await client.ats.candidates.create({
-
client.ats.candidates.retrieve(id, { ...params }) -> Merge.Candidate +
client.crm.tasks.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -10522,7 +10606,7 @@ await client.ats.candidates.create({
-Returns a `Candidate` object with the given `id`. +Returns metadata for `Task` PATCHs.
@@ -10538,7 +10622,7 @@ Returns a `Candidate` object with the given `id`.
```typescript -await client.ats.candidates.retrieve("id"); +await client.crm.tasks.metaPatchRetrieve("id"); ```
@@ -10562,15 +10646,7 @@ await client.ats.candidates.retrieve("id");
-**request:** `Merge.ats.CandidatesRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Candidates.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -10581,7 +10657,7 @@ await client.ats.candidates.retrieve("id");
-
client.ats.candidates.partialUpdate(id, { ...params }) -> Merge.CandidateResponse +
client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse
@@ -10593,7 +10669,7 @@ await client.ats.candidates.retrieve("id");
-Updates a `Candidate` object with the given `id`. +Returns metadata for `Task` POSTs.
@@ -10609,10 +10685,7 @@ Updates a `Candidate` object with the given `id`.
```typescript -await client.ats.candidates.partialUpdate("id", { - model: {}, - remoteUserId: "remote_user_id", -}); +await client.crm.tasks.metaPostRetrieve(); ```
@@ -10628,23 +10701,7 @@ await client.ats.candidates.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.PatchedCandidateEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Candidates.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -10655,7 +10712,7 @@ await client.ats.candidates.partialUpdate("id", {
-
client.ats.candidates.ignoreCreate(modelId, { ...params }) -> void +
client.crm.tasks.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -10667,7 +10724,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 a list of `RemoteFieldClass` objects.
@@ -10683,9 +10740,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.crm.tasks.remoteFieldClassesList(); ```
@@ -10701,15 +10756,7 @@ await client.ats.candidates.ignoreCreate("model_id", {
-**modelId:** `string` - -
-
- -
-
- -**request:** `Merge.ats.IgnoreCommonModelRequest` +**request:** `Merge.crm.TasksRemoteFieldClassesListRequest`
@@ -10717,7 +10764,7 @@ await client.ats.candidates.ignoreCreate("model_id", {
-**requestOptions:** `Candidates.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -10728,7 +10775,9 @@ await client.ats.candidates.ignoreCreate("model_id", {
-
client.ats.candidates.metaPatchRetrieve(id) -> Merge.MetaResponse +## Crm Users + +
client.crm.users.list({ ...params }) -> Merge.PaginatedUserList
@@ -10740,7 +10789,7 @@ await client.ats.candidates.ignoreCreate("model_id", {
-Returns metadata for `Candidate` PATCHs. +Returns a list of `User` objects.
@@ -10756,7 +10805,7 @@ Returns metadata for `Candidate` PATCHs.
```typescript -await client.ats.candidates.metaPatchRetrieve("id"); +await client.crm.users.list(); ```
@@ -10772,7 +10821,7 @@ await client.ats.candidates.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.crm.UsersListRequest`
@@ -10780,7 +10829,7 @@ await client.ats.candidates.metaPatchRetrieve("id");
-**requestOptions:** `Candidates.RequestOptions` +**requestOptions:** `Users.RequestOptions`
@@ -10791,7 +10840,7 @@ await client.ats.candidates.metaPatchRetrieve("id");
-
client.ats.candidates.metaPostRetrieve() -> Merge.MetaResponse +
client.crm.users.retrieve(id, { ...params }) -> Merge.User
@@ -10803,7 +10852,7 @@ await client.ats.candidates.metaPatchRetrieve("id");
-Returns metadata for `Candidate` POSTs. +Returns a `User` object with the given `id`.
@@ -10819,7 +10868,7 @@ Returns metadata for `Candidate` POSTs.
```typescript -await client.ats.candidates.metaPostRetrieve(); +await client.crm.users.retrieve("id"); ```
@@ -10835,20 +10884,34 @@ await client.ats.candidates.metaPostRetrieve();
-**requestOptions:** `Candidates.RequestOptions` +**id:** `string`
+ +
+
+ +**request:** `Merge.crm.UsersRetrieveRequest` +
+
+
+ +**requestOptions:** `Users.RequestOptions` + +
+
-
-## Ats Scopes + + +
-
client.ats.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi +
client.crm.users.ignoreCreate(modelId, { ...params }) -> void
@@ -10860,7 +10923,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). +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.
@@ -10876,7 +10939,9 @@ Get the default permissions for Merge Common Models and fields across all Linked
```typescript -await client.ats.scopes.defaultScopesRetrieve(); +await client.crm.users.ignoreCreate("model_id", { + reason: "GENERAL_CUSTOMER_REQUEST", +}); ```
@@ -10892,7 +10957,23 @@ await client.ats.scopes.defaultScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**modelId:** `string` + +
+
+ +
+
+ +**request:** `Merge.IgnoreCommonModelRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions`
@@ -10903,7 +10984,7 @@ await client.ats.scopes.defaultScopesRetrieve();
-
client.ats.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi +
client.crm.users.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -10915,7 +10996,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 a list of `RemoteFieldClass` objects.
@@ -10931,7 +11012,7 @@ Get all available permissions for Merge Common Models and fields for a single Li
```typescript -await client.ats.scopes.linkedAccountScopesRetrieve(); +await client.crm.users.remoteFieldClassesList(); ```
@@ -10947,7 +11028,15 @@ await client.ats.scopes.linkedAccountScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**request:** `Merge.crm.UsersRemoteFieldClassesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions`
@@ -10958,7 +11047,9 @@ await client.ats.scopes.linkedAccountScopesRetrieve();
-
client.ats.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi +## Crm WebhookReceivers + +
client.crm.webhookReceivers.list() -> Merge.WebhookReceiver[]
@@ -10970,7 +11061,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) +Returns a list of `WebhookReceiver` objects.
@@ -10986,57 +11077,23 @@ 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.crm.webhookReceivers.list(); ```
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**request:** `Merge.ats.LinkedAccountCommonModelScopeDeserializerRequest` - -
-
+
+
+ +#### ⚙️ Parameters
-**requestOptions:** `Scopes.RequestOptions` +
+
+ +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -11047,9 +11104,7 @@ await client.ats.scopes.linkedAccountScopesCreate({
-## Ats DeleteAccount - -
client.ats.deleteAccount.delete() -> void +
client.crm.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
@@ -11061,7 +11116,7 @@ await client.ats.scopes.linkedAccountScopesCreate({
-Delete a linked account. +Creates a `WebhookReceiver` object with the given values.
@@ -11077,7 +11132,10 @@ Delete a linked account.
```typescript -await client.ats.deleteAccount.delete(); +await client.crm.webhookReceivers.create({ + event: "event", + isActive: true, +}); ```
@@ -11093,7 +11151,15 @@ await client.ats.deleteAccount.delete();
-**requestOptions:** `DeleteAccount.RequestOptions` +**request:** `Merge.crm.WebhookReceiverRequest` + +
+
+ +
+
+ +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -11104,9 +11170,9 @@ await client.ats.deleteAccount.delete();
-## Ats Departments +## Filestorage AccountDetails -
client.ats.departments.list({ ...params }) -> Merge.PaginatedDepartmentList +
client.filestorage.accountDetails.retrieve() -> Merge.AccountDetails
@@ -11118,7 +11184,7 @@ await client.ats.deleteAccount.delete();
-Returns a list of `Department` objects. +Get details for a linked account.
@@ -11134,7 +11200,7 @@ Returns a list of `Department` objects.
```typescript -await client.ats.departments.list(); +await client.filestorage.accountDetails.retrieve(); ```
@@ -11150,15 +11216,7 @@ await client.ats.departments.list();
-**request:** `Merge.ats.DepartmentsListRequest` - -
-
- -
-
- -**requestOptions:** `Departments.RequestOptions` +**requestOptions:** `AccountDetails.RequestOptions`
@@ -11169,7 +11227,9 @@ await client.ats.departments.list();
-
client.ats.departments.retrieve(id, { ...params }) -> Merge.Department +## Filestorage AccountToken + +
client.filestorage.accountToken.retrieve(publicToken) -> Merge.AccountToken
@@ -11181,7 +11241,7 @@ await client.ats.departments.list();
-Returns a `Department` object with the given `id`. +Returns the account token for the end user with the provided public token.
@@ -11197,7 +11257,7 @@ Returns a `Department` object with the given `id`.
```typescript -await client.ats.departments.retrieve("id"); +await client.filestorage.accountToken.retrieve("public_token"); ```
@@ -11213,15 +11273,7 @@ await client.ats.departments.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.DepartmentsRetrieveRequest` +**publicToken:** `string`
@@ -11229,7 +11281,7 @@ await client.ats.departments.retrieve("id");
-**requestOptions:** `Departments.RequestOptions` +**requestOptions:** `AccountToken.RequestOptions`
@@ -11240,9 +11292,9 @@ await client.ats.departments.retrieve("id");
-## Ats Eeocs +## Filestorage AsyncPassthrough -
client.ats.eeocs.list({ ...params }) -> Merge.PaginatedEeocList +
client.filestorage.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
@@ -11254,7 +11306,7 @@ await client.ats.departments.retrieve("id");
-Returns a list of `EEOC` objects. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -11270,7 +11322,10 @@ Returns a list of `EEOC` objects.
```typescript -await client.ats.eeocs.list(); +await client.filestorage.asyncPassthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -11286,7 +11341,7 @@ await client.ats.eeocs.list();
-**request:** `Merge.ats.EeocsListRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -11294,7 +11349,7 @@ await client.ats.eeocs.list();
-**requestOptions:** `Eeocs.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -11305,7 +11360,7 @@ await client.ats.eeocs.list();
-
client.ats.eeocs.retrieve(id, { ...params }) -> Merge.Eeoc +
client.filestorage.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
@@ -11317,7 +11372,7 @@ await client.ats.eeocs.list();
-Returns an `EEOC` object with the given `id`. +Retrieves data from earlier async-passthrough POST request
@@ -11333,7 +11388,7 @@ Returns an `EEOC` object with the given `id`.
```typescript -await client.ats.eeocs.retrieve("id"); +await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
@@ -11349,15 +11404,7 @@ await client.ats.eeocs.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.EeocsRetrieveRequest` +**asyncPassthroughReceiptId:** `string`
@@ -11365,7 +11412,7 @@ await client.ats.eeocs.retrieve("id");
-**requestOptions:** `Eeocs.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -11376,9 +11423,9 @@ await client.ats.eeocs.retrieve("id");
-## Ats FieldMapping +## Filestorage AuditTrail -
client.ats.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse +
client.filestorage.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
@@ -11390,7 +11437,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/). +Gets a list of audit trail events.
@@ -11406,7 +11453,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```typescript -await client.ats.fieldMapping.fieldMappingsRetrieve(); +await client.filestorage.auditTrail.list(); ```
@@ -11422,7 +11469,7 @@ await client.ats.fieldMapping.fieldMappingsRetrieve();
-**request:** `Merge.ats.FieldMappingsRetrieveRequest` +**request:** `Merge.filestorage.AuditTrailListRequest`
@@ -11430,7 +11477,7 @@ await client.ats.fieldMapping.fieldMappingsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `AuditTrail.RequestOptions`
@@ -11441,7 +11488,9 @@ await client.ats.fieldMapping.fieldMappingsRetrieve();
-
client.ats.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse +## Filestorage AvailableActions + +
client.filestorage.availableActions.retrieve() -> Merge.AvailableActions
@@ -11453,7 +11502,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. +Returns a list of models and actions available for an account.
@@ -11469,14 +11518,7 @@ 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.availableActions.retrieve(); ```
@@ -11492,15 +11534,7 @@ await client.ats.fieldMapping.fieldMappingsCreate({
-**request:** `Merge.ats.CreateFieldMappingRequest` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `AvailableActions.RequestOptions`
@@ -11511,7 +11545,9 @@ await client.ats.fieldMapping.fieldMappingsCreate({
-
client.ats.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse +## Filestorage Scopes + +
client.filestorage.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -11523,7 +11559,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. +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).
@@ -11539,7 +11575,7 @@ 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.scopes.defaultScopesRetrieve(); ```
@@ -11555,15 +11591,7 @@ await client.ats.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**fieldMappingId:** `string` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -11574,7 +11602,7 @@ await client.ats.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
client.ats.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse +
client.filestorage.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -11586,7 +11614,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 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).
@@ -11602,7 +11630,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.scopes.linkedAccountScopesRetrieve(); ```
@@ -11618,23 +11646,7 @@ await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**fieldMappingId:** `string` - -
-
- -
-
- -**request:** `Merge.ats.PatchedEditFieldMappingRequest` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -11645,7 +11657,7 @@ await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
client.ats.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse +
client.filestorage.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
@@ -11657,7 +11669,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/). +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)
@@ -11673,7 +11685,33 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```typescript -await client.ats.fieldMapping.remoteFieldsRetrieve(); +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, + }, + }, + }, + ], +}); ```
@@ -11689,7 +11727,7 @@ await client.ats.fieldMapping.remoteFieldsRetrieve();
-**request:** `Merge.ats.RemoteFieldsRetrieveRequest` +**request:** `Merge.filestorage.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -11697,7 +11735,7 @@ await client.ats.fieldMapping.remoteFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -11708,7 +11746,9 @@ await client.ats.fieldMapping.remoteFieldsRetrieve();
-
client.ats.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse +## Filestorage DeleteAccount + +
client.filestorage.deleteAccount.delete() -> void
@@ -11720,7 +11760,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/). +Delete a linked account.
@@ -11736,7 +11776,7 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```typescript -await client.ats.fieldMapping.targetFieldsRetrieve(); +await client.filestorage.deleteAccount.delete(); ```
@@ -11752,7 +11792,7 @@ await client.ats.fieldMapping.targetFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `DeleteAccount.RequestOptions`
@@ -11763,9 +11803,9 @@ await client.ats.fieldMapping.targetFieldsRetrieve();
-## Ats GenerateKey +## Filestorage Drives -
client.ats.generateKey.create({ ...params }) -> Merge.RemoteKey +
client.filestorage.drives.list({ ...params }) -> Merge.PaginatedDriveList
@@ -11777,7 +11817,7 @@ await client.ats.fieldMapping.targetFieldsRetrieve();
-Create a remote key. +Returns a list of `Drive` objects.
@@ -11793,9 +11833,7 @@ Create a remote key.
```typescript -await client.ats.generateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.filestorage.drives.list(); ```
@@ -11811,7 +11849,7 @@ await client.ats.generateKey.create({
-**request:** `Merge.ats.GenerateRemoteKeyRequest` +**request:** `Merge.filestorage.DrivesListRequest`
@@ -11819,7 +11857,7 @@ await client.ats.generateKey.create({
-**requestOptions:** `GenerateKey.RequestOptions` +**requestOptions:** `Drives.RequestOptions`
@@ -11830,9 +11868,7 @@ await client.ats.generateKey.create({
-## Ats Interviews - -
client.ats.interviews.list({ ...params }) -> Merge.PaginatedScheduledInterviewList +
client.filestorage.drives.retrieve(id, { ...params }) -> Merge.Drive
@@ -11844,7 +11880,7 @@ await client.ats.generateKey.create({
-Returns a list of `ScheduledInterview` objects. +Returns a `Drive` object with the given `id`.
@@ -11860,7 +11896,7 @@ Returns a list of `ScheduledInterview` objects.
```typescript -await client.ats.interviews.list(); +await client.filestorage.drives.retrieve("id"); ```
@@ -11876,7 +11912,15 @@ await client.ats.interviews.list();
-**request:** `Merge.ats.InterviewsListRequest` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.filestorage.DrivesRetrieveRequest`
@@ -11884,7 +11928,7 @@ await client.ats.interviews.list();
-**requestOptions:** `Interviews.RequestOptions` +**requestOptions:** `Drives.RequestOptions`
@@ -11895,7 +11939,9 @@ await client.ats.interviews.list();
-
client.ats.interviews.create({ ...params }) -> Merge.ScheduledInterviewResponse +## Filestorage FieldMapping + +
client.filestorage.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
@@ -11907,7 +11953,7 @@ await client.ats.interviews.list();
-Creates a `ScheduledInterview` 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/).
@@ -11923,10 +11969,7 @@ Creates a `ScheduledInterview` object with the given values.
```typescript -await client.ats.interviews.create({ - model: {}, - remoteUserId: "remote_user_id", -}); +await client.filestorage.fieldMapping.fieldMappingsRetrieve(); ```
@@ -11942,7 +11985,7 @@ await client.ats.interviews.create({
-**request:** `Merge.ats.ScheduledInterviewEndpointRequest` +**request:** `Merge.filestorage.FieldMappingsRetrieveRequest`
@@ -11950,7 +11993,7 @@ await client.ats.interviews.create({
-**requestOptions:** `Interviews.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -11961,7 +12004,7 @@ await client.ats.interviews.create({
-
client.ats.interviews.retrieve(id, { ...params }) -> Merge.ScheduledInterview +
client.filestorage.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
@@ -11973,7 +12016,7 @@ await client.ats.interviews.create({
-Returns a `ScheduledInterview` object with the given `id`. +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -11989,7 +12032,14 @@ Returns a `ScheduledInterview` object with the given `id`.
```typescript -await client.ats.interviews.retrieve("id"); +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", +}); ```
@@ -12005,15 +12055,7 @@ await client.ats.interviews.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.InterviewsRetrieveRequest` +**request:** `Merge.filestorage.CreateFieldMappingRequest`
@@ -12021,7 +12063,7 @@ await client.ats.interviews.retrieve("id");
-**requestOptions:** `Interviews.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12032,7 +12074,7 @@ await client.ats.interviews.retrieve("id");
-
client.ats.interviews.metaPostRetrieve() -> Merge.MetaResponse +
client.filestorage.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
@@ -12044,7 +12086,7 @@ await client.ats.interviews.retrieve("id");
-Returns metadata for `ScheduledInterview` POSTs. +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.
@@ -12060,7 +12102,7 @@ Returns metadata for `ScheduledInterview` POSTs.
```typescript -await client.ats.interviews.metaPostRetrieve(); +await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
@@ -12076,7 +12118,15 @@ await client.ats.interviews.metaPostRetrieve();
-**requestOptions:** `Interviews.RequestOptions` +**fieldMappingId:** `string` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12087,9 +12137,7 @@ await client.ats.interviews.metaPostRetrieve();
-## Ats Issues - -
client.ats.issues.list({ ...params }) -> Merge.PaginatedIssueList +
client.filestorage.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
@@ -12101,7 +12149,7 @@ await client.ats.interviews.metaPostRetrieve();
-Gets all issues for Organization. +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.
@@ -12117,7 +12165,7 @@ Gets all issues for Organization.
```typescript -await client.ats.issues.list(); +await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); ```
@@ -12133,7 +12181,7 @@ await client.ats.issues.list();
-**request:** `Merge.ats.IssuesListRequest` +**fieldMappingId:** `string`
@@ -12141,7 +12189,15 @@ await client.ats.issues.list();
-**requestOptions:** `Issues.RequestOptions` +**request:** `Merge.filestorage.PatchedEditFieldMappingRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12152,7 +12208,7 @@ await client.ats.issues.list();
-
client.ats.issues.retrieve(id) -> Merge.Issue +
client.filestorage.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
@@ -12164,7 +12220,7 @@ await client.ats.issues.list();
-Get a specific issue. +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/).
@@ -12180,7 +12236,7 @@ Get a specific issue.
```typescript -await client.ats.issues.retrieve("id"); +await client.filestorage.fieldMapping.remoteFieldsRetrieve(); ```
@@ -12196,7 +12252,7 @@ await client.ats.issues.retrieve("id");
-**id:** `string` +**request:** `Merge.filestorage.RemoteFieldsRetrieveRequest`
@@ -12204,7 +12260,7 @@ await client.ats.issues.retrieve("id");
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12215,9 +12271,7 @@ await client.ats.issues.retrieve("id");
-## Ats JobInterviewStages - -
client.ats.jobInterviewStages.list({ ...params }) -> Merge.PaginatedJobInterviewStageList +
client.filestorage.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
@@ -12229,7 +12283,7 @@ await client.ats.issues.retrieve("id");
-Returns a list of `JobInterviewStage` objects. +Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -12245,7 +12299,7 @@ Returns a list of `JobInterviewStage` objects.
```typescript -await client.ats.jobInterviewStages.list(); +await client.filestorage.fieldMapping.targetFieldsRetrieve(); ```
@@ -12261,15 +12315,7 @@ await client.ats.jobInterviewStages.list();
-**request:** `Merge.ats.JobInterviewStagesListRequest` - -
-
- -
-
- -**requestOptions:** `JobInterviewStages.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12280,7 +12326,9 @@ await client.ats.jobInterviewStages.list();
-
client.ats.jobInterviewStages.retrieve(id, { ...params }) -> Merge.JobInterviewStage +## Filestorage Files + +
client.filestorage.files.list({ ...params }) -> Merge.PaginatedFileList
@@ -12292,7 +12340,7 @@ await client.ats.jobInterviewStages.list();
-Returns a `JobInterviewStage` object with the given `id`. +Returns a list of `File` objects.
@@ -12308,7 +12356,7 @@ Returns a `JobInterviewStage` object with the given `id`.
```typescript -await client.ats.jobInterviewStages.retrieve("id"); +await client.filestorage.files.list(); ```
@@ -12324,15 +12372,7 @@ await client.ats.jobInterviewStages.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.JobInterviewStagesRetrieveRequest` +**request:** `Merge.filestorage.FilesListRequest`
@@ -12340,7 +12380,7 @@ await client.ats.jobInterviewStages.retrieve("id");
-**requestOptions:** `JobInterviewStages.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -12351,9 +12391,7 @@ await client.ats.jobInterviewStages.retrieve("id");
-## Ats JobPostings - -
client.ats.jobPostings.list({ ...params }) -> Merge.PaginatedJobPostingList +
client.filestorage.files.create({ ...params }) -> Merge.FileStorageFileResponse
@@ -12365,7 +12403,7 @@ await client.ats.jobInterviewStages.retrieve("id");
-Returns a list of `JobPosting` objects. +Creates a `File` object with the given values.
@@ -12381,7 +12419,9 @@ Returns a list of `JobPosting` objects.
```typescript -await client.ats.jobPostings.list(); +await client.filestorage.files.create({ + model: {}, +}); ```
@@ -12397,7 +12437,7 @@ await client.ats.jobPostings.list();
-**request:** `Merge.ats.JobPostingsListRequest` +**request:** `Merge.filestorage.FileStorageFileEndpointRequest`
@@ -12405,7 +12445,7 @@ await client.ats.jobPostings.list();
-**requestOptions:** `JobPostings.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -12416,7 +12456,7 @@ await client.ats.jobPostings.list();
-
client.ats.jobPostings.retrieve(id, { ...params }) -> Merge.JobPosting +
client.filestorage.files.retrieve(id, { ...params }) -> Merge.File_
@@ -12428,7 +12468,7 @@ await client.ats.jobPostings.list();
-Returns a `JobPosting` object with the given `id`. +Returns a `File` object with the given `id`.
@@ -12444,7 +12484,7 @@ Returns a `JobPosting` object with the given `id`.
```typescript -await client.ats.jobPostings.retrieve("id"); +await client.filestorage.files.retrieve("id"); ```
@@ -12468,7 +12508,7 @@ await client.ats.jobPostings.retrieve("id");
-**request:** `Merge.ats.JobPostingsRetrieveRequest` +**request:** `Merge.filestorage.FilesRetrieveRequest`
@@ -12476,7 +12516,7 @@ await client.ats.jobPostings.retrieve("id");
-**requestOptions:** `JobPostings.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -12487,9 +12527,7 @@ await client.ats.jobPostings.retrieve("id");
-## Ats Jobs - -
client.ats.jobs.list({ ...params }) -> Merge.PaginatedJobList +
client.filestorage.files.downloadRequestMetaRetrieve(id, { ...params }) -> Merge.DownloadRequestMeta
@@ -12501,7 +12539,7 @@ await client.ats.jobPostings.retrieve("id");
-Returns a list of `Job` objects. +Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -12517,7 +12555,7 @@ Returns a list of `Job` objects.
```typescript -await client.ats.jobs.list(); +await client.filestorage.files.downloadRequestMetaRetrieve("id"); ```
@@ -12533,7 +12571,7 @@ await client.ats.jobs.list();
-**request:** `Merge.ats.JobsListRequest` +**id:** `string`
@@ -12541,7 +12579,15 @@ await client.ats.jobs.list();
-**requestOptions:** `Jobs.RequestOptions` +**request:** `Merge.filestorage.FilesDownloadRequestMetaRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Files.RequestOptions`
@@ -12552,7 +12598,7 @@ await client.ats.jobs.list();
-
client.ats.jobs.retrieve(id, { ...params }) -> Merge.Job +
client.filestorage.files.downloadRequestMetaList({ ...params }) -> Merge.PaginatedDownloadRequestMetaList
@@ -12564,7 +12610,7 @@ await client.ats.jobs.list();
-Returns a `Job` object with the given `id`. +Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -12580,7 +12626,7 @@ Returns a `Job` object with the given `id`.
```typescript -await client.ats.jobs.retrieve("id"); +await client.filestorage.files.downloadRequestMetaList(); ```
@@ -12596,15 +12642,7 @@ await client.ats.jobs.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.JobsRetrieveRequest` +**request:** `Merge.filestorage.FilesDownloadRequestMetaListRequest`
@@ -12612,7 +12650,7 @@ await client.ats.jobs.retrieve("id");
-**requestOptions:** `Jobs.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -12623,7 +12661,7 @@ await client.ats.jobs.retrieve("id");
-
client.ats.jobs.screeningQuestionsList(jobId, { ...params }) -> Merge.PaginatedScreeningQuestionList +
client.filestorage.files.metaPostRetrieve() -> Merge.MetaResponse
@@ -12635,7 +12673,7 @@ await client.ats.jobs.retrieve("id");
-Returns a list of `ScreeningQuestion` objects. +Returns metadata for `FileStorageFile` POSTs.
@@ -12651,7 +12689,7 @@ Returns a list of `ScreeningQuestion` objects.
```typescript -await client.ats.jobs.screeningQuestionsList("job_id"); +await client.filestorage.files.metaPostRetrieve(); ```
@@ -12667,23 +12705,7 @@ await client.ats.jobs.screeningQuestionsList("job_id");
-**jobId:** `string` - -
-
- -
-
- -**request:** `Merge.ats.JobsScreeningQuestionsListRequest` - -
-
- -
-
- -**requestOptions:** `Jobs.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -12694,9 +12716,9 @@ await client.ats.jobs.screeningQuestionsList("job_id");
-## Ats LinkToken +## Filestorage Folders -
client.ats.linkToken.create({ ...params }) -> Merge.LinkToken +
client.filestorage.folders.list({ ...params }) -> Merge.PaginatedFolderList
@@ -12708,7 +12730,7 @@ await client.ats.jobs.screeningQuestionsList("job_id");
-Creates a link token to be used when linking a new end user. +Returns a list of `Folder` objects.
@@ -12724,12 +12746,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.filestorage.folders.list(); ```
@@ -12745,7 +12762,7 @@ await client.ats.linkToken.create({
-**request:** `Merge.ats.EndUserDetailsRequest` +**request:** `Merge.filestorage.FoldersListRequest`
@@ -12753,7 +12770,7 @@ await client.ats.linkToken.create({
-**requestOptions:** `LinkToken.RequestOptions` +**requestOptions:** `Folders.RequestOptions`
@@ -12764,9 +12781,7 @@ await client.ats.linkToken.create({
-## Ats LinkedAccounts - -
client.ats.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList +
client.filestorage.folders.create({ ...params }) -> Merge.FileStorageFolderResponse
@@ -12778,7 +12793,7 @@ await client.ats.linkToken.create({
-List linked accounts for your organization. +Creates a `Folder` object with the given values.
@@ -12794,7 +12809,9 @@ List linked accounts for your organization.
```typescript -await client.ats.linkedAccounts.list(); +await client.filestorage.folders.create({ + model: {}, +}); ```
@@ -12810,7 +12827,7 @@ await client.ats.linkedAccounts.list();
-**request:** `Merge.ats.LinkedAccountsListRequest` +**request:** `Merge.filestorage.FileStorageFolderEndpointRequest`
@@ -12818,7 +12835,7 @@ await client.ats.linkedAccounts.list();
-**requestOptions:** `LinkedAccounts.RequestOptions` +**requestOptions:** `Folders.RequestOptions`
@@ -12829,9 +12846,7 @@ await client.ats.linkedAccounts.list();
-## Ats Offers - -
client.ats.offers.list({ ...params }) -> Merge.PaginatedOfferList +
client.filestorage.folders.retrieve(id, { ...params }) -> Merge.Folder
@@ -12843,7 +12858,7 @@ await client.ats.linkedAccounts.list();
-Returns a list of `Offer` objects. +Returns a `Folder` object with the given `id`.
@@ -12859,7 +12874,7 @@ Returns a list of `Offer` objects.
```typescript -await client.ats.offers.list(); +await client.filestorage.folders.retrieve("id"); ```
@@ -12875,7 +12890,15 @@ await client.ats.offers.list();
-**request:** `Merge.ats.OffersListRequest` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.filestorage.FoldersRetrieveRequest`
@@ -12883,7 +12906,7 @@ await client.ats.offers.list();
-**requestOptions:** `Offers.RequestOptions` +**requestOptions:** `Folders.RequestOptions`
@@ -12894,7 +12917,7 @@ await client.ats.offers.list();
-
client.ats.offers.retrieve(id, { ...params }) -> Merge.Offer +
client.filestorage.folders.metaPostRetrieve() -> Merge.MetaResponse
@@ -12906,7 +12929,7 @@ await client.ats.offers.list();
-Returns an `Offer` object with the given `id`. +Returns metadata for `FileStorageFolder` POSTs.
@@ -12922,7 +12945,7 @@ Returns an `Offer` object with the given `id`.
```typescript -await client.ats.offers.retrieve("id"); +await client.filestorage.folders.metaPostRetrieve(); ```
@@ -12938,23 +12961,7 @@ await client.ats.offers.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.OffersRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Offers.RequestOptions` +**requestOptions:** `Folders.RequestOptions`
@@ -12965,9 +12972,9 @@ await client.ats.offers.retrieve("id");
-## Ats Offices +## Filestorage GenerateKey -
client.ats.offices.list({ ...params }) -> Merge.PaginatedOfficeList +
client.filestorage.generateKey.create({ ...params }) -> Merge.RemoteKey
@@ -12979,7 +12986,7 @@ await client.ats.offers.retrieve("id");
-Returns a list of `Office` objects. +Create a remote key.
@@ -12995,7 +13002,9 @@ Returns a list of `Office` objects.
```typescript -await client.ats.offices.list(); +await client.filestorage.generateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -13011,7 +13020,7 @@ await client.ats.offices.list();
-**request:** `Merge.ats.OfficesListRequest` +**request:** `Merge.filestorage.GenerateRemoteKeyRequest`
@@ -13019,7 +13028,7 @@ await client.ats.offices.list();
-**requestOptions:** `Offices.RequestOptions` +**requestOptions:** `GenerateKey.RequestOptions`
@@ -13030,7 +13039,9 @@ await client.ats.offices.list();
-
client.ats.offices.retrieve(id, { ...params }) -> Merge.Office +## Filestorage Groups + +
client.filestorage.groups.list({ ...params }) -> Merge.PaginatedGroupList
@@ -13042,7 +13053,7 @@ await client.ats.offices.list();
-Returns an `Office` object with the given `id`. +Returns a list of `Group` objects.
@@ -13058,7 +13069,7 @@ Returns an `Office` object with the given `id`.
```typescript -await client.ats.offices.retrieve("id"); +await client.filestorage.groups.list(); ```
@@ -13074,15 +13085,7 @@ await client.ats.offices.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.OfficesRetrieveRequest` +**request:** `Merge.filestorage.GroupsListRequest`
@@ -13090,7 +13093,7 @@ await client.ats.offices.retrieve("id");
-**requestOptions:** `Offices.RequestOptions` +**requestOptions:** `Groups.RequestOptions`
@@ -13101,9 +13104,7 @@ await client.ats.offices.retrieve("id");
-## Ats Passthrough - -
client.ats.passthrough.create({ ...params }) -> Merge.RemoteResponse +
client.filestorage.groups.retrieve(id, { ...params }) -> Merge.Group
@@ -13115,7 +13116,7 @@ await client.ats.offices.retrieve("id");
-Pull data from an endpoint not currently supported by Merge. +Returns a `Group` object with the given `id`.
@@ -13131,10 +13132,7 @@ Pull data from an endpoint not currently supported by Merge.
```typescript -await client.ats.passthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.filestorage.groups.retrieve("id"); ```
@@ -13150,7 +13148,7 @@ await client.ats.passthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**id:** `string`
@@ -13158,7 +13156,15 @@ await client.ats.passthrough.create({
-**requestOptions:** `Passthrough.RequestOptions` +**request:** `Merge.filestorage.GroupsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Groups.RequestOptions`
@@ -13169,9 +13175,9 @@ await client.ats.passthrough.create({
-## Ats RegenerateKey +## Filestorage Issues -
client.ats.regenerateKey.create({ ...params }) -> Merge.RemoteKey +
client.filestorage.issues.list({ ...params }) -> Merge.PaginatedIssueList
@@ -13183,7 +13189,7 @@ await client.ats.passthrough.create({
-Exchange remote keys. +Gets all issues for Organization.
@@ -13199,9 +13205,7 @@ Exchange remote keys.
```typescript -await client.ats.regenerateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.filestorage.issues.list(); ```
@@ -13217,7 +13221,7 @@ await client.ats.regenerateKey.create({
-**request:** `Merge.ats.RemoteKeyForRegenerationRequest` +**request:** `Merge.filestorage.IssuesListRequest`
@@ -13225,7 +13229,7 @@ await client.ats.regenerateKey.create({
-**requestOptions:** `RegenerateKey.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -13236,9 +13240,7 @@ await client.ats.regenerateKey.create({
-## Ats RejectReasons - -
client.ats.rejectReasons.list({ ...params }) -> Merge.PaginatedRejectReasonList +
client.filestorage.issues.retrieve(id) -> Merge.Issue
@@ -13250,7 +13252,7 @@ await client.ats.regenerateKey.create({
-Returns a list of `RejectReason` objects. +Get a specific issue.
@@ -13266,7 +13268,7 @@ Returns a list of `RejectReason` objects.
```typescript -await client.ats.rejectReasons.list(); +await client.filestorage.issues.retrieve("id"); ```
@@ -13282,7 +13284,7 @@ await client.ats.rejectReasons.list();
-**request:** `Merge.ats.RejectReasonsListRequest` +**id:** `string`
@@ -13290,7 +13292,7 @@ await client.ats.rejectReasons.list();
-**requestOptions:** `RejectReasons.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -13301,7 +13303,9 @@ await client.ats.rejectReasons.list();
-
client.ats.rejectReasons.retrieve(id, { ...params }) -> Merge.RejectReason +## Filestorage LinkToken + +
client.filestorage.linkToken.create({ ...params }) -> Merge.LinkToken
@@ -13313,7 +13317,7 @@ await client.ats.rejectReasons.list();
-Returns a `RejectReason` object with the given `id`. +Creates a link token to be used when linking a new end user.
@@ -13329,7 +13333,12 @@ Returns a `RejectReason` object with the given `id`.
```typescript -await client.ats.rejectReasons.retrieve("id"); +await client.filestorage.linkToken.create({ + endUserEmailAddress: "example@gmail.com", + endUserOrganizationName: "Test Organization", + endUserOriginId: "12345", + categories: ["hris", "ats"], +}); ```
@@ -13345,15 +13354,7 @@ await client.ats.rejectReasons.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.RejectReasonsRetrieveRequest` +**request:** `Merge.filestorage.EndUserDetailsRequest`
@@ -13361,7 +13362,7 @@ await client.ats.rejectReasons.retrieve("id");
-**requestOptions:** `RejectReasons.RequestOptions` +**requestOptions:** `LinkToken.RequestOptions`
@@ -13372,9 +13373,9 @@ await client.ats.rejectReasons.retrieve("id");
-## Ats Scorecards +## Filestorage LinkedAccounts -
client.ats.scorecards.list({ ...params }) -> Merge.PaginatedScorecardList +
client.filestorage.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
@@ -13386,7 +13387,7 @@ await client.ats.rejectReasons.retrieve("id");
-Returns a list of `Scorecard` objects. +List linked accounts for your organization.
@@ -13402,7 +13403,7 @@ Returns a list of `Scorecard` objects.
```typescript -await client.ats.scorecards.list(); +await client.filestorage.linkedAccounts.list(); ```
@@ -13418,7 +13419,7 @@ await client.ats.scorecards.list();
-**request:** `Merge.ats.ScorecardsListRequest` +**request:** `Merge.filestorage.LinkedAccountsListRequest`
@@ -13426,7 +13427,7 @@ await client.ats.scorecards.list();
-**requestOptions:** `Scorecards.RequestOptions` +**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -13437,7 +13438,9 @@ await client.ats.scorecards.list();
-
client.ats.scorecards.retrieve(id, { ...params }) -> Merge.Scorecard +## Filestorage Passthrough + +
client.filestorage.passthrough.create({ ...params }) -> Merge.RemoteResponse
@@ -13449,7 +13452,7 @@ await client.ats.scorecards.list();
-Returns a `Scorecard` object with the given `id`. +Pull data from an endpoint not currently supported by Merge.
@@ -13465,7 +13468,10 @@ Returns a `Scorecard` object with the given `id`.
```typescript -await client.ats.scorecards.retrieve("id"); +await client.filestorage.passthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -13481,15 +13487,7 @@ await client.ats.scorecards.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.ats.ScorecardsRetrieveRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -13497,7 +13495,7 @@ await client.ats.scorecards.retrieve("id");
-**requestOptions:** `Scorecards.RequestOptions` +**requestOptions:** `Passthrough.RequestOptions`
@@ -13508,9 +13506,9 @@ await client.ats.scorecards.retrieve("id");
-## Ats SyncStatus +## Filestorage RegenerateKey -
client.ats.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList +
client.filestorage.regenerateKey.create({ ...params }) -> Merge.RemoteKey
@@ -13522,7 +13520,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). +Exchange remote keys.
@@ -13538,7 +13536,9 @@ Get sync status for the current sync and the most recently finished sync. `last_
```typescript -await client.ats.syncStatus.list(); +await client.filestorage.regenerateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -13554,7 +13554,7 @@ await client.ats.syncStatus.list();
-**request:** `Merge.ats.SyncStatusListRequest` +**request:** `Merge.filestorage.RemoteKeyForRegenerationRequest`
@@ -13562,7 +13562,7 @@ await client.ats.syncStatus.list();
-**requestOptions:** `SyncStatus.RequestOptions` +**requestOptions:** `RegenerateKey.RequestOptions`
@@ -13573,9 +13573,9 @@ await client.ats.syncStatus.list();
-## Ats ForceResync +## Filestorage SyncStatus -
client.ats.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[] +
client.filestorage.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
@@ -13587,7 +13587,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. +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).
@@ -13603,7 +13603,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```typescript -await client.ats.forceResync.syncStatusResyncCreate(); +await client.filestorage.syncStatus.list(); ```
@@ -13619,7 +13619,15 @@ await client.ats.forceResync.syncStatusResyncCreate();
-**requestOptions:** `ForceResync.RequestOptions` +**request:** `Merge.filestorage.SyncStatusListRequest` + +
+
+ +
+
+ +**requestOptions:** `SyncStatus.RequestOptions`
@@ -13630,9 +13638,9 @@ await client.ats.forceResync.syncStatusResyncCreate();
-## Ats Tags +## Filestorage ForceResync -
client.ats.tags.list({ ...params }) -> Merge.PaginatedTagList +
client.filestorage.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
@@ -13644,7 +13652,7 @@ await client.ats.forceResync.syncStatusResyncCreate();
-Returns a list of `Tag` 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.
@@ -13660,7 +13668,7 @@ Returns a list of `Tag` objects.
```typescript -await client.ats.tags.list(); +await client.filestorage.forceResync.syncStatusResyncCreate(); ```
@@ -13676,15 +13684,7 @@ await client.ats.tags.list();
-**request:** `Merge.ats.TagsListRequest` - -
-
- -
-
- -**requestOptions:** `Tags.RequestOptions` +**requestOptions:** `ForceResync.RequestOptions`
@@ -13695,9 +13695,9 @@ await client.ats.tags.list();
-## Ats Users +## Filestorage Users -
client.ats.users.list({ ...params }) -> Merge.PaginatedRemoteUserList +
client.filestorage.users.list({ ...params }) -> Merge.PaginatedUserList
@@ -13709,7 +13709,7 @@ await client.ats.tags.list();
-Returns a list of `RemoteUser` objects. +Returns a list of `User` objects.
@@ -13725,7 +13725,7 @@ Returns a list of `RemoteUser` objects.
```typescript -await client.ats.users.list(); +await client.filestorage.users.list(); ```
@@ -13741,7 +13741,7 @@ await client.ats.users.list();
-**request:** `Merge.ats.UsersListRequest` +**request:** `Merge.filestorage.UsersListRequest`
@@ -13760,7 +13760,7 @@ await client.ats.users.list();
-
client.ats.users.retrieve(id, { ...params }) -> Merge.RemoteUser +
client.filestorage.users.retrieve(id, { ...params }) -> Merge.User
@@ -13772,7 +13772,7 @@ await client.ats.users.list();
-Returns a `RemoteUser` object with the given `id`. +Returns a `User` object with the given `id`.
@@ -13788,7 +13788,7 @@ Returns a `RemoteUser` object with the given `id`.
```typescript -await client.ats.users.retrieve("id"); +await client.filestorage.users.retrieve("id"); ```
@@ -13812,7 +13812,7 @@ await client.ats.users.retrieve("id");
-**request:** `Merge.ats.UsersRetrieveRequest` +**request:** `Merge.filestorage.UsersRetrieveRequest`
@@ -13831,9 +13831,9 @@ await client.ats.users.retrieve("id");
-## Ats WebhookReceivers +## Filestorage WebhookReceivers -
client.ats.webhookReceivers.list() -> Merge.WebhookReceiver[] +
client.filestorage.webhookReceivers.list() -> Merge.WebhookReceiver[]
@@ -13861,7 +13861,7 @@ Returns a list of `WebhookReceiver` objects.
```typescript -await client.ats.webhookReceivers.list(); +await client.filestorage.webhookReceivers.list(); ```
@@ -13888,7 +13888,7 @@ await client.ats.webhookReceivers.list();
-
client.ats.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver +
client.filestorage.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
@@ -13916,7 +13916,7 @@ Creates a `WebhookReceiver` object with the given values.
```typescript -await client.ats.webhookReceivers.create({ +await client.filestorage.webhookReceivers.create({ event: "event", isActive: true, }); @@ -13935,7 +13935,7 @@ await client.ats.webhookReceivers.create({
-**request:** `Merge.ats.WebhookReceiverRequest` +**request:** `Merge.filestorage.WebhookReceiverRequest`
diff --git a/src/Client.ts b/src/Client.ts index 08a56264a..5370eeb1e 100644 --- a/src/Client.ts +++ b/src/Client.ts @@ -5,9 +5,9 @@ import * as environments from "./environments"; import * as core from "./core"; import { mergeHeaders } from "./core/headers"; +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 { Ats } from "./api/resources/ats/client/Client"; import { Hris } from "./api/resources/hris/client/Client"; import { Ticketing } from "./api/resources/ticketing/client/Client"; import { Accounting } from "./api/resources/accounting/client/Client"; @@ -43,9 +43,9 @@ 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 _ats: Ats | undefined; protected _hris: Hris | undefined; protected _ticketing: Ticketing | undefined; protected _accounting: Accounting | undefined; @@ -58,8 +58,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.1.1", - "User-Agent": "@mergeapi/merge-node-client/2.1.1", + "X-Fern-SDK-Version": "2.1.2", + "User-Agent": "@mergeapi/merge-node-client/2.1.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, }, @@ -68,6 +68,10 @@ 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)); } @@ -76,10 +80,6 @@ export class MergeClient { return (this._filestorage ??= new Filestorage(this._options)); } - public get ats(): Ats { - return (this._ats ??= new Ats(this._options)); - } - public get hris(): Hris { return (this._hris ??= new Hris(this._options)); } diff --git a/src/api/resources/accounting/types/RemoteFieldClass.ts b/src/api/resources/accounting/types/RemoteFieldClass.ts index 98df4fcfd..15ff24953 100644 --- a/src/api/resources/accounting/types/RemoteFieldClass.ts +++ b/src/api/resources/accounting/types/RemoteFieldClass.ts @@ -10,6 +10,7 @@ export interface RemoteFieldClass { remoteKeyName?: string; description?: string; isCustom?: boolean; + isCommonModelField?: boolean; isRequired?: boolean; fieldType?: Merge.accounting.FieldTypeEnum; fieldFormat?: Merge.accounting.FieldFormatEnum; diff --git a/src/api/resources/crm/types/RemoteFieldClass.ts b/src/api/resources/crm/types/RemoteFieldClass.ts index 690ebf3b3..34a51e22c 100644 --- a/src/api/resources/crm/types/RemoteFieldClass.ts +++ b/src/api/resources/crm/types/RemoteFieldClass.ts @@ -10,6 +10,7 @@ export interface RemoteFieldClass { remoteKeyName?: string; description?: string; isCustom?: boolean; + isCommonModelField?: boolean; isRequired?: boolean; fieldType?: Merge.crm.RemoteFieldClassFieldType; fieldFormat?: Merge.crm.RemoteFieldClassFieldFormat; diff --git a/src/api/resources/index.ts b/src/api/resources/index.ts index 3540704bd..2be011c93 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 ats from "./ats"; export * as hris from "./hris"; export * as ticketing from "./ticketing"; export * as accounting from "./accounting"; diff --git a/src/api/resources/ticketing/types/RemoteFieldClass.ts b/src/api/resources/ticketing/types/RemoteFieldClass.ts index 95b9f59ff..23e119f2d 100644 --- a/src/api/resources/ticketing/types/RemoteFieldClass.ts +++ b/src/api/resources/ticketing/types/RemoteFieldClass.ts @@ -10,6 +10,7 @@ export interface RemoteFieldClass { remoteKeyName?: string; description?: string; isCustom?: boolean; + isCommonModelField?: boolean; isRequired?: boolean; fieldType?: Merge.ticketing.RemoteFieldClassFieldType; fieldFormat?: Merge.ticketing.RemoteFieldClassFieldFormat; diff --git a/src/serialization/resources/accounting/types/RemoteFieldClass.ts b/src/serialization/resources/accounting/types/RemoteFieldClass.ts index 8b4bd74d8..1f2dee861 100644 --- a/src/serialization/resources/accounting/types/RemoteFieldClass.ts +++ b/src/serialization/resources/accounting/types/RemoteFieldClass.ts @@ -18,6 +18,7 @@ export const RemoteFieldClass: core.serialization.ObjectSchema< remoteKeyName: core.serialization.property("remote_key_name", core.serialization.string().optional()), description: core.serialization.string().optional(), isCustom: core.serialization.property("is_custom", core.serialization.boolean().optional()), + isCommonModelField: core.serialization.property("is_common_model_field", core.serialization.boolean().optional()), isRequired: core.serialization.property("is_required", core.serialization.boolean().optional()), fieldType: core.serialization.property("field_type", FieldTypeEnum.optional()), fieldFormat: core.serialization.property("field_format", FieldFormatEnum.optional()), @@ -35,6 +36,7 @@ export declare namespace RemoteFieldClass { remote_key_name?: string | null; description?: string | null; is_custom?: boolean | null; + is_common_model_field?: boolean | null; is_required?: boolean | null; field_type?: FieldTypeEnum.Raw | null; field_format?: FieldFormatEnum.Raw | null; diff --git a/src/serialization/resources/crm/types/RemoteFieldClass.ts b/src/serialization/resources/crm/types/RemoteFieldClass.ts index 052358ce2..f51b5435d 100644 --- a/src/serialization/resources/crm/types/RemoteFieldClass.ts +++ b/src/serialization/resources/crm/types/RemoteFieldClass.ts @@ -19,6 +19,7 @@ export const RemoteFieldClass: core.serialization.ObjectSchema< remoteKeyName: core.serialization.property("remote_key_name", core.serialization.string().optional()), description: core.serialization.string().optional(), isCustom: core.serialization.property("is_custom", core.serialization.boolean().optional()), + isCommonModelField: core.serialization.property("is_common_model_field", core.serialization.boolean().optional()), isRequired: core.serialization.property("is_required", core.serialization.boolean().optional()), fieldType: core.serialization.property("field_type", RemoteFieldClassFieldType.optional()), fieldFormat: core.serialization.property("field_format", RemoteFieldClassFieldFormat.optional()), @@ -36,6 +37,7 @@ export declare namespace RemoteFieldClass { remote_key_name?: string | null; description?: string | null; is_custom?: boolean | null; + is_common_model_field?: boolean | null; is_required?: boolean | null; field_type?: RemoteFieldClassFieldType.Raw | null; field_format?: RemoteFieldClassFieldFormat.Raw | null; diff --git a/src/serialization/resources/index.ts b/src/serialization/resources/index.ts index 3540704bd..2be011c93 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 ats from "./ats"; export * as hris from "./hris"; export * as ticketing from "./ticketing"; export * as accounting from "./accounting"; diff --git a/src/serialization/resources/ticketing/types/RemoteFieldClass.ts b/src/serialization/resources/ticketing/types/RemoteFieldClass.ts index 38967a499..1f10aa46c 100644 --- a/src/serialization/resources/ticketing/types/RemoteFieldClass.ts +++ b/src/serialization/resources/ticketing/types/RemoteFieldClass.ts @@ -19,6 +19,7 @@ export const RemoteFieldClass: core.serialization.ObjectSchema< remoteKeyName: core.serialization.property("remote_key_name", core.serialization.string().optional()), description: core.serialization.string().optional(), isCustom: core.serialization.property("is_custom", core.serialization.boolean().optional()), + isCommonModelField: core.serialization.property("is_common_model_field", core.serialization.boolean().optional()), isRequired: core.serialization.property("is_required", core.serialization.boolean().optional()), fieldType: core.serialization.property("field_type", RemoteFieldClassFieldType.optional()), fieldFormat: core.serialization.property("field_format", RemoteFieldClassFieldFormat.optional()), @@ -36,6 +37,7 @@ export declare namespace RemoteFieldClass { remote_key_name?: string | null; description?: string | null; is_custom?: boolean | null; + is_common_model_field?: boolean | null; is_required?: boolean | null; field_type?: RemoteFieldClassFieldType.Raw | null; field_format?: RemoteFieldClassFieldFormat.Raw | null; diff --git a/src/version.ts b/src/version.ts index 7f96ac90a..3c989022c 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const SDK_VERSION = "2.1.1"; +export const SDK_VERSION = "2.1.2"; diff --git a/tests/wire/accounting/contacts.test.ts b/tests/wire/accounting/contacts.test.ts index 491ae385f..d4800f596 100644 --- a/tests/wire/accounting/contacts.test.ts +++ b/tests/wire/accounting/contacts.test.ts @@ -786,6 +786,7 @@ describe("Contacts", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -812,6 +813,7 @@ describe("Contacts", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/accounting/expenseReports.test.ts b/tests/wire/accounting/expenseReports.test.ts index 393c11904..3e68d8e5e 100644 --- a/tests/wire/accounting/expenseReports.test.ts +++ b/tests/wire/accounting/expenseReports.test.ts @@ -585,6 +585,7 @@ describe("ExpenseReports", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -611,6 +612,7 @@ describe("ExpenseReports", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", @@ -1050,6 +1052,7 @@ describe("ExpenseReports", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1076,6 +1079,7 @@ describe("ExpenseReports", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/accounting/expenses.test.ts b/tests/wire/accounting/expenses.test.ts index 92b29fc61..48afb0b28 100644 --- a/tests/wire/accounting/expenses.test.ts +++ b/tests/wire/accounting/expenses.test.ts @@ -632,6 +632,7 @@ describe("Expenses", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -658,6 +659,7 @@ describe("Expenses", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", @@ -1097,6 +1099,7 @@ describe("Expenses", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1123,6 +1126,7 @@ describe("Expenses", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/accounting/invoices.test.ts b/tests/wire/accounting/invoices.test.ts index b3c40ff8f..e5de55649 100644 --- a/tests/wire/accounting/invoices.test.ts +++ b/tests/wire/accounting/invoices.test.ts @@ -1027,6 +1027,7 @@ describe("Invoices", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1053,6 +1054,7 @@ describe("Invoices", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", @@ -1908,6 +1910,7 @@ describe("Invoices", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1934,6 +1937,7 @@ describe("Invoices", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/accounting/journalEntries.test.ts b/tests/wire/accounting/journalEntries.test.ts index 671999e62..b88711b32 100644 --- a/tests/wire/accounting/journalEntries.test.ts +++ b/tests/wire/accounting/journalEntries.test.ts @@ -602,6 +602,7 @@ describe("JournalEntries", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -628,6 +629,7 @@ describe("JournalEntries", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", @@ -1067,6 +1069,7 @@ describe("JournalEntries", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1093,6 +1096,7 @@ describe("JournalEntries", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/accounting/payments.test.ts b/tests/wire/accounting/payments.test.ts index 277d82c4f..2e8131b3d 100644 --- a/tests/wire/accounting/payments.test.ts +++ b/tests/wire/accounting/payments.test.ts @@ -685,6 +685,7 @@ describe("Payments", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -711,6 +712,7 @@ describe("Payments", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", @@ -1566,6 +1568,7 @@ describe("Payments", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1592,6 +1595,7 @@ describe("Payments", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/accounting/purchaseOrders.test.ts b/tests/wire/accounting/purchaseOrders.test.ts index da1d58253..0f44ad168 100644 --- a/tests/wire/accounting/purchaseOrders.test.ts +++ b/tests/wire/accounting/purchaseOrders.test.ts @@ -666,6 +666,7 @@ describe("PurchaseOrders", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -692,6 +693,7 @@ describe("PurchaseOrders", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", @@ -1131,6 +1133,7 @@ describe("PurchaseOrders", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1157,6 +1160,7 @@ describe("PurchaseOrders", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/accounts.test.ts b/tests/wire/crm/accounts.test.ts index a1d67cb11..f38ac3fee 100644 --- a/tests/wire/crm/accounts.test.ts +++ b/tests/wire/crm/accounts.test.ts @@ -1447,6 +1447,7 @@ describe("Accounts", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1473,6 +1474,7 @@ describe("Accounts", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/contacts.test.ts b/tests/wire/crm/contacts.test.ts index 092ec1f7e..0f1e10afb 100644 --- a/tests/wire/crm/contacts.test.ts +++ b/tests/wire/crm/contacts.test.ts @@ -1506,6 +1506,7 @@ describe("Contacts", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1532,6 +1533,7 @@ describe("Contacts", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/customObjects.test.ts b/tests/wire/crm/customObjects.test.ts index b932952bc..beb28264d 100644 --- a/tests/wire/crm/customObjects.test.ts +++ b/tests/wire/crm/customObjects.test.ts @@ -650,6 +650,7 @@ describe("CustomObjects", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -676,6 +677,7 @@ describe("CustomObjects", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/engagementTypes.test.ts b/tests/wire/crm/engagementTypes.test.ts index 376507fbb..39716b499 100644 --- a/tests/wire/crm/engagementTypes.test.ts +++ b/tests/wire/crm/engagementTypes.test.ts @@ -109,6 +109,7 @@ describe("EngagementTypes", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -135,6 +136,7 @@ describe("EngagementTypes", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/engagements.test.ts b/tests/wire/crm/engagements.test.ts index c1e724e66..c417515f1 100644 --- a/tests/wire/crm/engagements.test.ts +++ b/tests/wire/crm/engagements.test.ts @@ -1285,6 +1285,7 @@ describe("Engagements", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1311,6 +1312,7 @@ describe("Engagements", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/leads.test.ts b/tests/wire/crm/leads.test.ts index e1d395db0..b9edde656 100644 --- a/tests/wire/crm/leads.test.ts +++ b/tests/wire/crm/leads.test.ts @@ -906,6 +906,7 @@ describe("Leads", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -932,6 +933,7 @@ describe("Leads", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/notes.test.ts b/tests/wire/crm/notes.test.ts index f6d21c6f7..540c3b6a8 100644 --- a/tests/wire/crm/notes.test.ts +++ b/tests/wire/crm/notes.test.ts @@ -708,6 +708,7 @@ describe("Notes", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -734,6 +735,7 @@ describe("Notes", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/opportunities.test.ts b/tests/wire/crm/opportunities.test.ts index 09c591c5d..412a979cb 100644 --- a/tests/wire/crm/opportunities.test.ts +++ b/tests/wire/crm/opportunities.test.ts @@ -1293,6 +1293,7 @@ describe("Opportunities", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1319,6 +1320,7 @@ describe("Opportunities", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/stages.test.ts b/tests/wire/crm/stages.test.ts index 6ecf4a470..726675284 100644 --- a/tests/wire/crm/stages.test.ts +++ b/tests/wire/crm/stages.test.ts @@ -135,6 +135,7 @@ describe("Stages", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -161,6 +162,7 @@ describe("Stages", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/tasks.test.ts b/tests/wire/crm/tasks.test.ts index 4af512e8d..311f576e3 100644 --- a/tests/wire/crm/tasks.test.ts +++ b/tests/wire/crm/tasks.test.ts @@ -1265,6 +1265,7 @@ describe("Tasks", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -1291,6 +1292,7 @@ describe("Tasks", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/crm/users.test.ts b/tests/wire/crm/users.test.ts index 0a7e0d196..1bfa4ae36 100644 --- a/tests/wire/crm/users.test.ts +++ b/tests/wire/crm/users.test.ts @@ -162,6 +162,7 @@ describe("Users", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "string", field_format: "string", @@ -188,6 +189,7 @@ describe("Users", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "string", fieldFormat: "string", diff --git a/tests/wire/ticketing/tickets.test.ts b/tests/wire/ticketing/tickets.test.ts index e4cdd15db..01fd2a04e 100644 --- a/tests/wire/ticketing/tickets.test.ts +++ b/tests/wire/ticketing/tickets.test.ts @@ -1423,6 +1423,7 @@ describe("Tickets", () => { remote_key_name: "remote_key_name", description: "description", is_custom: true, + is_common_model_field: true, is_required: true, field_type: "field_type", field_format: "field_format", @@ -1449,6 +1450,7 @@ describe("Tickets", () => { remoteKeyName: "remote_key_name", description: "description", isCustom: true, + isCommonModelField: true, isRequired: true, fieldType: "field_type", fieldFormat: "field_format", diff --git a/yarn.lock b/yarn.lock index d6f6a066d..d7b1c1fe9 100644 --- a/yarn.lock +++ b/yarn.lock @@ -25,33 +25,33 @@ integrity sha512-60X7qkglvrap8mn1lh2ebxXdZYtUcpd7gsmy9kLaBJ4i/WdY8PqTSdxyA8qraikqKQK5C1KRBKXqznrVapyNaw== "@babel/core@^7.11.6", "@babel/core@^7.12.3", "@babel/core@^7.23.9": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.0.tgz#55dad808d5bf3445a108eefc88ea3fdf034749a4" - integrity sha512-UlLAnTPrFdNGoFtbSXwcGFQBtQZJCNjaN6hQNP3UPvuNXT1i82N26KL3dZeIpNalWywr9IuQuncaAfUaS1g6sQ== + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.3.tgz#aceddde69c5d1def69b839d09efa3e3ff59c97cb" + integrity sha512-yDBHV9kQNcr2/sUr9jghVyz9C3Y5G2zUM2H2lo+9mKv4sFgbA8s8Z9t8D1jiTkGoO/NoIfKMyKWr4s6CN23ZwQ== dependencies: "@ampproject/remapping" "^2.2.0" "@babel/code-frame" "^7.27.1" - "@babel/generator" "^7.28.0" + "@babel/generator" "^7.28.3" "@babel/helper-compilation-targets" "^7.27.2" - "@babel/helper-module-transforms" "^7.27.3" - "@babel/helpers" "^7.27.6" - "@babel/parser" "^7.28.0" + "@babel/helper-module-transforms" "^7.28.3" + "@babel/helpers" "^7.28.3" + "@babel/parser" "^7.28.3" "@babel/template" "^7.27.2" - "@babel/traverse" "^7.28.0" - "@babel/types" "^7.28.0" + "@babel/traverse" "^7.28.3" + "@babel/types" "^7.28.2" 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.28.0", "@babel/generator@^7.7.2": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.28.0.tgz#9cc2f7bd6eb054d77dc66c2664148a0c5118acd2" - integrity sha512-lJjzvrbEeWrhB4P3QBsH7tey117PjLZnDbLiQEKjQ/fNJTjuq4HSqgFA+UNSwZT8D7dxxbnuSBMsa1lrWzKlQg== +"@babel/generator@^7.28.3", "@babel/generator@^7.7.2": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.28.3.tgz#9626c1741c650cbac39121694a0f2d7451b8ef3e" + integrity sha512-3lSpxGgvnmZznmBkCRnVREPUFJv2wrv9iAoFDvADJc0ypmdOxdUtcLeBgBJ6zE0PMeTKnxeQzyk0xTBq4Ep7zw== dependencies: - "@babel/parser" "^7.28.0" - "@babel/types" "^7.28.0" + "@babel/parser" "^7.28.3" + "@babel/types" "^7.28.2" "@jridgewell/gen-mapping" "^0.3.12" "@jridgewell/trace-mapping" "^0.3.28" jsesc "^3.0.2" @@ -80,14 +80,14 @@ "@babel/traverse" "^7.27.1" "@babel/types" "^7.27.1" -"@babel/helper-module-transforms@^7.27.3": - version "7.27.3" - resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.27.3.tgz#db0bbcfba5802f9ef7870705a7ef8788508ede02" - integrity sha512-dSOvYwvyLsWBeIRyOeHXp5vPj5l1I011r52FM1+r1jCERv+aFXYk4whgQccYEGYxK2H3ZAIA8nuPkQ0HaUo3qg== +"@babel/helper-module-transforms@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.28.3.tgz#a2b37d3da3b2344fe085dab234426f2b9a2fa5f6" + integrity sha512-gytXUbs8k2sXS9PnQptz5o0QnpLL51SwASIORY6XaBKF88nsOT0Zw9szLqlSGQDP/4TljBAD5y98p2U1fqkdsw== dependencies: "@babel/helper-module-imports" "^7.27.1" "@babel/helper-validator-identifier" "^7.27.1" - "@babel/traverse" "^7.27.3" + "@babel/traverse" "^7.28.3" "@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.10.4", "@babel/helper-plugin-utils@^7.12.13", "@babel/helper-plugin-utils@^7.14.5", "@babel/helper-plugin-utils@^7.27.1", "@babel/helper-plugin-utils@^7.8.0": version "7.27.1" @@ -109,20 +109,20 @@ resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz#fa52f5b1e7db1ab049445b421c4471303897702f" integrity sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg== -"@babel/helpers@^7.27.6": - version "7.28.2" - resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.2.tgz#80f0918fecbfebea9af856c419763230040ee850" - integrity sha512-/V9771t+EgXz62aCcyofnQhGM8DQACbRhvzKFsXKC9QM+5MadF8ZmIm0crDMaz3+o0h0zXfJnd4EhbYbxsrcFw== +"@babel/helpers@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.3.tgz#b83156c0a2232c133d1b535dd5d3452119c7e441" + integrity sha512-PTNtvUQihsAsDHMOP5pfobP8C6CM4JWXmP8DrEIt46c3r2bf87Ua1zoqevsMo9g+tWDwgWrFP5EIxuBx5RudAw== dependencies: "@babel/template" "^7.27.2" "@babel/types" "^7.28.2" -"@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.28.0": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.0.tgz#979829fbab51a29e13901e5a80713dbcb840825e" - integrity sha512-jVZGvOxOuNSsuQuLRTh13nU0AogFlw32w/MT+LV6D3sP5WdbW61E77RnkbaO2dUvmPAYrBDJXGn5gGS6tH4j8g== +"@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.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.3.tgz#d2d25b814621bca5fe9d172bc93792547e7a2a71" + integrity sha512-7+Ey1mAgYqFAx2h0RuoxcQT5+MlG3GTV0TQrgr7/ZliKsm/MNDxVVutlWaziMq7wJNAz8MTqz55XLpWvva6StA== dependencies: - "@babel/types" "^7.28.0" + "@babel/types" "^7.28.2" "@babel/plugin-syntax-async-generators@^7.8.4": version "7.8.4" @@ -252,20 +252,20 @@ "@babel/parser" "^7.27.2" "@babel/types" "^7.27.1" -"@babel/traverse@^7.27.1", "@babel/traverse@^7.27.3", "@babel/traverse@^7.28.0": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.0.tgz#518aa113359b062042379e333db18380b537e34b" - integrity sha512-mGe7UK5wWyh0bKRfupsUchrQGqvDbZDbKJw+kcRGSmdHVYrv+ltd0pnpDTVpiTqnaBru9iEvA8pz8W46v0Amwg== +"@babel/traverse@^7.27.1", "@babel/traverse@^7.28.3": + version "7.28.3" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.3.tgz#6911a10795d2cce43ec6a28cffc440cca2593434" + integrity sha512-7w4kZYHneL3A6NP2nxzHvT3HCZ7puDZZjFMqDpBPECub79sTtSO5CGXDkKrTQq8ksAwfD/XI2MRFX23njdDaIQ== dependencies: "@babel/code-frame" "^7.27.1" - "@babel/generator" "^7.28.0" + "@babel/generator" "^7.28.3" "@babel/helper-globals" "^7.28.0" - "@babel/parser" "^7.28.0" + "@babel/parser" "^7.28.3" "@babel/template" "^7.27.2" - "@babel/types" "^7.28.0" + "@babel/types" "^7.28.2" debug "^4.3.1" -"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.27.1", "@babel/types@^7.28.0", "@babel/types@^7.28.2", "@babel/types@^7.3.3": +"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.27.1", "@babel/types@^7.28.2", "@babel/types@^7.3.3": version "7.28.2" resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.28.2.tgz#da9db0856a9a88e0a13b019881d7513588cf712b" integrity sha512-ruv7Ae4J5dUYULmeXw1gmb7rYRz57OWCPM57pHojnLq/3Z1CK2lNSLTCVjxVk1F/TZHwOZZrOWi0ur95BbLxNQ== @@ -301,17 +301,17 @@ tough-cookie "^4.1.4" "@inquirer/confirm@^5.0.0": - version "5.1.14" - resolved "https://registry.yarnpkg.com/@inquirer/confirm/-/confirm-5.1.14.tgz#e6321edf51a3a5f54dc548b80ef6ba89891351ad" - integrity sha512-5yR4IBfe0kXe59r1YCTG8WXkUbl7Z35HK87Sw+WUyGD8wNUx7JvY7laahzeytyE1oLn74bQnL7hstctQxisQ8Q== + version "5.1.16" + resolved "https://registry.yarnpkg.com/@inquirer/confirm/-/confirm-5.1.16.tgz#4f99603e5c8a1b471b819343f708c75e8abd2b88" + integrity sha512-j1a5VstaK5KQy8Mu8cHmuQvN1Zc62TbLhjJxwHvKPPKEoowSF6h/0UdOpA9DNdWZ+9Inq73+puRq1df6OJ8Sag== dependencies: - "@inquirer/core" "^10.1.15" + "@inquirer/core" "^10.2.0" "@inquirer/type" "^3.0.8" -"@inquirer/core@^10.1.15": - version "10.1.15" - resolved "https://registry.yarnpkg.com/@inquirer/core/-/core-10.1.15.tgz#8feb69fd536786181a2b6bfb84d8674faa9d2e59" - integrity sha512-8xrp836RZvKkpNbVvgWUlxjT4CraKk2q+I3Ksy+seI2zkcE+y6wNs1BVhgcv8VyImFecUhdQrYLdW32pAjwBdA== +"@inquirer/core@^10.2.0": + version "10.2.0" + resolved "https://registry.yarnpkg.com/@inquirer/core/-/core-10.2.0.tgz#19ff527dbe0956891d825e320ecbc890bd6a1550" + integrity sha512-NyDSjPqhSvpZEMZrLCYUquWNl+XC/moEcVFqS55IEYIYsY0a1cUCevSqk7ctOlnm/RaSBU5psFryNlxcmGrjaA== dependencies: "@inquirer/figures" "^1.0.13" "@inquirer/type" "^3.0.8" @@ -541,9 +541,9 @@ chalk "^4.0.0" "@jridgewell/gen-mapping@^0.3.12", "@jridgewell/gen-mapping@^0.3.5": - version "0.3.12" - resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.12.tgz#2234ce26c62889f03db3d7fea43c1932ab3e927b" - integrity sha512-OuLGC46TjB5BbN1dH8JULVVZY4WTdkF7tV9Ys6wLL1rubZnCMstOhNHueU5bLCrnRuDhKPDM4g6sw4Bel5Gzqg== + version "0.3.13" + resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz#6342a19f44347518c93e43b1ac69deb3c4656a1f" + integrity sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA== dependencies: "@jridgewell/sourcemap-codec" "^1.5.0" "@jridgewell/trace-mapping" "^0.3.24" @@ -554,30 +554,30 @@ integrity sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw== "@jridgewell/source-map@^0.3.3": - 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== + version "0.3.11" + resolved "https://registry.yarnpkg.com/@jridgewell/source-map/-/source-map-0.3.11.tgz#b21835cbd36db656b857c2ad02ebd413cc13a9ba" + integrity sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA== dependencies: "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.25" "@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== + version "1.5.5" + resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz#6912b00d2c631c0d15ce1a7ab57cd657f2a8f8ba" + integrity sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og== "@jridgewell/trace-mapping@^0.3.12", "@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.25", "@jridgewell/trace-mapping@^0.3.28": - 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== + version "0.3.30" + resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.30.tgz#4a76c4daeee5df09f5d3940e087442fb36ce2b99" + integrity sha512-GQ7Nw5G2lTu/BtHTKfXhKHok2WGetd4XYcVKGx00SjAk8GMwgJM3zr6zORiPGuOE+/vkc90KtTosSSvaCjKb2Q== dependencies: "@jridgewell/resolve-uri" "^3.1.0" "@jridgewell/sourcemap-codec" "^1.4.14" "@mswjs/interceptors@^0.39.1": - version "0.39.4" - resolved "https://registry.yarnpkg.com/@mswjs/interceptors/-/interceptors-0.39.4.tgz#820727657bf8be02c185c3e9c83f7209e3c73467" - integrity sha512-B82DbrGVCIBrNEfRJbqUFB0eNz0wVzqbenEpmbE71XLVU4yKZbDnRBuxz+7udc/uM7LDWDD4sRJ5tISzHf2QkQ== + version "0.39.6" + resolved "https://registry.yarnpkg.com/@mswjs/interceptors/-/interceptors-0.39.6.tgz#44094a578f20da4749d1a0eaf3cdb7973604004b" + integrity sha512-bndDP83naYYkfayr/qhBHMhk0YGwS1iv6vaEGcr0SQbO0IZtbOPqjKjds/WcG+bJA+1T5vCx6kprKOzn5Bg+Vw== dependencies: "@open-draft/deferred-promise" "^2.2.0" "@open-draft/logger" "^0.3.0" @@ -655,11 +655,11 @@ "@babel/types" "^7.0.0" "@types/babel__traverse@*", "@types/babel__traverse@^7.0.6": - version "7.20.7" - resolved "https://registry.yarnpkg.com/@types/babel__traverse/-/babel__traverse-7.20.7.tgz#968cdc2366ec3da159f61166428ee40f370e56c2" - integrity sha512-dkO5fhS7+/oos4ciWxyEyjWe48zmG6wbCheo/G2ZnHx4fs3EU6YC6UM8rk56gAjNJ9P3MTH2jo5jb92/K6wbng== + version "7.28.0" + resolved "https://registry.yarnpkg.com/@types/babel__traverse/-/babel__traverse-7.28.0.tgz#07d713d6cce0d265c9849db0cbe62d3f61f36f74" + integrity sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q== dependencies: - "@babel/types" "^7.20.7" + "@babel/types" "^7.28.2" "@types/cookie@^0.6.0": version "0.6.0" @@ -736,24 +736,24 @@ integrity sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA== "@types/node-fetch@^2.6.12": - version "2.6.12" - resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.6.12.tgz#8ab5c3ef8330f13100a7479e2cd56d3386830a03" - integrity sha512-8nneRWKCg3rMtF69nLQJnOYUcbafYeFSjqkw3jCRLsqkWFlHaoQrr5mXmofFGOx3DKn7UfmBMyov8ySvLRVldA== + version "2.6.13" + resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.6.13.tgz#e0c9b7b5edbdb1b50ce32c127e85e880872d56ee" + integrity sha512-QGpRVpzSaUs30JBSGPjOg4Uveu384erbHBoT1zeONvyCfwQxIkUshLAOqN/k9EjGviPRmWTTe6aH2qySWKTVSw== dependencies: "@types/node" "*" - form-data "^4.0.0" + form-data "^4.0.4" "@types/node@*": - version "24.1.0" - resolved "https://registry.yarnpkg.com/@types/node/-/node-24.1.0.tgz#0993f7dc31ab5cc402d112315b463e383d68a49c" - integrity sha512-ut5FthK5moxFKH2T1CUOC6ctR67rQRvvHdFLCD2Ql6KXmMuCrjsSsRI9UsLCm9M18BMwClv4pn327UvB7eeO1w== + version "24.3.0" + resolved "https://registry.yarnpkg.com/@types/node/-/node-24.3.0.tgz#89b09f45cb9a8ee69466f18ee5864e4c3eb84dec" + integrity sha512-aPTXCrfwnDLj4VvXrm+UUCQjNEvJgNA8s5F1cvwQU+3KNltTOkBm1j30uNLyqqPNe7gE3KFzImYoZEfLhp4Yow== dependencies: - undici-types "~7.8.0" + undici-types "~7.10.0" "@types/node@^18.19.70": - version "18.19.120" - resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.120.tgz#07b3bd73875956d5281fa27e6d77a66415f7d455" - integrity sha512-WtCGHFXnVI8WHLxDAt5TbnCM4eSE+nI0QN2NJtwzcgMhht2eNz6V9evJrk+lwC8bCY8OWV5Ym8Jz7ZEyGnKnMA== + version "18.19.123" + resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.123.tgz#08a3e4f5e0c73b8840c677b7635ce59d5dc1f76d" + integrity sha512-K7DIaHnh0mzVxreCR9qwgNxp3MH9dltPNIEddW9MYUlcKAzm+3grKNSTe2vCJHI1FaLpvpL5JGJrz1UZDKYvDg== dependencies: undici-types "~5.26.4" @@ -1029,11 +1029,6 @@ argparse@^1.0.7: dependencies: sprintf-js "~1.0.2" -async@^3.2.3: - version "3.2.6" - resolved "https://registry.yarnpkg.com/async/-/async-3.2.6.tgz#1b0728e14929d51b85b449b7f06e27c1145e38ce" - integrity sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA== - asynckit@^0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79" @@ -1074,9 +1069,9 @@ babel-plugin-jest-hoist@^29.6.3: "@types/babel__traverse" "^7.0.6" babel-preset-current-node-syntax@^1.0.0: - version "1.1.1" - resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.1.1.tgz#204c610030f7e74d4cb1ad7d0ff3c044abf48688" - integrity sha512-23fWKohMTvS5s0wwJKycOe0dBdCwQ6+iiLaNR9zy8P13mtFRFM9qLLX6HJX5DL2pi/FNDf3fCQHM4FIMoHH/7w== + version "1.2.0" + resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.2.0.tgz#20730d6cdc7dda5d89401cab10ac6a32067acde6" + integrity sha512-E/VlAEzRrsLEb2+dv8yp3bo4scof3l9nR4lrld+Iy5NyVqgVYUJnDAmunkhPMisRI32Qc4iRiz425d8vM++2fg== dependencies: "@babel/plugin-syntax-async-generators" "^7.8.4" "@babel/plugin-syntax-bigint" "^7.8.3" @@ -1120,13 +1115,6 @@ brace-expansion@^1.1.7: balanced-match "^1.0.0" concat-map "0.0.1" -brace-expansion@^2.0.1: - version "2.0.2" - resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.2.tgz#54fc53237a613d854c7bd37463aad17df87214e7" - integrity sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ== - dependencies: - balanced-match "^1.0.0" - braces@^3.0.3: version "3.0.3" resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.3.tgz#490332f40919452272d55a8480adc0c441358789" @@ -1135,12 +1123,12 @@ braces@^3.0.3: fill-range "^7.1.1" browserslist@^4.24.0: - version "4.25.1" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.25.1.tgz#ba9e8e6f298a1d86f829c9b975e07948967bb111" - integrity sha512-KGj0KoOMXLpSNkkEI6Z6mShmQy0bc1I+T7K9N81k4WWMrfz+6fQ6es80B/YLAeRoKvjYE1YSHHOW1qe9xIVzHw== + version "4.25.3" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.25.3.tgz#9167c9cbb40473f15f75f85189290678b99b16c5" + integrity sha512-cDGv1kkDI4/0e5yON9yM5G/0A5u8sf5TnmdX5C9qHzI9PPu++sQ9zjm1k9NiOrf3riY4OkK0zSGqfvJyJsgCBQ== dependencies: - caniuse-lite "^1.0.30001726" - electron-to-chromium "^1.5.173" + caniuse-lite "^1.0.30001735" + electron-to-chromium "^1.5.204" node-releases "^2.0.19" update-browserslist-db "^1.1.3" @@ -1194,12 +1182,12 @@ camelcase@^6.2.0: resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-6.3.0.tgz#5685b95eb209ac9c0c177467778c9c84df58ba9a" integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== -caniuse-lite@^1.0.30001726: - version "1.0.30001727" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001727.tgz#22e9706422ad37aa50556af8c10e40e2d93a8b85" - integrity sha512-pB68nIHmbN6L/4C6MH1DokyR3bYqFwjaSs/sWDHGj4CTcFtQUQMuJftVwWkXq7mNWOybD3KhUv3oWHoGxgP14Q== +caniuse-lite@^1.0.30001735: + version "1.0.30001737" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001737.tgz#8292bb7591932ff09e9a765f12fdf5629a241ccc" + integrity sha512-BiloLiXtQNrY5UyF0+1nSJLXUENuhka2pzy2Fx5pGxqavdrxSCW4U6Pn/PoG3Efspi2frRbHpBV2XsrPE6EDlw== -chalk@^4.0.0, chalk@^4.0.2, chalk@^4.1.0: +chalk@^4.0.0, chalk@^4.1.0: version "4.1.2" resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01" integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== @@ -1391,17 +1379,10 @@ dunder-proto@^1.0.1: es-errors "^1.3.0" gopd "^1.2.0" -ejs@^3.1.10: - version "3.1.10" - resolved "https://registry.yarnpkg.com/ejs/-/ejs-3.1.10.tgz#69ab8358b14e896f80cc39e62087b88500c3ac3b" - integrity sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA== - dependencies: - jake "^10.8.5" - -electron-to-chromium@^1.5.173: - version "1.5.191" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.191.tgz#8ae49a471447b1ceaf1d4d183a9000082f52363c" - integrity sha512-xcwe9ELcuxYLUFqZZxL19Z6HVKcvNkIwhbHUz7L3us6u12yR+7uY89dSl570f/IqNthx8dAw3tojG7i4Ni4tDA== +electron-to-chromium@^1.5.204: + version "1.5.211" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.211.tgz#749317bf9cf894c06f67980940cf8074e5eb08ca" + integrity sha512-IGBvimJkotaLzFnwIVgW9/UD/AOJ2tByUmeOrtqBfACSbAw5b1G0XpvdaieKyc7ULmbwXVx+4e4Be8pOPBrYkw== emittery@^0.13.1: version "0.13.1" @@ -1413,10 +1394,10 @@ emoji-regex@^8.0.0: resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== -enhanced-resolve@^5.0.0, enhanced-resolve@^5.17.2: - version "5.18.2" - resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.2.tgz#7903c5b32ffd4b2143eeb4b92472bd68effd5464" - integrity sha512-6Jw4sE1maoRJo3q8MsSIn2onJFbLTOjY9hlx4DZXmOKvLRd1Ok2kXmAGXaafL2+ijsJZ1ClYbl/pmqr9+k4iUQ== +enhanced-resolve@^5.0.0, enhanced-resolve@^5.17.3: + version "5.18.3" + resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.3.tgz#9b5f4c5c076b8787c78fe540392ce76a88855b44" + integrity sha512-d4lC8xfavMeBjzGr2vECC3fsGXziXZQyJxD868h2M/mBI3PwAuODxAkLkq5HYuvrPYcUtiLzsTo8U3PgX3Ocww== dependencies: graceful-fs "^4.2.4" tapable "^2.2.0" @@ -1573,9 +1554,9 @@ fast-json-stable-stringify@2.x, fast-json-stable-stringify@^2.1.0: integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== fast-uri@^3.0.1: - version "3.0.6" - resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.0.6.tgz#88f130b77cfaea2378d56bf970dea21257a68748" - integrity sha512-Atfo14OibSv5wAp4VWNsFYE1AchQRTv9cBGWET4pZWHzYshFSS9NQI6I57rdKn9croWVMbYFbLhJ+yJvmZIIHw== + version "3.1.0" + resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.1.0.tgz#66eecff6c764c0df9b762e62ca7edcfb53b4edfa" + integrity sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA== fb-watchman@^2.0.0: version "2.0.2" @@ -1584,13 +1565,6 @@ fb-watchman@^2.0.0: dependencies: bser "2.1.1" -filelist@^1.0.4: - version "1.0.4" - resolved "https://registry.yarnpkg.com/filelist/-/filelist-1.0.4.tgz#f78978a1e944775ff9e62e744424f215e58352b5" - integrity sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q== - dependencies: - minimatch "^5.0.1" - fill-range@^7.1.1: version "7.1.1" resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.1.1.tgz#44265d3cac07e3ea7dc247516380643754a05292" @@ -1713,6 +1687,18 @@ graphql@^16.8.1: resolved "https://registry.yarnpkg.com/graphql/-/graphql-16.11.0.tgz#96d17f66370678027fdf59b2d4c20b4efaa8a633" integrity sha512-mS1lbMsxgQj6hge1XZ6p7GPhbrtFwUFYi3wRzXAC/FmYnyXMTvvI3td3rjmQ2u8ewXueaSvRPWaEcgVVOT9Jnw== +handlebars@^4.7.8: + version "4.7.8" + resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.8.tgz#41c42c18b1be2365439188c77c6afae71c0cd9e9" + integrity sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ== + dependencies: + minimist "^1.2.5" + neo-async "^2.6.2" + source-map "^0.6.1" + wordwrap "^1.0.0" + optionalDependencies: + uglify-js "^3.1.4" + has-flag@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" @@ -1907,23 +1893,13 @@ istanbul-lib-source-maps@^4.0.0: source-map "^0.6.1" istanbul-reports@^3.1.3: - version "3.1.7" - resolved "https://registry.yarnpkg.com/istanbul-reports/-/istanbul-reports-3.1.7.tgz#daed12b9e1dca518e15c056e1e537e741280fa0b" - integrity sha512-BewmUXImeuRk2YY0PVbxgKAysvhRPUQE0h5QRM++nVWyubKGV0l8qQ5op8+B2DOmwSe63Jivj0BjkPQVf8fP5g== + version "3.2.0" + resolved "https://registry.yarnpkg.com/istanbul-reports/-/istanbul-reports-3.2.0.tgz#cb4535162b5784aa623cee21a7252cf2c807ac93" + integrity sha512-HGYWWS/ehqTV3xN10i23tkPkpH46MLCIMFNCaaKNavAXTF1RkqxawEPtnjnGZ6XKSInBKkiOA5BKS+aZiY3AvA== dependencies: html-escaper "^2.0.0" istanbul-lib-report "^3.0.0" -jake@^10.8.5: - version "10.9.2" - resolved "https://registry.yarnpkg.com/jake/-/jake-10.9.2.tgz#6ae487e6a69afec3a5e167628996b59f35ae2b7f" - integrity sha512-2P4SQ0HrLQ+fw6llpLnOaGAvN2Zu6778SJMrCUwns4fOoG9ayrTiZk3VV8sCPkVZF8ab0zksVpS8FDY5pRCNBA== - dependencies: - async "^3.2.3" - chalk "^4.0.2" - filelist "^1.0.4" - minimatch "^3.1.2" - jest-changed-files@^29.7.0: version "29.7.0" resolved "https://registry.yarnpkg.com/jest-changed-files/-/jest-changed-files-29.7.0.tgz#1c06d07e77c78e1585d020424dedc10d6e17ac3a" @@ -2463,19 +2439,17 @@ mimic-fn@^2.1.0: resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== -minimatch@^3.0.4, minimatch@^3.1.1, minimatch@^3.1.2: +minimatch@^3.0.4, minimatch@^3.1.1: version "3.1.2" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b" integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw== dependencies: brace-expansion "^1.1.7" -minimatch@^5.0.1: - version "5.1.6" - resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-5.1.6.tgz#1cfcb8cf5522ea69952cd2af95ae09477f122a96" - integrity sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g== - dependencies: - brace-expansion "^2.0.1" +minimist@^1.2.5: + version "1.2.8" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" + integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== ms@^2.1.3: version "2.1.3" @@ -2483,9 +2457,9 @@ ms@^2.1.3: integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== msw@^2.8.4: - version "2.10.4" - resolved "https://registry.yarnpkg.com/msw/-/msw-2.10.4.tgz#a39dad96468aecfd752e5b7df4bbc86f1d73dec4" - integrity sha512-6R1or/qyele7q3RyPwNuvc0IxO8L8/Aim6Sz5ncXEgcWUNxSKE+udriTOWHtpMwmfkLYlacA2y7TIx4cL5lgHA== + version "2.10.5" + resolved "https://registry.yarnpkg.com/msw/-/msw-2.10.5.tgz#3e43f12e97581c260bf38d8817732b9fec3bfdb0" + integrity sha512-0EsQCrCI1HbhpBWd89DvmxY6plmvrM96b0sCIztnvcNHQbXn5vqwm1KlXslo6u4wN9LFGLC1WFjjgljcQhe40A== dependencies: "@bundled-es-modules/cookie" "^2.0.1" "@bundled-es-modules/statuses" "^1.0.1" @@ -2972,9 +2946,9 @@ symbol-tree@^3.2.4: integrity sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw== tapable@^2.1.1, tapable@^2.2.0: - version "2.2.2" - resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.2.tgz#ab4984340d30cb9989a490032f086dbb8b56d872" - integrity sha512-Re10+NauLTMCudc7T5WLFLAwDhQ0JWdrMK+9B2M8zR5hRExKmsRDCBA7/aV/pNJFltmBFO5BAMlQFi/vq3nKOg== + version "2.2.3" + resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.3.tgz#4b67b635b2d97578a06a2713d2f04800c237e99b" + integrity sha512-ZL6DDuAlRlLGghwcfmSn9sK3Hr6ArtyudlSAiCqQ6IfE+b+HHbydbYDIG15IfS5do+7XQQBdBiubF/cV2dnDzg== terser-webpack-plugin@^5.3.11: version "5.3.14" @@ -3041,13 +3015,13 @@ tr46@~0.0.3: integrity sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw== ts-jest@^29.3.4: - version "29.4.0" - resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-29.4.0.tgz#bef0ee98d94c83670af7462a1617bf2367a83740" - integrity sha512-d423TJMnJGu80/eSgfQ5w/R+0zFJvdtTxwtF9KzFFunOpSeD+79lHJQIiAhluJoyGRbvj9NZJsl9WjCUo0ND7Q== + version "29.4.1" + resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-29.4.1.tgz#42d33beb74657751d315efb9a871fe99e3b9b519" + integrity sha512-SaeUtjfpg9Uqu8IbeDKtdaS0g8lS6FT6OzM3ezrDfErPJPHNDo/Ey+VFGP1bQIDfagYDLyRpd7O15XpG1Es2Uw== dependencies: bs-logger "^0.2.6" - ejs "^3.1.10" fast-json-stable-stringify "^2.1.0" + handlebars "^4.7.8" json5 "^2.2.3" lodash.memoize "^4.1.2" make-error "^1.3.6" @@ -3056,9 +3030,9 @@ ts-jest@^29.3.4: yargs-parser "^21.1.1" ts-loader@^9.5.1: - version "9.5.2" - resolved "https://registry.yarnpkg.com/ts-loader/-/ts-loader-9.5.2.tgz#1f3d7f4bb709b487aaa260e8f19b301635d08020" - integrity sha512-Qo4piXvOTWcMGIgRiuFa6nHNm+54HbYaZCKqc9eeZCLRy3XqafQgwX2F7mofrbJG3g7EEb+lkiR+z2Lic2s3Zw== + version "9.5.4" + resolved "https://registry.yarnpkg.com/ts-loader/-/ts-loader-9.5.4.tgz#44b571165c10fb5a90744aa5b7e119233c4f4585" + integrity sha512-nCz0rEwunlTZiy6rXFByQU1kVVpCIgUpc/psFiKVrUwrizdnIbRFu8w7bxhUF0X613DYwT4XzrZHpVyMe758hQ== dependencies: chalk "^4.1.0" enhanced-resolve "^5.0.0" @@ -3086,15 +3060,20 @@ typescript@~5.7.2: resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.7.3.tgz#919b44a7dbb8583a9b856d162be24a54bf80073e" integrity sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw== +uglify-js@^3.1.4: + version "3.19.3" + resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.19.3.tgz#82315e9bbc6f2b25888858acd1fff8441035b77f" + integrity sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ== + undici-types@~5.26.4: version "5.26.5" resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-5.26.5.tgz#bcd539893d00b56e964fd2657a4866b221a65617" integrity sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA== -undici-types@~7.8.0: - version "7.8.0" - resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-7.8.0.tgz#de00b85b710c54122e44fbfd911f8d70174cd294" - integrity sha512-9UJ2xGDvQ43tYyVMpuHlsgApydB8ZKfVYTsLDhXkFL/6gfkp+U8xTGdh8pMJv1SpZna0zxG1DwsKZsreLbXBxw== +undici-types@~7.10.0: + version "7.10.0" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-7.10.0.tgz#4ac2e058ce56b462b056e629cc6a02393d3ff350" + integrity sha512-t5Fy/nfn+14LuOc2KNYg75vZqClpAiqscVvMygNnlsHBFpSXdJaYtXMcdNLpl/Qvc3P2cB3s6lOV51nqsFq4ag== universalify@^0.2.0: version "0.2.0" @@ -3164,9 +3143,9 @@ webpack-sources@^3.3.3: integrity sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg== webpack@^5.97.1: - version "5.101.0" - resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.101.0.tgz#4b81407ffad9857f81ff03f872e3369b9198cc9d" - integrity sha512-B4t+nJqytPeuZlHuIKTbalhljIFXeNRqrUGAQgTGlfOl2lXXKXw+yZu6bicycP+PUlM44CxBjCFD6aciKFT3LQ== + version "5.101.3" + resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.101.3.tgz#3633b2375bb29ea4b06ffb1902734d977bc44346" + integrity sha512-7b0dTKR3Ed//AD/6kkx/o7duS8H3f1a4w3BYpIriX4BzIhjkn4teo05cptsxvLesHFKK5KObnadmCHBwGc+51A== dependencies: "@types/eslint-scope" "^3.7.7" "@types/estree" "^1.0.8" @@ -3178,7 +3157,7 @@ webpack@^5.97.1: acorn-import-phases "^1.0.3" browserslist "^4.24.0" chrome-trace-event "^1.0.2" - enhanced-resolve "^5.17.2" + enhanced-resolve "^5.17.3" es-module-lexer "^1.2.1" eslint-scope "5.1.1" events "^3.2.0" @@ -3229,6 +3208,11 @@ which@^2.0.1: dependencies: isexe "^2.0.0" +wordwrap@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb" + integrity sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q== + wrap-ansi@^6.2.0: version "6.2.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53" @@ -3309,6 +3293,6 @@ yocto-queue@^0.1.0: integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q== yoctocolors-cjs@^2.1.2: - version "2.1.2" - resolved "https://registry.yarnpkg.com/yoctocolors-cjs/-/yoctocolors-cjs-2.1.2.tgz#f4b905a840a37506813a7acaa28febe97767a242" - integrity sha512-cYVsTjKl8b+FrnidjibDWskAv7UKOfcwaVZdp/it9n1s9fU3IkgDbhdIRKCW4JDsAlECJY0ytoVPT3sK6kideA== + version "2.1.3" + resolved "https://registry.yarnpkg.com/yoctocolors-cjs/-/yoctocolors-cjs-2.1.3.tgz#7e4964ea8ec422b7a40ac917d3a344cfd2304baa" + integrity sha512-U/PBtDf35ff0D8X8D0jfdzHYEPFxAI7jJlxZXwCSez5M3190m+QobIfh+sWDWSHMCWWJN2AWamkegn6vr6YBTw==