diff --git a/reference.md b/reference.md index 87e66a19..a8e4919b 100644 --- a/reference.md +++ b/reference.md @@ -4845,9 +4845,9 @@ await client.ats.webhookReceivers.create({ -## Filestorage AccountDetails +## Crm AccountDetails -
client.filestorage.accountDetails.retrieve() -> Merge.AccountDetails +
client.crm.accountDetails.retrieve() -> Merge.AccountDetails
@@ -4875,7 +4875,7 @@ Get details for a linked account.
```typescript -await client.filestorage.accountDetails.retrieve(); +await client.crm.accountDetails.retrieve(); ```
@@ -4902,9 +4902,9 @@ await client.filestorage.accountDetails.retrieve();
-## Filestorage AccountToken +## Crm AccountToken -
client.filestorage.accountToken.retrieve(publicToken) -> Merge.AccountToken +
client.crm.accountToken.retrieve(publicToken) -> Merge.AccountToken
@@ -4932,7 +4932,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.accountToken.retrieve("public_token"); ```
@@ -4967,9 +4967,9 @@ await client.filestorage.accountToken.retrieve("public_token");
-## Filestorage AsyncPassthrough +## Crm Accounts -
client.filestorage.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept +
client.crm.accounts.list({ ...params }) -> Merge.PaginatedAccountList
@@ -4981,7 +4981,7 @@ await client.filestorage.accountToken.retrieve("public_token");
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a list of `Account` objects.
@@ -4997,9 +4997,8 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```typescript -await client.filestorage.asyncPassthrough.create({ - method: "GET", - path: "/scooters", +await client.crm.accounts.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -5016,7 +5015,7 @@ await client.filestorage.asyncPassthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**request:** `Merge.crm.AccountsListRequest`
@@ -5024,7 +5023,7 @@ await client.filestorage.asyncPassthrough.create({
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -5035,7 +5034,7 @@ await client.filestorage.asyncPassthrough.create({
-
client.filestorage.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse +
client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse
@@ -5047,7 +5046,7 @@ await client.filestorage.asyncPassthrough.create({
-Retrieves data from earlier async-passthrough POST request +Creates an `Account` object with the given values.
@@ -5063,7 +5062,9 @@ Retrieves data from earlier async-passthrough POST request
```typescript -await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id"); +await client.crm.accounts.create({ + model: {}, +}); ```
@@ -5079,7 +5080,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-**asyncPassthroughReceiptId:** `string` +**request:** `Merge.crm.CrmAccountEndpointRequest`
@@ -5087,7 +5088,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -5098,9 +5099,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-## Filestorage AuditTrail - -
client.filestorage.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList +
client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account
@@ -5112,7 +5111,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-Gets a list of audit trail events. +Returns an `Account` object with the given `id`.
@@ -5128,9 +5127,7 @@ Gets a list of audit trail events.
```typescript -await client.filestorage.auditTrail.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.accounts.retrieve("id"); ```
@@ -5146,7 +5143,7 @@ await client.filestorage.auditTrail.list({
-**request:** `Merge.filestorage.AuditTrailListRequest` +**id:** `string`
@@ -5154,7 +5151,15 @@ await client.filestorage.auditTrail.list({
-**requestOptions:** `AuditTrail.RequestOptions` +**request:** `Merge.crm.AccountsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -5165,9 +5170,7 @@ await client.filestorage.auditTrail.list({
-## Filestorage AvailableActions - -
client.filestorage.availableActions.retrieve() -> Merge.AvailableActions +
client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse
@@ -5179,7 +5182,7 @@ await client.filestorage.auditTrail.list({
-Returns a list of models and actions available for an account. +Updates an `Account` object with the given `id`.
@@ -5195,7 +5198,9 @@ Returns a list of models and actions available for an account.
```typescript -await client.filestorage.availableActions.retrieve(); +await client.crm.accounts.partialUpdate("id", { + model: {}, +}); ```
@@ -5211,7 +5216,23 @@ await client.filestorage.availableActions.retrieve();
-**requestOptions:** `AvailableActions.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.PatchedCrmAccountEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -5222,9 +5243,7 @@ await client.filestorage.availableActions.retrieve();
-## Filestorage Scopes - -
client.filestorage.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi +
client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -5236,7 +5255,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 `CRMAccount` PATCHs.
@@ -5252,7 +5271,7 @@ Get the default permissions for Merge Common Models and fields across all Linked
```typescript -await client.filestorage.scopes.defaultScopesRetrieve(); +await client.crm.accounts.metaPatchRetrieve("id"); ```
@@ -5268,7 +5287,15 @@ await client.filestorage.scopes.defaultScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**requestOptions:** `Accounts.RequestOptions`
@@ -5279,7 +5306,7 @@ await client.filestorage.scopes.defaultScopesRetrieve();
-
client.filestorage.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi +
client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse
@@ -5291,7 +5318,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 metadata for `CRMAccount` POSTs.
@@ -5307,7 +5334,7 @@ Get all available permissions for Merge Common Models and fields for a single Li
```typescript -await client.filestorage.scopes.linkedAccountScopesRetrieve(); +await client.crm.accounts.metaPostRetrieve(); ```
@@ -5323,7 +5350,7 @@ await client.filestorage.scopes.linkedAccountScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -5334,7 +5361,7 @@ await client.filestorage.scopes.linkedAccountScopesRetrieve();
-
client.filestorage.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi +
client.crm.accounts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -5346,7 +5373,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 `RemoteFieldClass` objects.
@@ -5362,32 +5389,8 @@ Update permissions for any Common Model or field for a single Linked Account. An
```typescript -await client.filestorage.scopes.linkedAccountScopesCreate({ - commonModels: [ - { - modelName: "Employee", - modelPermissions: { - READ: { - isEnabled: true, - }, - WRITE: { - isEnabled: false, - }, - }, - fieldPermissions: { - enabledFields: ["avatar", "home_location"], - disabledFields: ["work_location"], - }, - }, - { - modelName: "Benefit", - modelPermissions: { - WRITE: { - isEnabled: false, - }, - }, - }, - ], +await client.crm.accounts.remoteFieldClassesList({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -5404,7 +5407,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-**request:** `Merge.filestorage.LinkedAccountCommonModelScopeDeserializerRequest` +**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest`
@@ -5412,7 +5415,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-**requestOptions:** `Scopes.RequestOptions` +**requestOptions:** `Accounts.RequestOptions`
@@ -5423,9 +5426,9 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-## Filestorage DeleteAccount +## Crm AsyncPassthrough -
client.filestorage.deleteAccount.delete() -> void +
client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
@@ -5437,7 +5440,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-Delete a linked account. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -5453,7 +5456,10 @@ Delete a linked account.
```typescript -await client.filestorage.deleteAccount.delete(); +await client.crm.asyncPassthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -5469,7 +5475,15 @@ await client.filestorage.deleteAccount.delete();
-**requestOptions:** `DeleteAccount.RequestOptions` +**request:** `Merge.DataPassthroughRequest` + +
+
+ +
+
+ +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -5480,9 +5494,7 @@ await client.filestorage.deleteAccount.delete();
-## Filestorage Drives - -
client.filestorage.drives.list({ ...params }) -> Merge.PaginatedDriveList +
client.crm.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
@@ -5494,7 +5506,7 @@ await client.filestorage.deleteAccount.delete();
-Returns a list of `Drive` objects. +Retrieves data from earlier async-passthrough POST request
@@ -5510,9 +5522,7 @@ Returns a list of `Drive` objects.
```typescript -await client.filestorage.drives.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
@@ -5528,7 +5538,7 @@ await client.filestorage.drives.list({
-**request:** `Merge.filestorage.DrivesListRequest` +**asyncPassthroughReceiptId:** `string`
@@ -5536,7 +5546,7 @@ await client.filestorage.drives.list({
-**requestOptions:** `Drives.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -5547,7 +5557,9 @@ await client.filestorage.drives.list({
-
client.filestorage.drives.retrieve(id, { ...params }) -> Merge.Drive +## Crm AuditTrail + +
client.crm.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
@@ -5559,7 +5571,7 @@ await client.filestorage.drives.list({
-Returns a `Drive` object with the given `id`. +Gets a list of audit trail events.
@@ -5575,7 +5587,9 @@ Returns a `Drive` object with the given `id`.
```typescript -await client.filestorage.drives.retrieve("id"); +await client.crm.auditTrail.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -5591,15 +5605,7 @@ await client.filestorage.drives.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.DrivesRetrieveRequest` +**request:** `Merge.crm.AuditTrailListRequest`
@@ -5607,7 +5613,7 @@ await client.filestorage.drives.retrieve("id");
-**requestOptions:** `Drives.RequestOptions` +**requestOptions:** `AuditTrail.RequestOptions`
@@ -5618,9 +5624,9 @@ await client.filestorage.drives.retrieve("id");
-## Filestorage FieldMapping +## Crm AvailableActions -
client.filestorage.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse +
client.crm.availableActions.retrieve() -> Merge.AvailableActions
@@ -5632,7 +5638,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/). +Returns a list of models and actions available for an account.
@@ -5648,7 +5654,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```typescript -await client.filestorage.fieldMapping.fieldMappingsRetrieve(); +await client.crm.availableActions.retrieve(); ```
@@ -5664,15 +5670,7 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve();
-**request:** `Merge.filestorage.FieldMappingsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `AvailableActions.RequestOptions`
@@ -5683,7 +5681,9 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve();
-
client.filestorage.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse +## Crm Contacts + +
client.crm.contacts.list({ ...params }) -> Merge.PaginatedContactList
@@ -5695,7 +5695,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. +Returns a list of `Contact` objects.
@@ -5711,13 +5711,8 @@ 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.contacts.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -5734,7 +5729,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-**request:** `Merge.filestorage.CreateFieldMappingRequest` +**request:** `Merge.crm.ContactsListRequest`
@@ -5742,7 +5737,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -5753,7 +5748,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-
client.filestorage.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse +
client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse
@@ -5765,7 +5760,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. +Creates a `Contact` object with the given values.
@@ -5781,7 +5776,9 @@ 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.contacts.create({ + model: {}, +}); ```
@@ -5797,7 +5794,7 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**fieldMappingId:** `string` +**request:** `Merge.crm.CrmContactEndpointRequest`
@@ -5805,7 +5802,7 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -5816,7 +5813,7 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
client.filestorage.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse +
client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact
@@ -5828,7 +5825,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 `Contact` object with the given `id`.
@@ -5844,7 +5841,7 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```typescript -await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); +await client.crm.contacts.retrieve("id"); ```
@@ -5860,7 +5857,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-**fieldMappingId:** `string` +**id:** `string`
@@ -5868,7 +5865,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-**request:** `Merge.filestorage.PatchedEditFieldMappingRequest` +**request:** `Merge.crm.ContactsRetrieveRequest`
@@ -5876,7 +5873,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -5887,7 +5884,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-
client.filestorage.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse +
client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse
@@ -5899,7 +5896,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/). +Updates a `Contact` object with the given `id`.
@@ -5915,7 +5912,9 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```typescript -await client.filestorage.fieldMapping.remoteFieldsRetrieve(); +await client.crm.contacts.partialUpdate("id", { + model: {}, +}); ```
@@ -5931,7 +5930,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve();
-**request:** `Merge.filestorage.RemoteFieldsRetrieveRequest` +**id:** `string`
@@ -5939,7 +5938,15 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.crm.PatchedCrmContactEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Contacts.RequestOptions`
@@ -5950,7 +5957,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve();
-
client.filestorage.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse +
client.crm.contacts.ignoreCreate(modelId, { ...params }) -> void
@@ -5962,7 +5969,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/). +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.
@@ -5978,7 +5985,9 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```typescript -await client.filestorage.fieldMapping.targetFieldsRetrieve(); +await client.crm.contacts.ignoreCreate("model_id", { + reason: "GENERAL_CUSTOMER_REQUEST", +}); ```
@@ -5994,7 +6003,23 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**modelId:** `string` + +
+
+ +
+
+ +**request:** `Merge.IgnoreCommonModelRequest` + +
+
+ +
+
+ +**requestOptions:** `Contacts.RequestOptions`
@@ -6005,9 +6030,7 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-## Filestorage Files - -
client.filestorage.files.list({ ...params }) -> Merge.PaginatedFileList +
client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -6019,7 +6042,7 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-Returns a list of `File` objects. +Returns metadata for `CRMContact` PATCHs.
@@ -6035,9 +6058,7 @@ Returns a list of `File` objects.
```typescript -await client.filestorage.files.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.contacts.metaPatchRetrieve("id"); ```
@@ -6053,7 +6074,7 @@ await client.filestorage.files.list({
-**request:** `Merge.filestorage.FilesListRequest` +**id:** `string`
@@ -6061,7 +6082,7 @@ await client.filestorage.files.list({
-**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -6072,7 +6093,7 @@ await client.filestorage.files.list({
-
client.filestorage.files.create({ ...params }) -> Merge.FileStorageFileResponse +
client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse
@@ -6084,7 +6105,7 @@ await client.filestorage.files.list({
-Creates a `File` object with the given values. +Returns metadata for `CRMContact` POSTs.
@@ -6100,9 +6121,7 @@ Creates a `File` object with the given values.
```typescript -await client.filestorage.files.create({ - model: {}, -}); +await client.crm.contacts.metaPostRetrieve(); ```
@@ -6118,15 +6137,7 @@ await client.filestorage.files.create({
-**request:** `Merge.filestorage.FileStorageFileEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -6137,7 +6148,7 @@ await client.filestorage.files.create({
-
client.filestorage.files.retrieve(id, { ...params }) -> Merge.File_ +
client.crm.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -6149,7 +6160,7 @@ await client.filestorage.files.create({
-Returns a `File` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -6165,7 +6176,9 @@ Returns a `File` object with the given `id`.
```typescript -await client.filestorage.files.retrieve("id"); +await client.crm.contacts.remoteFieldClassesList({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -6181,15 +6194,7 @@ await client.filestorage.files.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.FilesRetrieveRequest` +**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest`
@@ -6197,7 +6202,7 @@ await client.filestorage.files.retrieve("id");
-**requestOptions:** `Files.RequestOptions` +**requestOptions:** `Contacts.RequestOptions`
@@ -6208,7 +6213,9 @@ await client.filestorage.files.retrieve("id");
-
client.filestorage.files.downloadRequestMetaRetrieve(id, { ...params }) -> Merge.DownloadRequestMeta +## Crm CustomObjectClasses + +
client.crm.customObjectClasses.list({ ...params }) -> Merge.PaginatedCustomObjectClassList
@@ -6220,7 +6227,7 @@ await client.filestorage.files.retrieve("id");
-Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party. +Returns a list of `CustomObjectClass` objects.
@@ -6236,7 +6243,9 @@ Returns metadata to construct an authenticated file download request for a singu
```typescript -await client.filestorage.files.downloadRequestMetaRetrieve("id"); +await client.crm.customObjectClasses.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -6252,15 +6261,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.FilesDownloadRequestMetaRetrieveRequest` +**request:** `Merge.crm.CustomObjectClassesListRequest`
@@ -6268,7 +6269,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id");
-**requestOptions:** `Files.RequestOptions` +**requestOptions:** `CustomObjectClasses.RequestOptions`
@@ -6279,7 +6280,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id");
-
client.filestorage.files.downloadRequestMetaList({ ...params }) -> Merge.PaginatedDownloadRequestMetaList +
client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass
@@ -6291,7 +6292,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id");
-Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party. +Returns a `CustomObjectClass` object with the given `id`.
@@ -6307,9 +6308,7 @@ Returns metadata to construct authenticated file download requests, allowing you
```typescript -await client.filestorage.files.downloadRequestMetaList({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.customObjectClasses.retrieve("id"); ```
@@ -6325,7 +6324,7 @@ await client.filestorage.files.downloadRequestMetaList({
-**request:** `Merge.filestorage.FilesDownloadRequestMetaListRequest` +**id:** `string`
@@ -6333,7 +6332,15 @@ await client.filestorage.files.downloadRequestMetaList({
-**requestOptions:** `Files.RequestOptions` +**request:** `Merge.crm.CustomObjectClassesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjectClasses.RequestOptions`
@@ -6344,7 +6351,9 @@ await client.filestorage.files.downloadRequestMetaList({
-
client.filestorage.files.metaPostRetrieve() -> Merge.MetaResponse +## Crm AssociationTypes + +
client.crm.associationTypes.customObjectClassesAssociationTypesList(customObjectClassId, { ...params }) -> Merge.PaginatedAssociationTypeList
@@ -6356,7 +6365,7 @@ await client.filestorage.files.downloadRequestMetaList({
-Returns metadata for `FileStorageFile` POSTs. +Returns a list of `AssociationType` objects.
@@ -6372,7 +6381,9 @@ Returns metadata for `FileStorageFile` POSTs.
```typescript -await client.filestorage.files.metaPostRetrieve(); +await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id", { + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -6388,7 +6399,23 @@ await client.filestorage.files.metaPostRetrieve();
-**requestOptions:** `Files.RequestOptions` +**customObjectClassId:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest` + +
+
+ +
+
+ +**requestOptions:** `AssociationTypes.RequestOptions`
@@ -6399,9 +6426,7 @@ await client.filestorage.files.metaPostRetrieve();
-## Filestorage Folders - -
client.filestorage.folders.list({ ...params }) -> Merge.PaginatedFolderList +
client.crm.associationTypes.customObjectClassesAssociationTypesCreate(customObjectClassId, { ...params }) -> Merge.CrmAssociationTypeResponse
@@ -6413,7 +6438,7 @@ await client.filestorage.files.metaPostRetrieve();
-Returns a list of `Folder` objects. +Creates an `AssociationType` object with the given values.
@@ -6429,8 +6454,20 @@ Returns a list of `Folder` objects.
```typescript -await client.filestorage.folders.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +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", + }, }); ``` @@ -6447,7 +6484,7 @@ await client.filestorage.folders.list({
-**request:** `Merge.filestorage.FoldersListRequest` +**customObjectClassId:** `string`
@@ -6455,7 +6492,15 @@ await client.filestorage.folders.list({
-**requestOptions:** `Folders.RequestOptions` +**request:** `Merge.crm.CrmAssociationTypeEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `AssociationTypes.RequestOptions`
@@ -6466,7 +6511,7 @@ await client.filestorage.folders.list({
-
client.filestorage.folders.create({ ...params }) -> Merge.FileStorageFolderResponse +
client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(customObjectClassId, id, { ...params }) -> Merge.AssociationType
@@ -6478,7 +6523,7 @@ await client.filestorage.folders.list({
-Creates a `Folder` object with the given values. +Returns an `AssociationType` object with the given `id`.
@@ -6494,9 +6539,7 @@ Creates a `Folder` object with the given values.
```typescript -await client.filestorage.folders.create({ - model: {}, -}); +await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id"); ```
@@ -6512,7 +6555,7 @@ await client.filestorage.folders.create({
-**request:** `Merge.filestorage.FileStorageFolderEndpointRequest` +**customObjectClassId:** `string`
@@ -6520,7 +6563,23 @@ await client.filestorage.folders.create({
-**requestOptions:** `Folders.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `AssociationTypes.RequestOptions`
@@ -6531,7 +6590,7 @@ await client.filestorage.folders.create({
-
client.filestorage.folders.retrieve(id, { ...params }) -> Merge.Folder +
client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
@@ -6543,7 +6602,7 @@ await client.filestorage.folders.create({
-Returns a `Folder` object with the given `id`. +Returns metadata for `CRMAssociationType` POSTs.
@@ -6559,7 +6618,7 @@ Returns a `Folder` object with the given `id`.
```typescript -await client.filestorage.folders.retrieve("id"); +await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id"); ```
@@ -6575,7 +6634,7 @@ await client.filestorage.folders.retrieve("id");
-**id:** `string` +**customObjectClassId:** `string`
@@ -6583,18 +6642,10 @@ await client.filestorage.folders.retrieve("id");
-**request:** `Merge.filestorage.FoldersRetrieveRequest` +**requestOptions:** `AssociationTypes.RequestOptions` -
-
- -
-
- -**requestOptions:** `Folders.RequestOptions` - -
-
+ +
@@ -6602,7 +6653,9 @@ await client.filestorage.folders.retrieve("id");
-
client.filestorage.folders.metaPostRetrieve() -> Merge.MetaResponse +## Crm CustomObjects + +
client.crm.customObjects.customObjectClassesCustomObjectsList(customObjectClassId, { ...params }) -> Merge.PaginatedCustomObjectList
@@ -6614,7 +6667,7 @@ await client.filestorage.folders.retrieve("id");
-Returns metadata for `FileStorageFolder` POSTs. +Returns a list of `CustomObject` objects.
@@ -6630,7 +6683,9 @@ Returns metadata for `FileStorageFolder` POSTs.
```typescript -await client.filestorage.folders.metaPostRetrieve(); +await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id", { + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -6646,7 +6701,23 @@ await client.filestorage.folders.metaPostRetrieve();
-**requestOptions:** `Folders.RequestOptions` +**customObjectClassId:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjects.RequestOptions`
@@ -6657,9 +6728,7 @@ await client.filestorage.folders.metaPostRetrieve();
-## Filestorage GenerateKey - -
client.filestorage.generateKey.create({ ...params }) -> Merge.RemoteKey +
client.crm.customObjects.customObjectClassesCustomObjectsCreate(customObjectClassId, { ...params }) -> Merge.CrmCustomObjectResponse
@@ -6671,7 +6740,7 @@ await client.filestorage.folders.metaPostRetrieve();
-Create a remote key. +Creates a `CustomObject` object with the given values.
@@ -6687,8 +6756,12 @@ Create a remote key.
```typescript -await client.filestorage.generateKey.create({ - name: "Remote Deployment Key 1", +await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", { + model: { + fields: { + test_field: "hello", + }, + }, }); ``` @@ -6705,7 +6778,7 @@ await client.filestorage.generateKey.create({
-**request:** `Merge.filestorage.GenerateRemoteKeyRequest` +**customObjectClassId:** `string`
@@ -6713,7 +6786,15 @@ await client.filestorage.generateKey.create({
-**requestOptions:** `GenerateKey.RequestOptions` +**request:** `Merge.crm.CrmCustomObjectEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjects.RequestOptions`
@@ -6724,9 +6805,7 @@ await client.filestorage.generateKey.create({
-## Filestorage Groups - -
client.filestorage.groups.list({ ...params }) -> Merge.PaginatedGroupList +
client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(customObjectClassId, id, { ...params }) -> Merge.CustomObject
@@ -6738,7 +6817,7 @@ await client.filestorage.generateKey.create({
-Returns a list of `Group` objects. +Returns a `CustomObject` object with the given `id`.
@@ -6754,9 +6833,7 @@ Returns a list of `Group` objects.
```typescript -await client.filestorage.groups.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id"); ```
@@ -6772,7 +6849,7 @@ await client.filestorage.groups.list({
-**request:** `Merge.filestorage.GroupsListRequest` +**customObjectClassId:** `string`
@@ -6780,7 +6857,23 @@ await client.filestorage.groups.list({
-**requestOptions:** `Groups.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `CustomObjects.RequestOptions`
@@ -6791,7 +6884,7 @@ await client.filestorage.groups.list({
-
client.filestorage.groups.retrieve(id, { ...params }) -> Merge.Group +
client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
@@ -6803,7 +6896,7 @@ await client.filestorage.groups.list({
-Returns a `Group` object with the given `id`. +Returns metadata for `CRMCustomObject` POSTs.
@@ -6819,7 +6912,7 @@ Returns a `Group` object with the given `id`.
```typescript -await client.filestorage.groups.retrieve("id"); +await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id"); ```
@@ -6835,15 +6928,7 @@ await client.filestorage.groups.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.GroupsRetrieveRequest` +**customObjectClassId:** `string`
@@ -6851,7 +6936,7 @@ await client.filestorage.groups.retrieve("id");
-**requestOptions:** `Groups.RequestOptions` +**requestOptions:** `CustomObjects.RequestOptions`
@@ -6862,9 +6947,7 @@ await client.filestorage.groups.retrieve("id");
-## Filestorage Issues - -
client.filestorage.issues.list({ ...params }) -> Merge.PaginatedIssueList +
client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -6876,7 +6959,7 @@ await client.filestorage.groups.retrieve("id");
-Gets all issues for Organization. +Returns a list of `RemoteFieldClass` objects.
@@ -6892,7 +6975,7 @@ Gets all issues for Organization.
```typescript -await client.filestorage.issues.list({ +await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -6910,7 +6993,7 @@ await client.filestorage.issues.list({
-**request:** `Merge.filestorage.IssuesListRequest` +**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest`
@@ -6918,7 +7001,7 @@ await client.filestorage.issues.list({
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `CustomObjects.RequestOptions`
@@ -6929,7 +7012,9 @@ await client.filestorage.issues.list({
-
client.filestorage.issues.retrieve(id) -> Merge.Issue +## Crm Associations + +
client.crm.associations.customObjectClassesCustomObjectsAssociationsList(customObjectClassId, objectId, { ...params }) -> Merge.PaginatedAssociationList
@@ -6941,7 +7026,7 @@ await client.filestorage.issues.list({
-Get a specific issue. +Returns a list of `Association` objects.
@@ -6957,7 +7042,9 @@ Get a specific issue.
```typescript -await client.filestorage.issues.retrieve("id"); +await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id", { + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -6973,7 +7060,7 @@ await client.filestorage.issues.retrieve("id");
-**id:** `string` +**customObjectClassId:** `string`
@@ -6981,7 +7068,23 @@ await client.filestorage.issues.retrieve("id");
-**requestOptions:** `Issues.RequestOptions` +**objectId:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Associations.RequestOptions`
@@ -6992,9 +7095,7 @@ await client.filestorage.issues.retrieve("id");
-## Filestorage LinkToken - -
client.filestorage.linkToken.create({ ...params }) -> Merge.LinkToken +
client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(associationTypeId, sourceClassId, sourceObjectId, targetClassId, targetObjectId, { ...params }) -> Merge.Association
@@ -7006,7 +7107,7 @@ await client.filestorage.issues.retrieve("id");
-Creates a link token to be used when linking a new end user. +Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -7022,12 +7123,13 @@ 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.associations.customObjectClassesCustomObjectsAssociationsUpdate( + "association_type_id", + "source_class_id", + "source_object_id", + "target_class_id", + "target_object_id", +); ```
@@ -7043,7 +7145,7 @@ await client.filestorage.linkToken.create({
-**request:** `Merge.filestorage.EndUserDetailsRequest` +**associationTypeId:** `string`
@@ -7051,58 +7153,79 @@ await client.filestorage.linkToken.create({
-**requestOptions:** `LinkToken.RequestOptions` +**sourceClassId:** `string`
+ +
+
+ +**sourceObjectId:** `string` +
+
+
+ +**targetClassId:** `string` +
-
-## Filestorage LinkedAccounts - -
client.filestorage.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
-#### 📝 Description +**targetObjectId:** `string` + +
+
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest` + +
+
+
-List linked accounts for your organization. +**requestOptions:** `Associations.RequestOptions`
-#### 🔌 Usage + + +
+## Crm Scopes + +
client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
+#### 📝 Description +
-```typescript -await client.filestorage.linkedAccounts.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); -``` +
+
+ +Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -7110,15 +7233,24 @@ await client.filestorage.linkedAccounts.list({
-**request:** `Merge.filestorage.LinkedAccountsListRequest` +```typescript +await client.crm.scopes.defaultScopesRetrieve(); +``` +
+
+#### ⚙️ Parameters +
-**requestOptions:** `LinkedAccounts.RequestOptions` +
+
+ +**requestOptions:** `Scopes.RequestOptions`
@@ -7129,9 +7261,7 @@ await client.filestorage.linkedAccounts.list({
-## Filestorage Passthrough - -
client.filestorage.passthrough.create({ ...params }) -> Merge.RemoteResponse +
client.crm.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -7143,7 +7273,7 @@ await client.filestorage.linkedAccounts.list({
-Pull data from an endpoint not currently supported by Merge. +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).
@@ -7159,10 +7289,7 @@ Pull data from an endpoint not currently supported by Merge.
```typescript -await client.filestorage.passthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.crm.scopes.linkedAccountScopesRetrieve(); ```
@@ -7178,15 +7305,7 @@ await client.filestorage.passthrough.create({
-**request:** `Merge.DataPassthroughRequest` - -
-
- -
-
- -**requestOptions:** `Passthrough.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -7197,9 +7316,7 @@ await client.filestorage.passthrough.create({
-## Filestorage RegenerateKey - -
client.filestorage.regenerateKey.create({ ...params }) -> Merge.RemoteKey +
client.crm.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
@@ -7211,7 +7328,7 @@ await client.filestorage.passthrough.create({
-Exchange remote keys. +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)
@@ -7227,8 +7344,32 @@ Exchange remote keys.
```typescript -await client.filestorage.regenerateKey.create({ - name: "Remote Deployment Key 1", +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, + }, + }, + }, + ], }); ``` @@ -7245,7 +7386,7 @@ await client.filestorage.regenerateKey.create({
-**request:** `Merge.filestorage.RemoteKeyForRegenerationRequest` +**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -7253,7 +7394,7 @@ await client.filestorage.regenerateKey.create({
-**requestOptions:** `RegenerateKey.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -7264,9 +7405,9 @@ await client.filestorage.regenerateKey.create({
-## Filestorage SyncStatus +## Crm DeleteAccount -
client.filestorage.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList +
client.crm.deleteAccount.delete() -> void
@@ -7278,7 +7419,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). +Delete a linked account.
@@ -7294,9 +7435,7 @@ Get sync status for the current sync and the most recently finished sync. `last_
```typescript -await client.filestorage.syncStatus.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.deleteAccount.delete(); ```
@@ -7312,15 +7451,7 @@ await client.filestorage.syncStatus.list({
-**request:** `Merge.filestorage.SyncStatusListRequest` - -
-
- -
-
- -**requestOptions:** `SyncStatus.RequestOptions` +**requestOptions:** `DeleteAccount.RequestOptions`
@@ -7331,9 +7462,9 @@ await client.filestorage.syncStatus.list({
-## Filestorage ForceResync +## Crm EngagementTypes -
client.filestorage.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[] +
client.crm.engagementTypes.list({ ...params }) -> Merge.PaginatedEngagementTypeList
@@ -7345,7 +7476,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 `EngagementType` objects.
@@ -7361,7 +7492,9 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```typescript -await client.filestorage.forceResync.syncStatusResyncCreate(); +await client.crm.engagementTypes.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -7377,7 +7510,15 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-**requestOptions:** `ForceResync.RequestOptions` +**request:** `Merge.crm.EngagementTypesListRequest` + +
+
+ +
+
+ +**requestOptions:** `EngagementTypes.RequestOptions`
@@ -7388,9 +7529,7 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-## Filestorage Users - -
client.filestorage.users.list({ ...params }) -> Merge.PaginatedUserList +
client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType
@@ -7402,7 +7541,7 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-Returns a list of `User` objects. +Returns an `EngagementType` object with the given `id`.
@@ -7418,9 +7557,7 @@ Returns a list of `User` objects.
```typescript -await client.filestorage.users.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.engagementTypes.retrieve("id"); ```
@@ -7436,7 +7573,7 @@ await client.filestorage.users.list({
-**request:** `Merge.filestorage.UsersListRequest` +**id:** `string`
@@ -7444,7 +7581,15 @@ await client.filestorage.users.list({
-**requestOptions:** `Users.RequestOptions` +**request:** `Merge.crm.EngagementTypesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `EngagementTypes.RequestOptions`
@@ -7455,7 +7600,7 @@ await client.filestorage.users.list({
-
client.filestorage.users.retrieve(id, { ...params }) -> Merge.User +
client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -7467,7 +7612,7 @@ await client.filestorage.users.list({
-Returns a `User` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -7483,7 +7628,9 @@ Returns a `User` object with the given `id`.
```typescript -await client.filestorage.users.retrieve("id"); +await client.crm.engagementTypes.remoteFieldClassesList({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -7499,15 +7646,7 @@ await client.filestorage.users.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.filestorage.UsersRetrieveRequest` +**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest`
@@ -7515,7 +7654,7 @@ await client.filestorage.users.retrieve("id");
-**requestOptions:** `Users.RequestOptions` +**requestOptions:** `EngagementTypes.RequestOptions`
@@ -7526,9 +7665,9 @@ await client.filestorage.users.retrieve("id");
-## Filestorage WebhookReceivers +## Crm Engagements -
client.filestorage.webhookReceivers.list() -> Merge.WebhookReceiver[] +
client.crm.engagements.list({ ...params }) -> Merge.PaginatedEngagementList
@@ -7540,7 +7679,7 @@ await client.filestorage.users.retrieve("id");
-Returns a list of `WebhookReceiver` objects. +Returns a list of `Engagement` objects.
@@ -7556,7 +7695,9 @@ Returns a list of `WebhookReceiver` objects.
```typescript -await client.filestorage.webhookReceivers.list(); +await client.crm.engagements.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -7572,7 +7713,15 @@ await client.filestorage.webhookReceivers.list();
-**requestOptions:** `WebhookReceivers.RequestOptions` +**request:** `Merge.crm.EngagementsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Engagements.RequestOptions`
@@ -7583,7 +7732,7 @@ await client.filestorage.webhookReceivers.list();
-
client.filestorage.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver +
client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse
@@ -7595,7 +7744,7 @@ await client.filestorage.webhookReceivers.list();
-Creates a `WebhookReceiver` object with the given values. +Creates an `Engagement` object with the given values.
@@ -7611,9 +7760,8 @@ Creates a `WebhookReceiver` object with the given values.
```typescript -await client.filestorage.webhookReceivers.create({ - event: "event", - isActive: true, +await client.crm.engagements.create({ + model: {}, }); ``` @@ -7630,7 +7778,7 @@ await client.filestorage.webhookReceivers.create({
-**request:** `Merge.filestorage.WebhookReceiverRequest` +**request:** `Merge.crm.EngagementEndpointRequest`
@@ -7638,7 +7786,7 @@ await client.filestorage.webhookReceivers.create({
-**requestOptions:** `WebhookReceivers.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7649,9 +7797,7 @@ await client.filestorage.webhookReceivers.create({
-## Crm AccountDetails - -
client.crm.accountDetails.retrieve() -> Merge.AccountDetails +
client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement
@@ -7663,7 +7809,7 @@ await client.filestorage.webhookReceivers.create({
-Get details for a linked account. +Returns an `Engagement` object with the given `id`.
@@ -7679,7 +7825,7 @@ Get details for a linked account.
```typescript -await client.crm.accountDetails.retrieve(); +await client.crm.engagements.retrieve("id"); ```
@@ -7695,7 +7841,23 @@ await client.crm.accountDetails.retrieve();
-**requestOptions:** `AccountDetails.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.crm.EngagementsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Engagements.RequestOptions`
@@ -7706,9 +7868,7 @@ await client.crm.accountDetails.retrieve();
-## Crm AccountToken - -
client.crm.accountToken.retrieve(publicToken) -> Merge.AccountToken +
client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse
@@ -7720,7 +7880,7 @@ await client.crm.accountDetails.retrieve();
-Returns the account token for the end user with the provided public token. +Updates an `Engagement` object with the given `id`.
@@ -7736,7 +7896,9 @@ Returns the account token for the end user with the provided public token.
```typescript -await client.crm.accountToken.retrieve("public_token"); +await client.crm.engagements.partialUpdate("id", { + model: {}, +}); ```
@@ -7752,7 +7914,7 @@ await client.crm.accountToken.retrieve("public_token");
-**publicToken:** `string` +**id:** `string`
@@ -7760,7 +7922,15 @@ await client.crm.accountToken.retrieve("public_token");
-**requestOptions:** `AccountToken.RequestOptions` +**request:** `Merge.crm.PatchedEngagementEndpointRequest` + +
+
+ +
+
+ +**requestOptions:** `Engagements.RequestOptions`
@@ -7771,9 +7941,7 @@ await client.crm.accountToken.retrieve("public_token");
-## Crm Accounts - -
client.crm.accounts.list({ ...params }) -> Merge.PaginatedAccountList +
client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -7785,7 +7953,7 @@ await client.crm.accountToken.retrieve("public_token");
-Returns a list of `Account` objects. +Returns metadata for `Engagement` PATCHs.
@@ -7801,9 +7969,7 @@ Returns a list of `Account` objects.
```typescript -await client.crm.accounts.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.engagements.metaPatchRetrieve("id"); ```
@@ -7819,7 +7985,7 @@ await client.crm.accounts.list({
-**request:** `Merge.crm.AccountsListRequest` +**id:** `string`
@@ -7827,7 +7993,7 @@ await client.crm.accounts.list({
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7838,7 +8004,7 @@ await client.crm.accounts.list({
-
client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse +
client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse
@@ -7850,7 +8016,7 @@ await client.crm.accounts.list({
-Creates an `Account` object with the given values. +Returns metadata for `Engagement` POSTs.
@@ -7866,9 +8032,7 @@ Creates an `Account` object with the given values.
```typescript -await client.crm.accounts.create({ - model: {}, -}); +await client.crm.engagements.metaPostRetrieve(); ```
@@ -7884,15 +8048,7 @@ await client.crm.accounts.create({
-**request:** `Merge.crm.CrmAccountEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7903,7 +8059,7 @@ await client.crm.accounts.create({
-
client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account +
client.crm.engagements.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -7915,7 +8071,7 @@ await client.crm.accounts.create({
-Returns an `Account` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -7931,7 +8087,9 @@ Returns an `Account` object with the given `id`.
```typescript -await client.crm.accounts.retrieve("id"); +await client.crm.engagements.remoteFieldClassesList({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -7947,15 +8105,7 @@ await client.crm.accounts.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.AccountsRetrieveRequest` +**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest`
@@ -7963,7 +8113,7 @@ await client.crm.accounts.retrieve("id");
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `Engagements.RequestOptions`
@@ -7974,7 +8124,9 @@ await client.crm.accounts.retrieve("id");
-
client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse +## Crm FieldMapping + +
client.crm.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
@@ -7986,7 +8138,7 @@ await client.crm.accounts.retrieve("id");
-Updates an `Account` object with the given `id`. +Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -8002,9 +8154,7 @@ Updates an `Account` object with the given `id`.
```typescript -await client.crm.accounts.partialUpdate("id", { - model: {}, -}); +await client.crm.fieldMapping.fieldMappingsRetrieve(); ```
@@ -8020,15 +8170,7 @@ await client.crm.accounts.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedCrmAccountEndpointRequest` +**request:** `Merge.crm.FieldMappingsRetrieveRequest`
@@ -8036,7 +8178,7 @@ await client.crm.accounts.partialUpdate("id", {
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8047,7 +8189,7 @@ await client.crm.accounts.partialUpdate("id", {
-
client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse +
client.crm.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
@@ -8059,7 +8201,7 @@ await client.crm.accounts.partialUpdate("id", {
-Returns metadata for `CRMAccount` PATCHs. +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.
@@ -8075,7 +8217,14 @@ Returns metadata for `CRMAccount` PATCHs.
```typescript -await client.crm.accounts.metaPatchRetrieve("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", +}); ```
@@ -8091,7 +8240,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.crm.CreateFieldMappingRequest`
@@ -8099,7 +8248,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-**requestOptions:** `Accounts.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8110,7 +8259,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-
client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse +
client.crm.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
@@ -8122,7 +8271,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-Returns metadata for `CRMAccount` 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.
@@ -8138,7 +8287,7 @@ Returns metadata for `CRMAccount` POSTs.
```typescript -await client.crm.accounts.metaPostRetrieve(); +await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
@@ -8154,7 +8303,15 @@ await client.crm.accounts.metaPostRetrieve();
-**requestOptions:** `Accounts.RequestOptions` +**fieldMappingId:** `string` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8165,7 +8322,7 @@ await client.crm.accounts.metaPostRetrieve();
-
client.crm.accounts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.crm.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
@@ -8177,7 +8334,7 @@ await client.crm.accounts.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -8193,9 +8350,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.accounts.remoteFieldClassesList({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); ```
@@ -8211,7 +8366,7 @@ await client.crm.accounts.remoteFieldClassesList({
-**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest` +**fieldMappingId:** `string`
@@ -8219,7 +8374,15 @@ await client.crm.accounts.remoteFieldClassesList({
-**requestOptions:** `Accounts.RequestOptions` +**request:** `Merge.crm.PatchedEditFieldMappingRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8230,9 +8393,7 @@ await client.crm.accounts.remoteFieldClassesList({
-## Crm AsyncPassthrough - -
client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept +
client.crm.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
@@ -8244,7 +8405,7 @@ await client.crm.accounts.remoteFieldClassesList({
-Asynchronously pull data from an endpoint not currently supported by Merge. +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/).
@@ -8260,10 +8421,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```typescript -await client.crm.asyncPassthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.crm.fieldMapping.remoteFieldsRetrieve(); ```
@@ -8279,7 +8437,7 @@ await client.crm.asyncPassthrough.create({
-**request:** `Merge.DataPassthroughRequest` +**request:** `Merge.crm.RemoteFieldsRetrieveRequest`
@@ -8287,7 +8445,7 @@ await client.crm.asyncPassthrough.create({
-**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8298,7 +8456,7 @@ await client.crm.asyncPassthrough.create({
-
client.crm.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse +
client.crm.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
@@ -8310,7 +8468,7 @@ await client.crm.asyncPassthrough.create({
-Retrieves data from earlier async-passthrough POST request +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/).
@@ -8326,7 +8484,7 @@ Retrieves data from earlier async-passthrough POST request
```typescript -await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id"); +await client.crm.fieldMapping.targetFieldsRetrieve(); ```
@@ -8342,15 +8500,7 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-**asyncPassthroughReceiptId:** `string` - -
-
- -
-
- -**requestOptions:** `AsyncPassthrough.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -8361,9 +8511,9 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-## Crm AuditTrail +## Crm GenerateKey -
client.crm.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList +
client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey
@@ -8375,7 +8525,7 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-Gets a list of audit trail events. +Create a remote key.
@@ -8391,8 +8541,8 @@ Gets a list of audit trail events.
```typescript -await client.crm.auditTrail.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +await client.crm.generateKey.create({ + name: "Remote Deployment Key 1", }); ``` @@ -8409,7 +8559,7 @@ await client.crm.auditTrail.list({
-**request:** `Merge.crm.AuditTrailListRequest` +**request:** `Merge.crm.GenerateRemoteKeyRequest`
@@ -8417,7 +8567,7 @@ await client.crm.auditTrail.list({
-**requestOptions:** `AuditTrail.RequestOptions` +**requestOptions:** `GenerateKey.RequestOptions`
@@ -8428,9 +8578,9 @@ await client.crm.auditTrail.list({
-## Crm AvailableActions +## Crm Issues -
client.crm.availableActions.retrieve() -> Merge.AvailableActions +
client.crm.issues.list({ ...params }) -> Merge.PaginatedIssueList
@@ -8442,7 +8592,7 @@ await client.crm.auditTrail.list({
-Returns a list of models and actions available for an account. +Gets all issues for Organization.
@@ -8458,7 +8608,9 @@ Returns a list of models and actions available for an account.
```typescript -await client.crm.availableActions.retrieve(); +await client.crm.issues.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -8474,7 +8626,15 @@ await client.crm.availableActions.retrieve();
-**requestOptions:** `AvailableActions.RequestOptions` +**request:** `Merge.crm.IssuesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Issues.RequestOptions`
@@ -8485,9 +8645,7 @@ await client.crm.availableActions.retrieve();
-## Crm Contacts - -
client.crm.contacts.list({ ...params }) -> Merge.PaginatedContactList +
client.crm.issues.retrieve(id) -> Merge.Issue
@@ -8499,7 +8657,7 @@ await client.crm.availableActions.retrieve();
-Returns a list of `Contact` objects. +Get a specific issue.
@@ -8515,9 +8673,7 @@ Returns a list of `Contact` objects.
```typescript -await client.crm.contacts.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.issues.retrieve("id"); ```
@@ -8533,7 +8689,7 @@ await client.crm.contacts.list({
-**request:** `Merge.crm.ContactsListRequest` +**id:** `string`
@@ -8541,7 +8697,7 @@ await client.crm.contacts.list({
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -8552,7 +8708,9 @@ await client.crm.contacts.list({
-
client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse +## Crm Leads + +
client.crm.leads.list({ ...params }) -> Merge.PaginatedLeadList
@@ -8564,7 +8722,7 @@ await client.crm.contacts.list({
-Creates a `Contact` object with the given values. +Returns a list of `Lead` objects.
@@ -8580,8 +8738,8 @@ Creates a `Contact` object with the given values.
```typescript -await client.crm.contacts.create({ - model: {}, +await client.crm.leads.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -8598,7 +8756,7 @@ await client.crm.contacts.create({
-**request:** `Merge.crm.CrmContactEndpointRequest` +**request:** `Merge.crm.LeadsListRequest`
@@ -8606,7 +8764,7 @@ await client.crm.contacts.create({
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -8617,7 +8775,7 @@ await client.crm.contacts.create({
-
client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact +
client.crm.leads.create({ ...params }) -> Merge.LeadResponse
@@ -8629,7 +8787,7 @@ await client.crm.contacts.create({
-Returns a `Contact` object with the given `id`. +Creates a `Lead` object with the given values.
@@ -8645,7 +8803,9 @@ Returns a `Contact` object with the given `id`.
```typescript -await client.crm.contacts.retrieve("id"); +await client.crm.leads.create({ + model: {}, +}); ```
@@ -8661,15 +8821,7 @@ await client.crm.contacts.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.ContactsRetrieveRequest` +**request:** `Merge.crm.LeadEndpointRequest`
@@ -8677,7 +8829,7 @@ await client.crm.contacts.retrieve("id");
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -8688,7 +8840,7 @@ await client.crm.contacts.retrieve("id");
-
client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse +
client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead
@@ -8700,7 +8852,7 @@ await client.crm.contacts.retrieve("id");
-Updates a `Contact` object with the given `id`. +Returns a `Lead` object with the given `id`.
@@ -8716,9 +8868,7 @@ Updates a `Contact` object with the given `id`.
```typescript -await client.crm.contacts.partialUpdate("id", { - model: {}, -}); +await client.crm.leads.retrieve("id"); ```
@@ -8742,7 +8892,7 @@ await client.crm.contacts.partialUpdate("id", {
-**request:** `Merge.crm.PatchedCrmContactEndpointRequest` +**request:** `Merge.crm.LeadsRetrieveRequest`
@@ -8750,7 +8900,7 @@ await client.crm.contacts.partialUpdate("id", {
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -8761,7 +8911,7 @@ await client.crm.contacts.partialUpdate("id", {
-
client.crm.contacts.ignoreCreate(modelId, { ...params }) -> void +
client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse
@@ -8773,7 +8923,7 @@ await client.crm.contacts.partialUpdate("id", {
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +Returns metadata for `Lead` POSTs.
@@ -8789,9 +8939,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.crm.leads.metaPostRetrieve(); ```
@@ -8807,23 +8955,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-**modelId:** `string` - -
-
- -
-
- -**request:** `Merge.IgnoreCommonModelRequest` - -
-
- -
-
- -**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -8834,7 +8966,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-
client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse +
client.crm.leads.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -8846,7 +8978,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-Returns metadata for `CRMContact` PATCHs. +Returns a list of `RemoteFieldClass` objects.
@@ -8862,7 +8994,9 @@ Returns metadata for `CRMContact` PATCHs.
```typescript -await client.crm.contacts.metaPatchRetrieve("id"); +await client.crm.leads.remoteFieldClassesList({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -8878,7 +9012,7 @@ await client.crm.contacts.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest`
@@ -8886,7 +9020,7 @@ await client.crm.contacts.metaPatchRetrieve("id");
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `Leads.RequestOptions`
@@ -8897,7 +9031,9 @@ await client.crm.contacts.metaPatchRetrieve("id");
-
client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse +## Crm LinkToken + +
client.crm.linkToken.create({ ...params }) -> Merge.LinkToken
@@ -8909,7 +9045,7 @@ await client.crm.contacts.metaPatchRetrieve("id");
-Returns metadata for `CRMContact` POSTs. +Creates a link token to be used when linking a new end user.
@@ -8925,7 +9061,12 @@ Returns metadata for `CRMContact` POSTs.
```typescript -await client.crm.contacts.metaPostRetrieve(); +await client.crm.linkToken.create({ + endUserEmailAddress: "example@gmail.com", + endUserOrganizationName: "Test Organization", + endUserOriginId: "12345", + categories: ["hris", "ats"], +}); ```
@@ -8941,7 +9082,15 @@ await client.crm.contacts.metaPostRetrieve();
-**requestOptions:** `Contacts.RequestOptions` +**request:** `Merge.crm.EndUserDetailsRequest` + +
+
+ +
+
+ +**requestOptions:** `LinkToken.RequestOptions`
@@ -8952,7 +9101,9 @@ await client.crm.contacts.metaPostRetrieve();
-
client.crm.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Crm LinkedAccounts + +
client.crm.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
@@ -8964,7 +9115,7 @@ await client.crm.contacts.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +List linked accounts for your organization.
@@ -8980,7 +9131,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.contacts.remoteFieldClassesList({ +await client.crm.linkedAccounts.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -8998,7 +9149,7 @@ await client.crm.contacts.remoteFieldClassesList({
-**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest` +**request:** `Merge.crm.LinkedAccountsListRequest`
@@ -9006,7 +9157,7 @@ await client.crm.contacts.remoteFieldClassesList({
-**requestOptions:** `Contacts.RequestOptions` +**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -9017,9 +9168,9 @@ await client.crm.contacts.remoteFieldClassesList({
-## Crm CustomObjectClasses +## Crm Notes -
client.crm.customObjectClasses.list({ ...params }) -> Merge.PaginatedCustomObjectClassList +
client.crm.notes.list({ ...params }) -> Merge.PaginatedNoteList
@@ -9031,7 +9182,7 @@ await client.crm.contacts.remoteFieldClassesList({
-Returns a list of `CustomObjectClass` objects. +Returns a list of `Note` objects.
@@ -9047,7 +9198,7 @@ Returns a list of `CustomObjectClass` objects.
```typescript -await client.crm.customObjectClasses.list({ +await client.crm.notes.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -9065,7 +9216,7 @@ await client.crm.customObjectClasses.list({
-**request:** `Merge.crm.CustomObjectClassesListRequest` +**request:** `Merge.crm.NotesListRequest`
@@ -9073,7 +9224,7 @@ await client.crm.customObjectClasses.list({
-**requestOptions:** `CustomObjectClasses.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -9084,7 +9235,7 @@ await client.crm.customObjectClasses.list({
-
client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass +
client.crm.notes.create({ ...params }) -> Merge.NoteResponse
@@ -9096,7 +9247,7 @@ await client.crm.customObjectClasses.list({
-Returns a `CustomObjectClass` object with the given `id`. +Creates a `Note` object with the given values.
@@ -9112,7 +9263,9 @@ Returns a `CustomObjectClass` object with the given `id`.
```typescript -await client.crm.customObjectClasses.retrieve("id"); +await client.crm.notes.create({ + model: {}, +}); ```
@@ -9128,15 +9281,7 @@ await client.crm.customObjectClasses.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesRetrieveRequest` +**request:** `Merge.crm.NoteEndpointRequest`
@@ -9144,7 +9289,7 @@ await client.crm.customObjectClasses.retrieve("id");
-**requestOptions:** `CustomObjectClasses.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -9155,9 +9300,7 @@ await client.crm.customObjectClasses.retrieve("id");
-## Crm AssociationTypes - -
client.crm.associationTypes.customObjectClassesAssociationTypesList(customObjectClassId, { ...params }) -> Merge.PaginatedAssociationTypeList +
client.crm.notes.retrieve(id, { ...params }) -> Merge.Note
@@ -9169,7 +9312,7 @@ await client.crm.customObjectClasses.retrieve("id");
-Returns a list of `AssociationType` objects. +Returns a `Note` object with the given `id`.
@@ -9185,9 +9328,7 @@ Returns a list of `AssociationType` objects.
```typescript -await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id", { - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.notes.retrieve("id"); ```
@@ -9203,7 +9344,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-**customObjectClassId:** `string` +**id:** `string`
@@ -9211,7 +9352,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest` +**request:** `Merge.crm.NotesRetrieveRequest`
@@ -9219,7 +9360,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-**requestOptions:** `AssociationTypes.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -9230,7 +9371,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-
client.crm.associationTypes.customObjectClassesAssociationTypesCreate(customObjectClassId, { ...params }) -> Merge.CrmAssociationTypeResponse +
client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse
@@ -9242,7 +9383,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-Creates an `AssociationType` object with the given values. +Returns metadata for `Note` POSTs.
@@ -9258,21 +9399,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.crm.notes.metaPostRetrieve(); ```
@@ -9288,23 +9415,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-**customObjectClassId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CrmAssociationTypeEndpointRequest` - -
-
- -
-
- -**requestOptions:** `AssociationTypes.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -9315,7 +9426,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-
client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(customObjectClassId, id, { ...params }) -> Merge.AssociationType +
client.crm.notes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -9327,7 +9438,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-Returns an `AssociationType` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -9343,7 +9454,9 @@ Returns an `AssociationType` object with the given `id`.
```typescript -await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id"); +await client.crm.notes.remoteFieldClassesList({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -9359,23 +9472,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-**customObjectClassId:** `string` - -
-
- -
-
- -**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest` +**request:** `Merge.crm.NotesRemoteFieldClassesListRequest`
@@ -9383,7 +9480,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-**requestOptions:** `AssociationTypes.RequestOptions` +**requestOptions:** `Notes.RequestOptions`
@@ -9394,7 +9491,9 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-
client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse +## Crm Opportunities + +
client.crm.opportunities.list({ ...params }) -> Merge.PaginatedOpportunityList
@@ -9406,7 +9505,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-Returns metadata for `CRMAssociationType` POSTs. +Returns a list of `Opportunity` objects.
@@ -9422,7 +9521,9 @@ Returns metadata for `CRMAssociationType` POSTs.
```typescript -await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id"); +await client.crm.opportunities.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -9438,7 +9539,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-**customObjectClassId:** `string` +**request:** `Merge.crm.OpportunitiesListRequest`
@@ -9446,7 +9547,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-**requestOptions:** `AssociationTypes.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9457,9 +9558,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-## Crm CustomObjects - -
client.crm.customObjects.customObjectClassesCustomObjectsList(customObjectClassId, { ...params }) -> Merge.PaginatedCustomObjectList +
client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse
@@ -9471,7 +9570,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-Returns a list of `CustomObject` objects. +Creates an `Opportunity` object with the given values.
@@ -9487,8 +9586,8 @@ Returns a list of `CustomObject` objects.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id", { - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +await client.crm.opportunities.create({ + model: {}, }); ``` @@ -9505,15 +9604,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-**customObjectClassId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest` +**request:** `Merge.crm.OpportunityEndpointRequest`
@@ -9521,7 +9612,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9532,7 +9623,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-
client.crm.customObjects.customObjectClassesCustomObjectsCreate(customObjectClassId, { ...params }) -> Merge.CrmCustomObjectResponse +
client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity
@@ -9544,7 +9635,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-Creates a `CustomObject` object with the given values. +Returns an `Opportunity` object with the given `id`.
@@ -9560,13 +9651,7 @@ Creates a `CustomObject` object with the given values.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", { - model: { - fields: { - test_field: "hello", - }, - }, -}); +await client.crm.opportunities.retrieve("id"); ```
@@ -9582,7 +9667,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-**customObjectClassId:** `string` +**id:** `string`
@@ -9590,7 +9675,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-**request:** `Merge.crm.CrmCustomObjectEndpointRequest` +**request:** `Merge.crm.OpportunitiesRetrieveRequest`
@@ -9598,7 +9683,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9609,7 +9694,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-
client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(customObjectClassId, id, { ...params }) -> Merge.CustomObject +
client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse
@@ -9621,7 +9706,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-Returns a `CustomObject` object with the given `id`. +Updates an `Opportunity` object with the given `id`.
@@ -9637,7 +9722,9 @@ Returns a `CustomObject` object with the given `id`.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id"); +await client.crm.opportunities.partialUpdate("id", { + model: {}, +}); ```
@@ -9653,14 +9740,6 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-**customObjectClassId:** `string` - -
-
- -
-
- **id:** `string`
@@ -9669,7 +9748,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest` +**request:** `Merge.crm.PatchedOpportunityEndpointRequest`
@@ -9677,7 +9756,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9688,7 +9767,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-
client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse +
client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -9700,7 +9779,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-Returns metadata for `CRMCustomObject` POSTs. +Returns metadata for `Opportunity` PATCHs.
@@ -9716,7 +9795,7 @@ Returns metadata for `CRMCustomObject` POSTs.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id"); +await client.crm.opportunities.metaPatchRetrieve("id"); ```
@@ -9732,7 +9811,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-**customObjectClassId:** `string` +**id:** `string`
@@ -9740,7 +9819,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9751,7 +9830,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-
client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse
@@ -9763,7 +9842,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-Returns a list of `RemoteFieldClass` objects. +Returns metadata for `Opportunity` POSTs.
@@ -9779,9 +9858,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.crm.opportunities.metaPostRetrieve(); ```
@@ -9797,15 +9874,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest` - -
-
- -
-
- -**requestOptions:** `CustomObjects.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9816,9 +9885,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-## Crm Associations - -
client.crm.associations.customObjectClassesCustomObjectsAssociationsList(customObjectClassId, objectId, { ...params }) -> Merge.PaginatedAssociationList +
client.crm.opportunities.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -9830,7 +9897,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-Returns a list of `Association` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -9846,7 +9913,7 @@ Returns a list of `Association` objects.
```typescript -await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id", { +await client.crm.opportunities.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -9864,23 +9931,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-**customObjectClassId:** `string` - -
-
- -
-
- -**objectId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest` +**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest`
@@ -9888,7 +9939,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-**requestOptions:** `Associations.RequestOptions` +**requestOptions:** `Opportunities.RequestOptions`
@@ -9899,7 +9950,9 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-
client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(associationTypeId, sourceClassId, sourceObjectId, targetClassId, targetObjectId, { ...params }) -> Merge.Association +## Crm Passthrough + +
client.crm.passthrough.create({ ...params }) -> Merge.RemoteResponse
@@ -9911,7 +9964,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`. +Pull data from an endpoint not currently supported by Merge.
@@ -9927,13 +9980,10 @@ 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.crm.passthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -9949,47 +9999,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-**associationTypeId:** `string` - -
-
- -
-
- -**sourceClassId:** `string` - -
-
- -
-
- -**sourceObjectId:** `string` - -
-
- -
-
- -**targetClassId:** `string` - -
-
- -
-
- -**targetObjectId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -9997,7 +10007,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-**requestOptions:** `Associations.RequestOptions` +**requestOptions:** `Passthrough.RequestOptions`
@@ -10008,9 +10018,9 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-## Crm Scopes +## Crm RegenerateKey -
client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi +
client.crm.regenerateKey.create({ ...params }) -> Merge.RemoteKey
@@ -10022,7 +10032,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). +Exchange remote keys.
@@ -10038,7 +10048,9 @@ Get the default permissions for Merge Common Models and fields across all Linked
```typescript -await client.crm.scopes.defaultScopesRetrieve(); +await client.crm.regenerateKey.create({ + name: "Remote Deployment Key 1", +}); ```
@@ -10054,7 +10066,15 @@ await client.crm.scopes.defaultScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**request:** `Merge.crm.RemoteKeyForRegenerationRequest` + +
+
+ +
+
+ +**requestOptions:** `RegenerateKey.RequestOptions`
@@ -10065,7 +10085,9 @@ await client.crm.scopes.defaultScopesRetrieve();
-
client.crm.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi +## Crm Stages + +
client.crm.stages.list({ ...params }) -> Merge.PaginatedStageList
@@ -10077,7 +10099,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). +Returns a list of `Stage` objects.
@@ -10093,7 +10115,9 @@ Get all available permissions for Merge Common Models and fields for a single Li
```typescript -await client.crm.scopes.linkedAccountScopesRetrieve(); +await client.crm.stages.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -10109,7 +10133,15 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-**requestOptions:** `Scopes.RequestOptions` +**request:** `Merge.crm.StagesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Stages.RequestOptions`
@@ -10120,7 +10152,7 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-
client.crm.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi +
client.crm.stages.retrieve(id, { ...params }) -> Merge.Stage
@@ -10132,7 +10164,7 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes) +Returns a `Stage` object with the given `id`.
@@ -10145,36 +10177,10 @@ 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, - }, - }, - }, - ], -}); +
+ +```typescript +await client.crm.stages.retrieve("id"); ```
@@ -10190,7 +10196,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest` +**id:** `string`
@@ -10198,7 +10204,15 @@ await client.crm.scopes.linkedAccountScopesCreate({
-**requestOptions:** `Scopes.RequestOptions` +**request:** `Merge.crm.StagesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Stages.RequestOptions`
@@ -10209,9 +10223,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-## Crm DeleteAccount - -
client.crm.deleteAccount.delete() -> void +
client.crm.stages.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -10223,7 +10235,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-Delete a linked account. +Returns a list of `RemoteFieldClass` objects.
@@ -10239,7 +10251,9 @@ Delete a linked account.
```typescript -await client.crm.deleteAccount.delete(); +await client.crm.stages.remoteFieldClassesList({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -10255,7 +10269,15 @@ await client.crm.deleteAccount.delete();
-**requestOptions:** `DeleteAccount.RequestOptions` +**request:** `Merge.crm.StagesRemoteFieldClassesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Stages.RequestOptions`
@@ -10266,9 +10288,9 @@ await client.crm.deleteAccount.delete();
-## Crm EngagementTypes +## Crm SyncStatus -
client.crm.engagementTypes.list({ ...params }) -> Merge.PaginatedEngagementTypeList +
client.crm.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
@@ -10280,7 +10302,7 @@ await client.crm.deleteAccount.delete();
-Returns a list of `EngagementType` objects. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -10296,7 +10318,7 @@ Returns a list of `EngagementType` objects.
```typescript -await client.crm.engagementTypes.list({ +await client.crm.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -10314,7 +10336,7 @@ await client.crm.engagementTypes.list({
-**request:** `Merge.crm.EngagementTypesListRequest` +**request:** `Merge.crm.SyncStatusListRequest`
@@ -10322,7 +10344,7 @@ await client.crm.engagementTypes.list({
-**requestOptions:** `EngagementTypes.RequestOptions` +**requestOptions:** `SyncStatus.RequestOptions`
@@ -10333,7 +10355,9 @@ await client.crm.engagementTypes.list({
-
client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType +## Crm ForceResync + +
client.crm.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
@@ -10345,7 +10369,7 @@ await client.crm.engagementTypes.list({
-Returns an `EngagementType` 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.
@@ -10361,7 +10385,7 @@ Returns an `EngagementType` object with the given `id`.
```typescript -await client.crm.engagementTypes.retrieve("id"); +await client.crm.forceResync.syncStatusResyncCreate(); ```
@@ -10377,23 +10401,7 @@ await client.crm.engagementTypes.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.EngagementTypesRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `EngagementTypes.RequestOptions` +**requestOptions:** `ForceResync.RequestOptions`
@@ -10404,7 +10412,9 @@ await client.crm.engagementTypes.retrieve("id");
-
client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Crm Tasks + +
client.crm.tasks.list({ ...params }) -> Merge.PaginatedTaskList
@@ -10416,7 +10426,7 @@ await client.crm.engagementTypes.retrieve("id");
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Task` objects.
@@ -10432,7 +10442,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.engagementTypes.remoteFieldClassesList({ +await client.crm.tasks.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -10450,7 +10460,7 @@ await client.crm.engagementTypes.remoteFieldClassesList({
-**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest` +**request:** `Merge.crm.TasksListRequest`
@@ -10458,7 +10468,7 @@ await client.crm.engagementTypes.remoteFieldClassesList({
-**requestOptions:** `EngagementTypes.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -10469,9 +10479,7 @@ await client.crm.engagementTypes.remoteFieldClassesList({
-## Crm Engagements - -
client.crm.engagements.list({ ...params }) -> Merge.PaginatedEngagementList +
client.crm.tasks.create({ ...params }) -> Merge.TaskResponse
@@ -10483,7 +10491,7 @@ await client.crm.engagementTypes.remoteFieldClassesList({
-Returns a list of `Engagement` objects. +Creates a `Task` object with the given values.
@@ -10499,8 +10507,8 @@ Returns a list of `Engagement` objects.
```typescript -await client.crm.engagements.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +await client.crm.tasks.create({ + model: {}, }); ``` @@ -10517,7 +10525,7 @@ await client.crm.engagements.list({
-**request:** `Merge.crm.EngagementsListRequest` +**request:** `Merge.crm.TaskEndpointRequest`
@@ -10525,7 +10533,7 @@ await client.crm.engagements.list({
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -10536,7 +10544,7 @@ await client.crm.engagements.list({
-
client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse +
client.crm.tasks.retrieve(id, { ...params }) -> Merge.Task
@@ -10548,7 +10556,7 @@ await client.crm.engagements.list({
-Creates an `Engagement` object with the given values. +Returns a `Task` object with the given `id`.
@@ -10564,9 +10572,7 @@ Creates an `Engagement` object with the given values.
```typescript -await client.crm.engagements.create({ - model: {}, -}); +await client.crm.tasks.retrieve("id"); ```
@@ -10582,7 +10588,7 @@ await client.crm.engagements.create({
-**request:** `Merge.crm.EngagementEndpointRequest` +**id:** `string`
@@ -10590,7 +10596,15 @@ await client.crm.engagements.create({
-**requestOptions:** `Engagements.RequestOptions` +**request:** `Merge.crm.TasksRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Tasks.RequestOptions`
@@ -10601,7 +10615,7 @@ await client.crm.engagements.create({
-
client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement +
client.crm.tasks.partialUpdate(id, { ...params }) -> Merge.TaskResponse
@@ -10613,7 +10627,7 @@ await client.crm.engagements.create({
-Returns an `Engagement` object with the given `id`. +Updates a `Task` object with the given `id`.
@@ -10629,7 +10643,9 @@ Returns an `Engagement` object with the given `id`.
```typescript -await client.crm.engagements.retrieve("id"); +await client.crm.tasks.partialUpdate("id", { + model: {}, +}); ```
@@ -10653,7 +10669,7 @@ await client.crm.engagements.retrieve("id");
-**request:** `Merge.crm.EngagementsRetrieveRequest` +**request:** `Merge.crm.PatchedTaskEndpointRequest`
@@ -10661,7 +10677,7 @@ await client.crm.engagements.retrieve("id");
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -10672,7 +10688,7 @@ await client.crm.engagements.retrieve("id");
-
client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse +
client.crm.tasks.metaPatchRetrieve(id) -> Merge.MetaResponse
@@ -10684,7 +10700,7 @@ await client.crm.engagements.retrieve("id");
-Updates an `Engagement` object with the given `id`. +Returns metadata for `Task` PATCHs.
@@ -10700,9 +10716,7 @@ Updates an `Engagement` object with the given `id`.
```typescript -await client.crm.engagements.partialUpdate("id", { - model: {}, -}); +await client.crm.tasks.metaPatchRetrieve("id"); ```
@@ -10726,15 +10740,7 @@ await client.crm.engagements.partialUpdate("id", {
-**request:** `Merge.crm.PatchedEngagementEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -10745,7 +10751,7 @@ await client.crm.engagements.partialUpdate("id", {
-
client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse +
client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse
@@ -10757,7 +10763,7 @@ await client.crm.engagements.partialUpdate("id", {
-Returns metadata for `Engagement` PATCHs. +Returns metadata for `Task` POSTs.
@@ -10773,7 +10779,7 @@ Returns metadata for `Engagement` PATCHs.
```typescript -await client.crm.engagements.metaPatchRetrieve("id"); +await client.crm.tasks.metaPostRetrieve(); ```
@@ -10789,15 +10795,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-**id:** `string` - -
-
- -
-
- -**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Tasks.RequestOptions`
@@ -10808,7 +10806,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-
client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse +
client.crm.tasks.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -10820,7 +10818,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-Returns metadata for `Engagement` POSTs. +Returns a list of `RemoteFieldClass` objects.
@@ -10836,7 +10834,9 @@ Returns metadata for `Engagement` POSTs.
```typescript -await client.crm.engagements.metaPostRetrieve(); +await client.crm.tasks.remoteFieldClassesList({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -10852,7 +10852,15 @@ await client.crm.engagements.metaPostRetrieve();
-**requestOptions:** `Engagements.RequestOptions` +**request:** `Merge.crm.TasksRemoteFieldClassesListRequest` + +
+
+ +
+
+ +**requestOptions:** `Tasks.RequestOptions`
@@ -10863,7 +10871,9 @@ await client.crm.engagements.metaPostRetrieve();
-
client.crm.engagements.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Crm Users + +
client.crm.users.list({ ...params }) -> Merge.PaginatedUserList
@@ -10875,7 +10885,7 @@ await client.crm.engagements.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `User` objects.
@@ -10891,7 +10901,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.engagements.remoteFieldClassesList({ +await client.crm.users.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -10909,7 +10919,7 @@ await client.crm.engagements.remoteFieldClassesList({
-**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest` +**request:** `Merge.crm.UsersListRequest`
@@ -10917,7 +10927,7 @@ await client.crm.engagements.remoteFieldClassesList({
-**requestOptions:** `Engagements.RequestOptions` +**requestOptions:** `Users.RequestOptions`
@@ -10928,9 +10938,7 @@ await client.crm.engagements.remoteFieldClassesList({
-## Crm FieldMapping - -
client.crm.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse +
client.crm.users.retrieve(id, { ...params }) -> Merge.User
@@ -10942,7 +10950,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 `User` object with the given `id`.
@@ -10958,7 +10966,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```typescript -await client.crm.fieldMapping.fieldMappingsRetrieve(); +await client.crm.users.retrieve("id"); ```
@@ -10974,7 +10982,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-**request:** `Merge.crm.FieldMappingsRetrieveRequest` +**id:** `string`
@@ -10982,7 +10990,15 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.crm.UsersRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions`
@@ -10993,7 +11009,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-
client.crm.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse +
client.crm.users.ignoreCreate(modelId, { ...params }) -> void
@@ -11005,7 +11021,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. +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.
@@ -11021,13 +11037,8 @@ 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.crm.users.ignoreCreate("model_id", { + reason: "GENERAL_CUSTOMER_REQUEST", }); ``` @@ -11044,7 +11055,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-**request:** `Merge.crm.CreateFieldMappingRequest` +**modelId:** `string`
@@ -11052,7 +11063,15 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-**requestOptions:** `FieldMapping.RequestOptions` +**request:** `Merge.IgnoreCommonModelRequest` + +
+
+ +
+
+ +**requestOptions:** `Users.RequestOptions`
@@ -11063,7 +11082,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-
client.crm.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse +
client.crm.users.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
@@ -11075,7 +11094,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 `RemoteFieldClass` objects.
@@ -11091,7 +11110,9 @@ 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.crm.users.remoteFieldClassesList({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -11107,7 +11128,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**fieldMappingId:** `string` +**request:** `Merge.crm.UsersRemoteFieldClassesListRequest`
@@ -11115,7 +11136,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `Users.RequestOptions`
@@ -11126,7 +11147,9 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
client.crm.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse +## Crm WebhookReceivers + +
client.crm.webhookReceivers.list() -> Merge.WebhookReceiver[]
@@ -11138,7 +11161,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 list of `WebhookReceiver` objects.
@@ -11154,7 +11177,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.crm.webhookReceivers.list(); ```
@@ -11170,23 +11193,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-**fieldMappingId:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedEditFieldMappingRequest` - -
-
- -
-
- -**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -11197,7 +11204,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
client.crm.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse +
client.crm.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
@@ -11209,7 +11216,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/). +Creates a `WebhookReceiver` object with the given values.
@@ -11225,7 +11232,10 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```typescript -await client.crm.fieldMapping.remoteFieldsRetrieve(); +await client.crm.webhookReceivers.create({ + event: "event", + isActive: true, +}); ```
@@ -11241,7 +11251,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-**request:** `Merge.crm.RemoteFieldsRetrieveRequest` +**request:** `Merge.crm.WebhookReceiverRequest`
@@ -11249,7 +11259,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -11260,7 +11270,9 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-
client.crm.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse +## Filestorage AccountDetails + +
client.filestorage.accountDetails.retrieve() -> Merge.AccountDetails
@@ -11272,7 +11284,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/). +Get details for a linked account.
@@ -11288,7 +11300,7 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```typescript -await client.crm.fieldMapping.targetFieldsRetrieve(); +await client.filestorage.accountDetails.retrieve(); ```
@@ -11304,7 +11316,7 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-**requestOptions:** `FieldMapping.RequestOptions` +**requestOptions:** `AccountDetails.RequestOptions`
@@ -11315,9 +11327,9 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-## Crm GenerateKey +## Filestorage AccountToken -
client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey +
client.filestorage.accountToken.retrieve(publicToken) -> Merge.AccountToken
@@ -11329,7 +11341,7 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-Create a remote key. +Returns the account token for the end user with the provided public token.
@@ -11345,9 +11357,7 @@ Create a remote key.
```typescript -await client.crm.generateKey.create({ - name: "Remote Deployment Key 1", -}); +await client.filestorage.accountToken.retrieve("public_token"); ```
@@ -11363,7 +11373,7 @@ await client.crm.generateKey.create({
-**request:** `Merge.crm.GenerateRemoteKeyRequest` +**publicToken:** `string`
@@ -11371,7 +11381,7 @@ await client.crm.generateKey.create({
-**requestOptions:** `GenerateKey.RequestOptions` +**requestOptions:** `AccountToken.RequestOptions`
@@ -11382,9 +11392,9 @@ await client.crm.generateKey.create({
-## Crm Issues +## Filestorage AsyncPassthrough -
client.crm.issues.list({ ...params }) -> Merge.PaginatedIssueList +
client.filestorage.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
@@ -11396,7 +11406,7 @@ await client.crm.generateKey.create({
-Gets all issues for Organization. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -11412,8 +11422,9 @@ Gets all issues for Organization.
```typescript -await client.crm.issues.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +await client.filestorage.asyncPassthrough.create({ + method: "GET", + path: "/scooters", }); ``` @@ -11430,7 +11441,7 @@ await client.crm.issues.list({
-**request:** `Merge.crm.IssuesListRequest` +**request:** `Merge.DataPassthroughRequest`
@@ -11438,7 +11449,7 @@ await client.crm.issues.list({
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -11449,7 +11460,7 @@ await client.crm.issues.list({
-
client.crm.issues.retrieve(id) -> Merge.Issue +
client.filestorage.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
@@ -11461,7 +11472,7 @@ await client.crm.issues.list({
-Get a specific issue. +Retrieves data from earlier async-passthrough POST request
@@ -11477,7 +11488,7 @@ Get a specific issue.
```typescript -await client.crm.issues.retrieve("id"); +await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
@@ -11493,7 +11504,7 @@ await client.crm.issues.retrieve("id");
-**id:** `string` +**asyncPassthroughReceiptId:** `string`
@@ -11501,7 +11512,7 @@ await client.crm.issues.retrieve("id");
-**requestOptions:** `Issues.RequestOptions` +**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -11512,9 +11523,9 @@ await client.crm.issues.retrieve("id");
-## Crm Leads +## Filestorage AuditTrail -
client.crm.leads.list({ ...params }) -> Merge.PaginatedLeadList +
client.filestorage.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
@@ -11526,7 +11537,7 @@ await client.crm.issues.retrieve("id");
-Returns a list of `Lead` objects. +Gets a list of audit trail events.
@@ -11542,7 +11553,7 @@ Returns a list of `Lead` objects.
```typescript -await client.crm.leads.list({ +await client.filestorage.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -11560,7 +11571,7 @@ await client.crm.leads.list({
-**request:** `Merge.crm.LeadsListRequest` +**request:** `Merge.filestorage.AuditTrailListRequest`
@@ -11568,7 +11579,7 @@ await client.crm.leads.list({
-**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `AuditTrail.RequestOptions`
@@ -11579,7 +11590,9 @@ await client.crm.leads.list({
-
client.crm.leads.create({ ...params }) -> Merge.LeadResponse +## Filestorage AvailableActions + +
client.filestorage.availableActions.retrieve() -> Merge.AvailableActions
@@ -11591,7 +11604,7 @@ await client.crm.leads.list({
-Creates a `Lead` object with the given values. +Returns a list of models and actions available for an account.
@@ -11607,9 +11620,7 @@ Creates a `Lead` object with the given values.
```typescript -await client.crm.leads.create({ - model: {}, -}); +await client.filestorage.availableActions.retrieve(); ```
@@ -11625,15 +11636,7 @@ await client.crm.leads.create({
-**request:** `Merge.crm.LeadEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `AvailableActions.RequestOptions`
@@ -11644,7 +11647,9 @@ await client.crm.leads.create({
-
client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead +## Filestorage Scopes + +
client.filestorage.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -11656,7 +11661,7 @@ await client.crm.leads.create({
-Returns a `Lead` object with the given `id`. +Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -11672,7 +11677,7 @@ Returns a `Lead` object with the given `id`.
```typescript -await client.crm.leads.retrieve("id"); +await client.filestorage.scopes.defaultScopesRetrieve(); ```
@@ -11688,23 +11693,7 @@ await client.crm.leads.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.LeadsRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -11715,7 +11704,7 @@ await client.crm.leads.retrieve("id");
-
client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse +
client.filestorage.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
@@ -11727,7 +11716,7 @@ await client.crm.leads.retrieve("id");
-Returns metadata for `Lead` POSTs. +Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -11743,7 +11732,7 @@ Returns metadata for `Lead` POSTs.
```typescript -await client.crm.leads.metaPostRetrieve(); +await client.filestorage.scopes.linkedAccountScopesRetrieve(); ```
@@ -11759,7 +11748,7 @@ await client.crm.leads.metaPostRetrieve();
-**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -11770,7 +11759,7 @@ await client.crm.leads.metaPostRetrieve();
-
client.crm.leads.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.filestorage.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
@@ -11782,7 +11771,7 @@ await client.crm.leads.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -11798,8 +11787,32 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.leads.remoteFieldClassesList({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +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, + }, + }, + }, + ], }); ``` @@ -11816,7 +11829,7 @@ await client.crm.leads.remoteFieldClassesList({
-**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest` +**request:** `Merge.filestorage.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -11824,7 +11837,7 @@ await client.crm.leads.remoteFieldClassesList({
-**requestOptions:** `Leads.RequestOptions` +**requestOptions:** `Scopes.RequestOptions`
@@ -11835,9 +11848,9 @@ await client.crm.leads.remoteFieldClassesList({
-## Crm LinkToken +## Filestorage DeleteAccount -
client.crm.linkToken.create({ ...params }) -> Merge.LinkToken +
client.filestorage.deleteAccount.delete() -> void
@@ -11849,7 +11862,7 @@ await client.crm.leads.remoteFieldClassesList({
-Creates a link token to be used when linking a new end user. +Delete a linked account.
@@ -11865,12 +11878,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.filestorage.deleteAccount.delete(); ```
@@ -11886,15 +11894,7 @@ await client.crm.linkToken.create({
-**request:** `Merge.crm.EndUserDetailsRequest` - -
-
- -
-
- -**requestOptions:** `LinkToken.RequestOptions` +**requestOptions:** `DeleteAccount.RequestOptions`
@@ -11905,9 +11905,9 @@ await client.crm.linkToken.create({
-## Crm LinkedAccounts +## Filestorage Drives -
client.crm.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList +
client.filestorage.drives.list({ ...params }) -> Merge.PaginatedDriveList
@@ -11919,7 +11919,7 @@ await client.crm.linkToken.create({
-List linked accounts for your organization. +Returns a list of `Drive` objects.
@@ -11935,7 +11935,7 @@ List linked accounts for your organization.
```typescript -await client.crm.linkedAccounts.list({ +await client.filestorage.drives.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -11953,7 +11953,7 @@ await client.crm.linkedAccounts.list({
-**request:** `Merge.crm.LinkedAccountsListRequest` +**request:** `Merge.filestorage.DrivesListRequest`
@@ -11961,7 +11961,7 @@ await client.crm.linkedAccounts.list({
-**requestOptions:** `LinkedAccounts.RequestOptions` +**requestOptions:** `Drives.RequestOptions`
@@ -11972,9 +11972,7 @@ await client.crm.linkedAccounts.list({
-## Crm Notes - -
client.crm.notes.list({ ...params }) -> Merge.PaginatedNoteList +
client.filestorage.drives.retrieve(id, { ...params }) -> Merge.Drive
@@ -11986,7 +11984,7 @@ await client.crm.linkedAccounts.list({
-Returns a list of `Note` objects. +Returns a `Drive` object with the given `id`.
@@ -12002,9 +12000,7 @@ Returns a list of `Note` objects.
```typescript -await client.crm.notes.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.filestorage.drives.retrieve("id"); ```
@@ -12020,7 +12016,7 @@ await client.crm.notes.list({
-**request:** `Merge.crm.NotesListRequest` +**id:** `string`
@@ -12028,7 +12024,15 @@ await client.crm.notes.list({
-**requestOptions:** `Notes.RequestOptions` +**request:** `Merge.filestorage.DrivesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Drives.RequestOptions`
@@ -12039,7 +12043,9 @@ await client.crm.notes.list({
-
client.crm.notes.create({ ...params }) -> Merge.NoteResponse +## Filestorage FieldMapping + +
client.filestorage.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
@@ -12051,7 +12057,7 @@ await client.crm.notes.list({
-Creates a `Note` 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/).
@@ -12067,9 +12073,7 @@ Creates a `Note` object with the given values.
```typescript -await client.crm.notes.create({ - model: {}, -}); +await client.filestorage.fieldMapping.fieldMappingsRetrieve(); ```
@@ -12085,7 +12089,7 @@ await client.crm.notes.create({
-**request:** `Merge.crm.NoteEndpointRequest` +**request:** `Merge.filestorage.FieldMappingsRetrieveRequest`
@@ -12093,7 +12097,7 @@ await client.crm.notes.create({
-**requestOptions:** `Notes.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12104,7 +12108,7 @@ await client.crm.notes.create({
-
client.crm.notes.retrieve(id, { ...params }) -> Merge.Note +
client.filestorage.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
@@ -12116,7 +12120,7 @@ await client.crm.notes.create({
-Returns a `Note` 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.
@@ -12132,7 +12136,14 @@ Returns a `Note` object with the given `id`.
```typescript -await client.crm.notes.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", +}); ```
@@ -12148,15 +12159,7 @@ await client.crm.notes.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.NotesRetrieveRequest` +**request:** `Merge.filestorage.CreateFieldMappingRequest`
@@ -12164,7 +12167,7 @@ await client.crm.notes.retrieve("id");
-**requestOptions:** `Notes.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12175,7 +12178,7 @@ await client.crm.notes.retrieve("id");
-
client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse +
client.filestorage.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
@@ -12187,7 +12190,7 @@ await client.crm.notes.retrieve("id");
-Returns metadata for `Note` 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.
@@ -12203,7 +12206,7 @@ Returns metadata for `Note` POSTs.
```typescript -await client.crm.notes.metaPostRetrieve(); +await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
@@ -12219,7 +12222,15 @@ await client.crm.notes.metaPostRetrieve();
-**requestOptions:** `Notes.RequestOptions` +**fieldMappingId:** `string` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12230,7 +12241,7 @@ await client.crm.notes.metaPostRetrieve();
-
client.crm.notes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.filestorage.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
@@ -12242,7 +12253,7 @@ await client.crm.notes.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -12258,9 +12269,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.notes.remoteFieldClassesList({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id"); ```
@@ -12276,7 +12285,7 @@ await client.crm.notes.remoteFieldClassesList({
-**request:** `Merge.crm.NotesRemoteFieldClassesListRequest` +**fieldMappingId:** `string`
@@ -12284,7 +12293,15 @@ await client.crm.notes.remoteFieldClassesList({
-**requestOptions:** `Notes.RequestOptions` +**request:** `Merge.filestorage.PatchedEditFieldMappingRequest` + +
+
+ +
+
+ +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12295,9 +12312,7 @@ await client.crm.notes.remoteFieldClassesList({
-## Crm Opportunities - -
client.crm.opportunities.list({ ...params }) -> Merge.PaginatedOpportunityList +
client.filestorage.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
@@ -12309,7 +12324,7 @@ await client.crm.notes.remoteFieldClassesList({
-Returns a list of `Opportunity` 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/).
@@ -12325,9 +12340,7 @@ Returns a list of `Opportunity` objects.
```typescript -await client.crm.opportunities.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.filestorage.fieldMapping.remoteFieldsRetrieve(); ```
@@ -12343,7 +12356,7 @@ await client.crm.opportunities.list({
-**request:** `Merge.crm.OpportunitiesListRequest` +**request:** `Merge.filestorage.RemoteFieldsRetrieveRequest`
@@ -12351,7 +12364,7 @@ await client.crm.opportunities.list({
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12362,7 +12375,7 @@ await client.crm.opportunities.list({
-
client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse +
client.filestorage.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
@@ -12374,7 +12387,7 @@ await client.crm.opportunities.list({
-Creates an `Opportunity` object with the given values. +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/).
@@ -12390,9 +12403,7 @@ Creates an `Opportunity` object with the given values.
```typescript -await client.crm.opportunities.create({ - model: {}, -}); +await client.filestorage.fieldMapping.targetFieldsRetrieve(); ```
@@ -12408,15 +12419,7 @@ await client.crm.opportunities.create({
-**request:** `Merge.crm.OpportunityEndpointRequest` - -
-
- -
-
- -**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `FieldMapping.RequestOptions`
@@ -12427,7 +12430,9 @@ await client.crm.opportunities.create({
-
client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity +## Filestorage Files + +
client.filestorage.files.list({ ...params }) -> Merge.PaginatedFileList
@@ -12439,7 +12444,7 @@ await client.crm.opportunities.create({
-Returns an `Opportunity` object with the given `id`. +Returns a list of `File` objects.
@@ -12455,7 +12460,9 @@ Returns an `Opportunity` object with the given `id`.
```typescript -await client.crm.opportunities.retrieve("id"); +await client.filestorage.files.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -12471,15 +12478,7 @@ await client.crm.opportunities.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.OpportunitiesRetrieveRequest` +**request:** `Merge.filestorage.FilesListRequest`
@@ -12487,7 +12486,7 @@ await client.crm.opportunities.retrieve("id");
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -12498,7 +12497,7 @@ await client.crm.opportunities.retrieve("id");
-
client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse +
client.filestorage.files.create({ ...params }) -> Merge.FileStorageFileResponse
@@ -12510,7 +12509,7 @@ await client.crm.opportunities.retrieve("id");
-Updates an `Opportunity` object with the given `id`. +Creates a `File` object with the given values.
@@ -12526,7 +12525,7 @@ Updates an `Opportunity` object with the given `id`.
```typescript -await client.crm.opportunities.partialUpdate("id", { +await client.filestorage.files.create({ model: {}, }); ``` @@ -12544,15 +12543,7 @@ await client.crm.opportunities.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedOpportunityEndpointRequest` +**request:** `Merge.filestorage.FileStorageFileEndpointRequest`
@@ -12560,7 +12551,7 @@ await client.crm.opportunities.partialUpdate("id", {
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -12571,7 +12562,7 @@ await client.crm.opportunities.partialUpdate("id", {
-
client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse +
client.filestorage.files.retrieve(id, { ...params }) -> Merge.File_
@@ -12583,7 +12574,7 @@ await client.crm.opportunities.partialUpdate("id", {
-Returns metadata for `Opportunity` PATCHs. +Returns a `File` object with the given `id`.
@@ -12599,7 +12590,7 @@ Returns metadata for `Opportunity` PATCHs.
```typescript -await client.crm.opportunities.metaPatchRetrieve("id"); +await client.filestorage.files.retrieve("id"); ```
@@ -12623,7 +12614,15 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-**requestOptions:** `Opportunities.RequestOptions` +**request:** `Merge.filestorage.FilesRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Files.RequestOptions`
@@ -12634,7 +12633,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-
client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse +
client.filestorage.files.downloadRequestMetaRetrieve(id, { ...params }) -> Merge.DownloadRequestMeta
@@ -12646,7 +12645,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-Returns metadata for `Opportunity` POSTs. +Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -12662,7 +12661,7 @@ Returns metadata for `Opportunity` POSTs.
```typescript -await client.crm.opportunities.metaPostRetrieve(); +await client.filestorage.files.downloadRequestMetaRetrieve("id"); ```
@@ -12678,7 +12677,23 @@ await client.crm.opportunities.metaPostRetrieve();
-**requestOptions:** `Opportunities.RequestOptions` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.filestorage.FilesDownloadRequestMetaRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Files.RequestOptions`
@@ -12689,7 +12704,7 @@ await client.crm.opportunities.metaPostRetrieve();
-
client.crm.opportunities.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.filestorage.files.downloadRequestMetaList({ ...params }) -> Merge.PaginatedDownloadRequestMetaList
@@ -12701,7 +12716,7 @@ await client.crm.opportunities.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -12717,7 +12732,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.opportunities.remoteFieldClassesList({ +await client.filestorage.files.downloadRequestMetaList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -12735,7 +12750,7 @@ await client.crm.opportunities.remoteFieldClassesList({
-**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest` +**request:** `Merge.filestorage.FilesDownloadRequestMetaListRequest`
@@ -12743,7 +12758,7 @@ await client.crm.opportunities.remoteFieldClassesList({
-**requestOptions:** `Opportunities.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -12754,9 +12769,7 @@ await client.crm.opportunities.remoteFieldClassesList({
-## Crm Passthrough - -
client.crm.passthrough.create({ ...params }) -> Merge.RemoteResponse +
client.filestorage.files.metaPostRetrieve() -> Merge.MetaResponse
@@ -12768,7 +12781,7 @@ await client.crm.opportunities.remoteFieldClassesList({
-Pull data from an endpoint not currently supported by Merge. +Returns metadata for `FileStorageFile` POSTs.
@@ -12784,10 +12797,7 @@ Pull data from an endpoint not currently supported by Merge.
```typescript -await client.crm.passthrough.create({ - method: "GET", - path: "/scooters", -}); +await client.filestorage.files.metaPostRetrieve(); ```
@@ -12803,15 +12813,7 @@ await client.crm.passthrough.create({
-**request:** `Merge.DataPassthroughRequest` - -
-
- -
-
- -**requestOptions:** `Passthrough.RequestOptions` +**requestOptions:** `Files.RequestOptions`
@@ -12822,9 +12824,9 @@ await client.crm.passthrough.create({
-## Crm RegenerateKey +## Filestorage Folders -
client.crm.regenerateKey.create({ ...params }) -> Merge.RemoteKey +
client.filestorage.folders.list({ ...params }) -> Merge.PaginatedFolderList
@@ -12836,7 +12838,7 @@ await client.crm.passthrough.create({
-Exchange remote keys. +Returns a list of `Folder` objects.
@@ -12852,8 +12854,8 @@ Exchange remote keys.
```typescript -await client.crm.regenerateKey.create({ - name: "Remote Deployment Key 1", +await client.filestorage.folders.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -12870,7 +12872,7 @@ await client.crm.regenerateKey.create({
-**request:** `Merge.crm.RemoteKeyForRegenerationRequest` +**request:** `Merge.filestorage.FoldersListRequest`
@@ -12878,7 +12880,7 @@ await client.crm.regenerateKey.create({
-**requestOptions:** `RegenerateKey.RequestOptions` +**requestOptions:** `Folders.RequestOptions`
@@ -12889,9 +12891,7 @@ await client.crm.regenerateKey.create({
-## Crm Stages - -
client.crm.stages.list({ ...params }) -> Merge.PaginatedStageList +
client.filestorage.folders.create({ ...params }) -> Merge.FileStorageFolderResponse
@@ -12903,7 +12903,7 @@ await client.crm.regenerateKey.create({
-Returns a list of `Stage` objects. +Creates a `Folder` object with the given values.
@@ -12919,8 +12919,8 @@ Returns a list of `Stage` objects.
```typescript -await client.crm.stages.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +await client.filestorage.folders.create({ + model: {}, }); ``` @@ -12937,7 +12937,7 @@ await client.crm.stages.list({
-**request:** `Merge.crm.StagesListRequest` +**request:** `Merge.filestorage.FileStorageFolderEndpointRequest`
@@ -12945,7 +12945,7 @@ await client.crm.stages.list({
-**requestOptions:** `Stages.RequestOptions` +**requestOptions:** `Folders.RequestOptions`
@@ -12956,7 +12956,7 @@ await client.crm.stages.list({
-
client.crm.stages.retrieve(id, { ...params }) -> Merge.Stage +
client.filestorage.folders.retrieve(id, { ...params }) -> Merge.Folder
@@ -12968,7 +12968,7 @@ await client.crm.stages.list({
-Returns a `Stage` object with the given `id`. +Returns a `Folder` object with the given `id`.
@@ -12984,7 +12984,7 @@ Returns a `Stage` object with the given `id`.
```typescript -await client.crm.stages.retrieve("id"); +await client.filestorage.folders.retrieve("id"); ```
@@ -13008,7 +13008,7 @@ await client.crm.stages.retrieve("id");
-**request:** `Merge.crm.StagesRetrieveRequest` +**request:** `Merge.filestorage.FoldersRetrieveRequest`
@@ -13016,7 +13016,7 @@ await client.crm.stages.retrieve("id");
-**requestOptions:** `Stages.RequestOptions` +**requestOptions:** `Folders.RequestOptions`
@@ -13027,7 +13027,7 @@ await client.crm.stages.retrieve("id");
-
client.crm.stages.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.filestorage.folders.metaPostRetrieve() -> Merge.MetaResponse
@@ -13039,7 +13039,7 @@ await client.crm.stages.retrieve("id");
-Returns a list of `RemoteFieldClass` objects. +Returns metadata for `FileStorageFolder` POSTs.
@@ -13055,9 +13055,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.stages.remoteFieldClassesList({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.filestorage.folders.metaPostRetrieve(); ```
@@ -13065,23 +13063,15 @@ await client.crm.stages.remoteFieldClassesList({
-#### ⚙️ Parameters - -
-
+#### ⚙️ Parameters
-**request:** `Merge.crm.StagesRemoteFieldClassesListRequest` - -
-
-
-**requestOptions:** `Stages.RequestOptions` +**requestOptions:** `Folders.RequestOptions`
@@ -13092,9 +13082,9 @@ await client.crm.stages.remoteFieldClassesList({
-## Crm SyncStatus +## Filestorage GenerateKey -
client.crm.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList +
client.filestorage.generateKey.create({ ...params }) -> Merge.RemoteKey
@@ -13106,7 +13096,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). +Create a remote key.
@@ -13122,8 +13112,8 @@ Get sync status for the current sync and the most recently finished sync. `last_
```typescript -await client.crm.syncStatus.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +await client.filestorage.generateKey.create({ + name: "Remote Deployment Key 1", }); ``` @@ -13140,7 +13130,7 @@ await client.crm.syncStatus.list({
-**request:** `Merge.crm.SyncStatusListRequest` +**request:** `Merge.filestorage.GenerateRemoteKeyRequest`
@@ -13148,7 +13138,7 @@ await client.crm.syncStatus.list({
-**requestOptions:** `SyncStatus.RequestOptions` +**requestOptions:** `GenerateKey.RequestOptions`
@@ -13159,9 +13149,9 @@ await client.crm.syncStatus.list({
-## Crm ForceResync +## Filestorage Groups -
client.crm.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[] +
client.filestorage.groups.list({ ...params }) -> Merge.PaginatedGroupList
@@ -13173,7 +13163,7 @@ await client.crm.syncStatus.list({
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Returns a list of `Group` objects.
@@ -13189,7 +13179,9 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```typescript -await client.crm.forceResync.syncStatusResyncCreate(); +await client.filestorage.groups.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -13205,7 +13197,15 @@ await client.crm.forceResync.syncStatusResyncCreate();
-**requestOptions:** `ForceResync.RequestOptions` +**request:** `Merge.filestorage.GroupsListRequest` + +
+
+ +
+
+ +**requestOptions:** `Groups.RequestOptions`
@@ -13216,9 +13216,7 @@ await client.crm.forceResync.syncStatusResyncCreate();
-## Crm Tasks - -
client.crm.tasks.list({ ...params }) -> Merge.PaginatedTaskList +
client.filestorage.groups.retrieve(id, { ...params }) -> Merge.Group
@@ -13230,7 +13228,7 @@ await client.crm.forceResync.syncStatusResyncCreate();
-Returns a list of `Task` objects. +Returns a `Group` object with the given `id`.
@@ -13246,9 +13244,7 @@ Returns a list of `Task` objects.
```typescript -await client.crm.tasks.list({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.filestorage.groups.retrieve("id"); ```
@@ -13264,7 +13260,7 @@ await client.crm.tasks.list({
-**request:** `Merge.crm.TasksListRequest` +**id:** `string`
@@ -13272,7 +13268,15 @@ await client.crm.tasks.list({
-**requestOptions:** `Tasks.RequestOptions` +**request:** `Merge.filestorage.GroupsRetrieveRequest` + +
+
+ +
+
+ +**requestOptions:** `Groups.RequestOptions`
@@ -13283,7 +13287,9 @@ await client.crm.tasks.list({
-
client.crm.tasks.create({ ...params }) -> Merge.TaskResponse +## Filestorage Issues + +
client.filestorage.issues.list({ ...params }) -> Merge.PaginatedIssueList
@@ -13295,7 +13301,7 @@ await client.crm.tasks.list({
-Creates a `Task` object with the given values. +Gets all issues for Organization.
@@ -13311,8 +13317,8 @@ Creates a `Task` object with the given values.
```typescript -await client.crm.tasks.create({ - model: {}, +await client.filestorage.issues.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -13329,7 +13335,7 @@ await client.crm.tasks.create({
-**request:** `Merge.crm.TaskEndpointRequest` +**request:** `Merge.filestorage.IssuesListRequest`
@@ -13337,7 +13343,7 @@ await client.crm.tasks.create({
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -13348,7 +13354,7 @@ await client.crm.tasks.create({
-
client.crm.tasks.retrieve(id, { ...params }) -> Merge.Task +
client.filestorage.issues.retrieve(id) -> Merge.Issue
@@ -13360,7 +13366,7 @@ await client.crm.tasks.create({
-Returns a `Task` object with the given `id`. +Get a specific issue.
@@ -13376,7 +13382,7 @@ Returns a `Task` object with the given `id`.
```typescript -await client.crm.tasks.retrieve("id"); +await client.filestorage.issues.retrieve("id"); ```
@@ -13400,15 +13406,7 @@ await client.crm.tasks.retrieve("id");
-**request:** `Merge.crm.TasksRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `Issues.RequestOptions`
@@ -13419,7 +13417,9 @@ await client.crm.tasks.retrieve("id");
-
client.crm.tasks.partialUpdate(id, { ...params }) -> Merge.TaskResponse +## Filestorage LinkToken + +
client.filestorage.linkToken.create({ ...params }) -> Merge.LinkToken
@@ -13431,7 +13431,7 @@ await client.crm.tasks.retrieve("id");
-Updates a `Task` object with the given `id`. +Creates a link token to be used when linking a new end user.
@@ -13447,8 +13447,11 @@ Updates a `Task` object with the given `id`.
```typescript -await client.crm.tasks.partialUpdate("id", { - model: {}, +await client.filestorage.linkToken.create({ + endUserEmailAddress: "example@gmail.com", + endUserOrganizationName: "Test Organization", + endUserOriginId: "12345", + categories: ["hris", "ats"], }); ``` @@ -13465,15 +13468,7 @@ await client.crm.tasks.partialUpdate("id", {
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.PatchedTaskEndpointRequest` +**request:** `Merge.filestorage.EndUserDetailsRequest`
@@ -13481,7 +13476,7 @@ await client.crm.tasks.partialUpdate("id", {
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `LinkToken.RequestOptions`
@@ -13492,7 +13487,9 @@ await client.crm.tasks.partialUpdate("id", {
-
client.crm.tasks.metaPatchRetrieve(id) -> Merge.MetaResponse +## Filestorage LinkedAccounts + +
client.filestorage.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
@@ -13504,7 +13501,7 @@ await client.crm.tasks.partialUpdate("id", {
-Returns metadata for `Task` PATCHs. +List linked accounts for your organization.
@@ -13520,7 +13517,9 @@ Returns metadata for `Task` PATCHs.
```typescript -await client.crm.tasks.metaPatchRetrieve("id"); +await client.filestorage.linkedAccounts.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +}); ```
@@ -13536,7 +13535,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-**id:** `string` +**request:** `Merge.filestorage.LinkedAccountsListRequest`
@@ -13544,7 +13543,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -13555,7 +13554,9 @@ await client.crm.tasks.metaPatchRetrieve("id");
-
client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse +## Filestorage Passthrough + +
client.filestorage.passthrough.create({ ...params }) -> Merge.RemoteResponse
@@ -13567,7 +13568,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-Returns metadata for `Task` POSTs. +Pull data from an endpoint not currently supported by Merge.
@@ -13583,7 +13584,10 @@ Returns metadata for `Task` POSTs.
```typescript -await client.crm.tasks.metaPostRetrieve(); +await client.filestorage.passthrough.create({ + method: "GET", + path: "/scooters", +}); ```
@@ -13599,7 +13603,15 @@ await client.crm.tasks.metaPostRetrieve();
-**requestOptions:** `Tasks.RequestOptions` +**request:** `Merge.DataPassthroughRequest` + +
+
+ +
+
+ +**requestOptions:** `Passthrough.RequestOptions`
@@ -13610,7 +13622,9 @@ await client.crm.tasks.metaPostRetrieve();
-
client.crm.tasks.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +## Filestorage RegenerateKey + +
client.filestorage.regenerateKey.create({ ...params }) -> Merge.RemoteKey
@@ -13622,7 +13636,7 @@ await client.crm.tasks.metaPostRetrieve();
-Returns a list of `RemoteFieldClass` objects. +Exchange remote keys.
@@ -13638,8 +13652,8 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.tasks.remoteFieldClassesList({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +await client.filestorage.regenerateKey.create({ + name: "Remote Deployment Key 1", }); ``` @@ -13656,7 +13670,7 @@ await client.crm.tasks.remoteFieldClassesList({
-**request:** `Merge.crm.TasksRemoteFieldClassesListRequest` +**request:** `Merge.filestorage.RemoteKeyForRegenerationRequest`
@@ -13664,7 +13678,7 @@ await client.crm.tasks.remoteFieldClassesList({
-**requestOptions:** `Tasks.RequestOptions` +**requestOptions:** `RegenerateKey.RequestOptions`
@@ -13675,9 +13689,9 @@ await client.crm.tasks.remoteFieldClassesList({
-## Crm Users +## Filestorage SyncStatus -
client.crm.users.list({ ...params }) -> Merge.PaginatedUserList +
client.filestorage.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
@@ -13689,7 +13703,7 @@ await client.crm.tasks.remoteFieldClassesList({
-Returns a list of `User` objects. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -13705,7 +13719,7 @@ Returns a list of `User` objects.
```typescript -await client.crm.users.list({ +await client.filestorage.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -13723,7 +13737,7 @@ await client.crm.users.list({
-**request:** `Merge.crm.UsersListRequest` +**request:** `Merge.filestorage.SyncStatusListRequest`
@@ -13731,7 +13745,7 @@ await client.crm.users.list({
-**requestOptions:** `Users.RequestOptions` +**requestOptions:** `SyncStatus.RequestOptions`
@@ -13742,7 +13756,9 @@ await client.crm.users.list({
-
client.crm.users.retrieve(id, { ...params }) -> Merge.User +## Filestorage ForceResync + +
client.filestorage.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
@@ -13754,7 +13770,7 @@ await client.crm.users.list({
-Returns a `User` 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.
@@ -13770,7 +13786,7 @@ Returns a `User` object with the given `id`.
```typescript -await client.crm.users.retrieve("id"); +await client.filestorage.forceResync.syncStatusResyncCreate(); ```
@@ -13786,23 +13802,7 @@ await client.crm.users.retrieve("id");
-**id:** `string` - -
-
- -
-
- -**request:** `Merge.crm.UsersRetrieveRequest` - -
-
- -
-
- -**requestOptions:** `Users.RequestOptions` +**requestOptions:** `ForceResync.RequestOptions`
@@ -13813,7 +13813,9 @@ await client.crm.users.retrieve("id");
-
client.crm.users.ignoreCreate(modelId, { ...params }) -> void +## Filestorage Users + +
client.filestorage.users.list({ ...params }) -> Merge.PaginatedUserList
@@ -13825,7 +13827,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 `User` objects.
@@ -13841,8 +13843,8 @@ 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.filestorage.users.list({ + cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", }); ``` @@ -13859,15 +13861,7 @@ await client.crm.users.ignoreCreate("model_id", {
-**modelId:** `string` - -
-
- -
-
- -**request:** `Merge.IgnoreCommonModelRequest` +**request:** `Merge.filestorage.UsersListRequest`
@@ -13886,7 +13880,7 @@ await client.crm.users.ignoreCreate("model_id", {
-
client.crm.users.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList +
client.filestorage.users.retrieve(id, { ...params }) -> Merge.User
@@ -13898,7 +13892,7 @@ await client.crm.users.ignoreCreate("model_id", {
-Returns a list of `RemoteFieldClass` objects. +Returns a `User` object with the given `id`.
@@ -13914,9 +13908,7 @@ Returns a list of `RemoteFieldClass` objects.
```typescript -await client.crm.users.remoteFieldClassesList({ - cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -}); +await client.filestorage.users.retrieve("id"); ```
@@ -13932,7 +13924,15 @@ await client.crm.users.remoteFieldClassesList({
-**request:** `Merge.crm.UsersRemoteFieldClassesListRequest` +**id:** `string` + +
+
+ +
+
+ +**request:** `Merge.filestorage.UsersRetrieveRequest`
@@ -13951,9 +13951,9 @@ await client.crm.users.remoteFieldClassesList({
-## Crm WebhookReceivers +## Filestorage WebhookReceivers -
client.crm.webhookReceivers.list() -> Merge.WebhookReceiver[] +
client.filestorage.webhookReceivers.list() -> Merge.WebhookReceiver[]
@@ -13981,7 +13981,7 @@ Returns a list of `WebhookReceiver` objects.
```typescript -await client.crm.webhookReceivers.list(); +await client.filestorage.webhookReceivers.list(); ```
@@ -14008,7 +14008,7 @@ await client.crm.webhookReceivers.list();
-
client.crm.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver +
client.filestorage.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
@@ -14036,7 +14036,7 @@ Creates a `WebhookReceiver` object with the given values.
```typescript -await client.crm.webhookReceivers.create({ +await client.filestorage.webhookReceivers.create({ event: "event", isActive: true, }); @@ -14055,7 +14055,7 @@ await client.crm.webhookReceivers.create({
-**request:** `Merge.crm.WebhookReceiverRequest` +**request:** `Merge.filestorage.WebhookReceiverRequest`
diff --git a/src/Client.ts b/src/Client.ts index bff80679..a9dfca49 100644 --- a/src/Client.ts +++ b/src/Client.ts @@ -6,8 +6,8 @@ import * as environments from "./environments"; import * as core from "./core"; import { mergeHeaders } from "./core/headers"; import { Ats } from "./api/resources/ats/client/Client"; -import { Filestorage } from "./api/resources/filestorage/client/Client"; import { Crm } from "./api/resources/crm/client/Client"; +import { Filestorage } from "./api/resources/filestorage/client/Client"; import { Hris } from "./api/resources/hris/client/Client"; import { Ticketing } from "./api/resources/ticketing/client/Client"; import { Accounting } from "./api/resources/accounting/client/Client"; @@ -44,8 +44,8 @@ export declare namespace MergeClient { export class MergeClient { protected readonly _options: MergeClient.Options; protected _ats: Ats | undefined; - protected _filestorage: Filestorage | undefined; protected _crm: Crm | undefined; + protected _filestorage: Filestorage | undefined; protected _hris: Hris | undefined; protected _ticketing: Ticketing | undefined; protected _accounting: Accounting | undefined; @@ -72,14 +72,14 @@ export class MergeClient { return (this._ats ??= new Ats(this._options)); } - public get filestorage(): Filestorage { - return (this._filestorage ??= new Filestorage(this._options)); - } - public get crm(): Crm { return (this._crm ??= new Crm(this._options)); } + public get filestorage(): Filestorage { + return (this._filestorage ??= new Filestorage(this._options)); + } + public get hris(): Hris { return (this._hris ??= new Hris(this._options)); } diff --git a/src/api/resources/index.ts b/src/api/resources/index.ts index 7df44053..2be011c9 100644 --- a/src/api/resources/index.ts +++ b/src/api/resources/index.ts @@ -1,6 +1,6 @@ export * as ats from "./ats"; -export * as filestorage from "./filestorage"; export * as crm from "./crm"; +export * as filestorage from "./filestorage"; export * as hris from "./hris"; export * as ticketing from "./ticketing"; export * as accounting from "./accounting"; diff --git a/src/serialization/resources/index.ts b/src/serialization/resources/index.ts index 7df44053..2be011c9 100644 --- a/src/serialization/resources/index.ts +++ b/src/serialization/resources/index.ts @@ -1,6 +1,6 @@ export * as ats from "./ats"; -export * as filestorage from "./filestorage"; export * as crm from "./crm"; +export * as filestorage from "./filestorage"; export * as hris from "./hris"; export * as ticketing from "./ticketing"; export * as accounting from "./accounting"; diff --git a/yarn.lock b/yarn.lock index be449d53..04bfb470 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2,14 +2,6 @@ # yarn lockfile v1 -"@ampproject/remapping@^2.2.0": - version "2.3.0" - resolved "https://registry.yarnpkg.com/@ampproject/remapping/-/remapping-2.3.0.tgz#ed441b6fa600072520ce18b43d2c8cc8caecc7f4" - integrity sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw== - dependencies: - "@jridgewell/gen-mapping" "^0.3.5" - "@jridgewell/trace-mapping" "^0.3.24" - "@babel/code-frame@^7.0.0", "@babel/code-frame@^7.12.13", "@babel/code-frame@^7.27.1": version "7.27.1" resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.27.1.tgz#200f715e66d52a23b221a9435534a91cc13ad5be" @@ -20,25 +12,25 @@ picocolors "^1.1.1" "@babel/compat-data@^7.27.2": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.28.0.tgz#9fc6fd58c2a6a15243cd13983224968392070790" - integrity sha512-60X7qkglvrap8mn1lh2ebxXdZYtUcpd7gsmy9kLaBJ4i/WdY8PqTSdxyA8qraikqKQK5C1KRBKXqznrVapyNaw== + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.28.4.tgz#96fdf1af1b8859c8474ab39c295312bfb7c24b04" + integrity sha512-YsmSKC29MJwf0gF8Rjjrg5LQCmyh+j/nD8/eP7f+BeoQTKYqs9RoWbjGOdy0+1Ekr68RJZMUOPVQaQisnIo4Rw== "@babel/core@^7.11.6", "@babel/core@^7.12.3", "@babel/core@^7.23.9": - version "7.28.3" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.3.tgz#aceddde69c5d1def69b839d09efa3e3ff59c97cb" - integrity sha512-yDBHV9kQNcr2/sUr9jghVyz9C3Y5G2zUM2H2lo+9mKv4sFgbA8s8Z9t8D1jiTkGoO/NoIfKMyKWr4s6CN23ZwQ== + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.4.tgz#12a550b8794452df4c8b084f95003bce1742d496" + integrity sha512-2BCOP7TN8M+gVDj7/ht3hsaO/B/n5oDbiAyyvnRlNOs+u1o+JWNYTQrmpuNp1/Wq2gcFrI01JAW+paEKDMx/CA== dependencies: - "@ampproject/remapping" "^2.2.0" "@babel/code-frame" "^7.27.1" "@babel/generator" "^7.28.3" "@babel/helper-compilation-targets" "^7.27.2" "@babel/helper-module-transforms" "^7.28.3" - "@babel/helpers" "^7.28.3" - "@babel/parser" "^7.28.3" + "@babel/helpers" "^7.28.4" + "@babel/parser" "^7.28.4" "@babel/template" "^7.27.2" - "@babel/traverse" "^7.28.3" - "@babel/types" "^7.28.2" + "@babel/traverse" "^7.28.4" + "@babel/types" "^7.28.4" + "@jridgewell/remapping" "^2.3.5" convert-source-map "^2.0.0" debug "^4.1.0" gensync "^1.0.0-beta.2" @@ -109,20 +101,20 @@ resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz#fa52f5b1e7db1ab049445b421c4471303897702f" integrity sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg== -"@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== +"@babel/helpers@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.4.tgz#fe07274742e95bdf7cf1443593eeb8926ab63827" + integrity sha512-HFN59MmQXGHVyYadKLVumYsA9dBFun/ldYxipEjzA4196jpLZd8UjEEBLkbEkvfYreDqJhZxYAWFPtrfhNpj4w== dependencies: "@babel/template" "^7.27.2" - "@babel/types" "^7.28.2" + "@babel/types" "^7.28.4" -"@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== +"@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", "@babel/parser@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.4.tgz#da25d4643532890932cc03f7705fe19637e03fa8" + integrity sha512-yZbBqeM6TkpP9du/I2pUZnJsRMGGvOuIrhjzC1AwHwW+6he4mni6Bp/m8ijn0iOuZuPI2BfkCoSRunpyjnrQKg== dependencies: - "@babel/types" "^7.28.2" + "@babel/types" "^7.28.4" "@babel/plugin-syntax-async-generators@^7.8.4": version "7.8.4" @@ -252,23 +244,23 @@ "@babel/parser" "^7.27.2" "@babel/types" "^7.27.1" -"@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== +"@babel/traverse@^7.27.1", "@babel/traverse@^7.28.3", "@babel/traverse@^7.28.4": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.4.tgz#8d456101b96ab175d487249f60680221692b958b" + integrity sha512-YEzuboP2qvQavAcjgQNVgsvHIDv6ZpwXvcvjmyySP2DIMuByS/6ioU5G9pYrWHM6T2YDfc7xga9iNzYOs12CFQ== dependencies: "@babel/code-frame" "^7.27.1" "@babel/generator" "^7.28.3" "@babel/helper-globals" "^7.28.0" - "@babel/parser" "^7.28.3" + "@babel/parser" "^7.28.4" "@babel/template" "^7.27.2" - "@babel/types" "^7.28.2" + "@babel/types" "^7.28.4" debug "^4.3.1" -"@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== +"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.27.1", "@babel/types@^7.28.2", "@babel/types@^7.28.4", "@babel/types@^7.3.3": + version "7.28.4" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.28.4.tgz#0a4e618f4c60a7cd6c11cb2d48060e4dbe38ac3a" + integrity sha512-bkFqkLhh3pMBUQQkpVgWDWq/lqzc2678eUyDlTBhRqhCHFguYYGM0Efga7tYk4TogG/3x0EEl66/OQ+WGbWB/Q== dependencies: "@babel/helper-string-parser" "^7.27.1" "@babel/helper-validator-identifier" "^7.27.1" @@ -540,6 +532,14 @@ "@jridgewell/sourcemap-codec" "^1.5.0" "@jridgewell/trace-mapping" "^0.3.24" +"@jridgewell/remapping@^2.3.5": + version "2.3.5" + resolved "https://registry.yarnpkg.com/@jridgewell/remapping/-/remapping-2.3.5.tgz#375c476d1972947851ba1e15ae8f123047445aa1" + integrity sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ== + dependencies: + "@jridgewell/gen-mapping" "^0.3.5" + "@jridgewell/trace-mapping" "^0.3.24" + "@jridgewell/resolve-uri@^3.1.0": version "3.1.2" resolved "https://registry.yarnpkg.com/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz#7a0ee601f60f99a20c7c7c5ff0c80388c1189bd6" @@ -1175,9 +1175,9 @@ camelcase@^6.2.0: integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== caniuse-lite@^1.0.30001737: - version "1.0.30001739" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001739.tgz#b34ce2d56bfc22f4352b2af0144102d623a124f4" - integrity sha512-y+j60d6ulelrNSwpPyrHdl+9mJnQzHBr08xm48Qno0nSk4h3Qojh+ziv2qE6rXf4k3tadF4o1J/1tAbVm1NtnA== + version "1.0.30001741" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001741.tgz#67fb92953edc536442f3c9da74320774aa523143" + integrity sha512-QGUGitqsc8ARjLdgAfxETDhRbJ0REsP6O3I96TAth/mVjh2cYzN2u+3AzPP3aVSm2FehEItaJw1xd+IGBXWeSw== chalk@^4.0.0, chalk@^4.1.0: version "4.1.2" @@ -1372,9 +1372,9 @@ dunder-proto@^1.0.1: gopd "^1.2.0" electron-to-chromium@^1.5.211: - version "1.5.214" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.214.tgz#f7bbdc0796124292d4b8a34a49e968c5e6430763" - integrity sha512-TpvUNdha+X3ybfU78NoQatKvQEm1oq3lf2QbnmCEdw+Bd9RuIAY+hJTvq1avzHM0f7EJfnH3vbCnbzKzisc/9Q== + version "1.5.215" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.215.tgz#200c8d69b1270af6126837b6b1f95077c3a347b1" + integrity sha512-TIvGp57UpeNetj/wV/xpFNpWGb0b/ROw372lHPx5Aafx02gjTBtWnEEcaSX3W2dLM3OSdGGyHX/cHl01JQsLaQ== emittery@^0.13.1: version "0.13.1" @@ -2449,9 +2449,9 @@ ms@^2.1.3: integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== msw@^2.8.4: - version "2.11.1" - resolved "https://registry.yarnpkg.com/msw/-/msw-2.11.1.tgz#77f7c5c60ffd08e4bc351cca4608418db15e5ac2" - integrity sha512-dGSRx0AJmQVQfpGXTsAAq4JFdwdhOBdJ6sJS/jnN0ac3s0NZB6daacHF1z5Pefx+IejmvuiLWw260RlyQOf3sQ== + version "2.11.2" + resolved "https://registry.yarnpkg.com/msw/-/msw-2.11.2.tgz#622d83855f456a5f93b1528f6eb6f4c0114623c3" + integrity sha512-MI54hLCsrMwiflkcqlgYYNJJddY5/+S0SnONvhv1owOplvqohKSQyGejpNdUGyCwgs4IH7PqaNbPw/sKOEze9Q== dependencies: "@bundled-es-modules/cookie" "^2.0.1" "@bundled-es-modules/statuses" "^1.0.1" @@ -2467,6 +2467,7 @@ msw@^2.8.4: outvariant "^1.4.3" path-to-regexp "^6.3.0" picocolors "^1.1.1" + rettime "^0.7.0" strict-event-emitter "^0.5.1" tough-cookie "^6.0.0" type-fest "^4.26.1" @@ -2500,9 +2501,9 @@ node-int64@^0.4.0: integrity sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw== node-releases@^2.0.19: - version "2.0.19" - resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.19.tgz#9e445a52950951ec4d177d843af370b411caf314" - integrity sha512-xxOWJsBKtzAq7DY0J+DTzuz58K8e7sJbdgwkbMWQe8UYB6ekmsQ45q0M/tJDsGaZmbC+l7n57UV8Hl5tHxO9uw== + version "2.0.20" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.20.tgz#e26bb79dbdd1e64a146df389c699014c611cbc27" + integrity sha512-7gK6zSXEH6neM212JgfYFXe+GmZQM+fia5SsusuBIUgnPheLFBmIPhtFoAQRj8/7wASYQnbDlHPVwY0BefoFgA== normalize-path@^3.0.0: version "3.0.0" @@ -2517,9 +2518,9 @@ npm-run-path@^4.0.1: path-key "^3.0.0" nwsapi@^2.2.2: - version "2.2.21" - resolved "https://registry.yarnpkg.com/nwsapi/-/nwsapi-2.2.21.tgz#8df7797079350adda208910d8c33fc4c2d7520c3" - integrity sha512-o6nIY3qwiSXl7/LuOU0Dmuctd34Yay0yeuZRLFmDPrrdHpXKFndPj3hM+YEPVHYC5fx2otBx4Ilc/gyYSAUaIA== + version "2.2.22" + resolved "https://registry.yarnpkg.com/nwsapi/-/nwsapi-2.2.22.tgz#109f9530cda6c156d6a713cdf5939e9f0de98b9d" + integrity sha512-ujSMe1OWVn55euT1ihwCI1ZcAaAU3nxUiDwfDQldc51ZXaB9m2AyOn6/jh1BLe2t/G8xd6uKG1UBF2aZJeg2SQ== once@^1.3.0: version "1.4.0" @@ -2743,6 +2744,11 @@ resolve@^1.20.0: path-parse "^1.0.7" supports-preserve-symlinks-flag "^1.0.0" +rettime@^0.7.0: + version "0.7.0" + resolved "https://registry.yarnpkg.com/rettime/-/rettime-0.7.0.tgz#c040f1a65e396eaa4b8346dd96ed937edc79d96f" + integrity sha512-LPRKoHnLKd/r3dVxcwO7vhCW+orkOGj9ViueosEBK6ie89CijnfRlhaDhHq/3Hxu4CkWQtxwlBG0mzTQY6uQjw== + safe-buffer@^5.1.0, safe-buffer@~5.2.0: version "5.2.1" resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6" @@ -2972,17 +2978,17 @@ test-exclude@^6.0.0: glob "^7.1.4" minimatch "^3.0.4" -tldts-core@^7.0.12: - version "7.0.12" - resolved "https://registry.yarnpkg.com/tldts-core/-/tldts-core-7.0.12.tgz#b471e773dc23ff881a9d187ec145e36edde57c27" - integrity sha512-3K76aXywJFduGRsOYoY5JzINLs/WMlOkeDwPL+8OCPq2Rh39gkSDtWAxdJQlWjpun/xF/LHf29yqCi6VC/rHDA== +tldts-core@^7.0.13: + version "7.0.13" + resolved "https://registry.yarnpkg.com/tldts-core/-/tldts-core-7.0.13.tgz#01e30579c88f299485cebcada440a7a2d51c96f1" + integrity sha512-Td0LeWLgXJGsikI4mO82fRexgPCEyTcwWiXJERF/GBHX3Dm+HQq/wx4HnYowCbiwQ8d+ENLZc+ktbZw8H+0oEA== tldts@^7.0.5: - version "7.0.12" - resolved "https://registry.yarnpkg.com/tldts/-/tldts-7.0.12.tgz#e11008e9a3f27448e7aecb8d0fa51f929ec9549d" - integrity sha512-M9ZQBPp6FyqhMcl233vHYyYRkxXOA1SKGlnq13S0mJdUhRSwr2w6I8rlchPL73wBwRlyIZpFvpu2VcdSMWLYXw== + version "7.0.13" + resolved "https://registry.yarnpkg.com/tldts/-/tldts-7.0.13.tgz#3f7151b0266fd613930b4dbecd28f95616267fb3" + integrity sha512-z/SgnxiICGb7Gli0z7ci9BZdjy1tQORUbdmzEUA7NbIJKWhdONn78Ji8gV0PAGfHPyEd+I+W2rMzhLjWkv2Olg== dependencies: - tldts-core "^7.0.12" + tldts-core "^7.0.13" tmpl@1.0.5: version "1.0.5"