diff --git a/package.json b/package.json
index 2d48f4e22..9f62cd1fc 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@mergeapi/merge-node-client",
- "version": "1.1.9",
+ "version": "2.0.0",
"private": false,
"repository": "https://github.com/merge-api/merge-node-client",
"main": "./index.js",
diff --git a/reference.md b/reference.md
index 9f71ec27e..98551f704 100644
--- a/reference.md
+++ b/reference.md
@@ -7220,7 +7220,7 @@ await client.filestorage.regenerateKey.create({
-
-Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+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).
@@ -7587,9 +7587,9 @@ await client.filestorage.webhookReceivers.create({
-## Hris AccountDetails
+## Crm AccountDetails
-client.hris.accountDetails.retrieve() -> Merge.AccountDetails
+client.crm.accountDetails.retrieve() -> Merge.AccountDetails
-
@@ -7617,7 +7617,7 @@ Get details for a linked account.
-
```typescript
-await client.hris.accountDetails.retrieve();
+await client.crm.accountDetails.retrieve();
```
@@ -7644,9 +7644,9 @@ await client.hris.accountDetails.retrieve();
-## Hris AccountToken
+## Crm AccountToken
-client.hris.accountToken.retrieve(publicToken) -> Merge.AccountToken
+client.crm.accountToken.retrieve(publicToken) -> Merge.AccountToken
-
@@ -7674,7 +7674,7 @@ Returns the account token for the end user with the provided public token.
-
```typescript
-await client.hris.accountToken.retrieve("public_token");
+await client.crm.accountToken.retrieve("public_token");
```
@@ -7709,9 +7709,9 @@ await client.hris.accountToken.retrieve("public_token");
-## Hris AsyncPassthrough
+## Crm Accounts
-client.hris.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
+client.crm.accounts.list({ ...params }) -> Merge.PaginatedAccountList
-
@@ -7723,7 +7723,7 @@ await client.hris.accountToken.retrieve("public_token");
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns a list of `Account` objects.
@@ -7739,10 +7739,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.hris.asyncPassthrough.create({
- method: "GET",
- path: "/scooters",
-});
+await client.crm.accounts.list();
```
@@ -7758,7 +7755,7 @@ await client.hris.asyncPassthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
+**request:** `Merge.crm.AccountsListRequest`
@@ -7766,7 +7763,7 @@ await client.hris.asyncPassthrough.create({
-
-**requestOptions:** `AsyncPassthrough.RequestOptions`
+**requestOptions:** `Accounts.RequestOptions`
@@ -7777,7 +7774,7 @@ await client.hris.asyncPassthrough.create({
-client.hris.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
+client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse
-
@@ -7789,7 +7786,7 @@ await client.hris.asyncPassthrough.create({
-
-Retrieves data from earlier async-passthrough POST request
+Creates an `Account` object with the given values.
@@ -7805,7 +7802,9 @@ Retrieves data from earlier async-passthrough POST request
-
```typescript
-await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+await client.crm.accounts.create({
+ model: {},
+});
```
@@ -7821,7 +7820,7 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-
-**asyncPassthroughReceiptId:** `string`
+**request:** `Merge.crm.CrmAccountEndpointRequest`
@@ -7829,7 +7828,7 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-
-**requestOptions:** `AsyncPassthrough.RequestOptions`
+**requestOptions:** `Accounts.RequestOptions`
@@ -7840,9 +7839,7 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-## Hris AuditTrail
-
-client.hris.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account
-
@@ -7854,7 +7851,7 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-
-Gets a list of audit trail events.
+Returns an `Account` object with the given `id`.
@@ -7870,7 +7867,7 @@ Gets a list of audit trail events.
-
```typescript
-await client.hris.auditTrail.list();
+await client.crm.accounts.retrieve("id");
```
@@ -7886,7 +7883,7 @@ await client.hris.auditTrail.list();
-
-**request:** `Merge.hris.AuditTrailListRequest`
+**id:** `string`
@@ -7894,7 +7891,15 @@ await client.hris.auditTrail.list();
-
-**requestOptions:** `AuditTrail.RequestOptions`
+**request:** `Merge.crm.AccountsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
@@ -7905,9 +7910,7 @@ await client.hris.auditTrail.list();
-## Hris AvailableActions
-
-client.hris.availableActions.retrieve() -> Merge.AvailableActions
+client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse
-
@@ -7919,7 +7922,7 @@ await client.hris.auditTrail.list();
-
-Returns a list of models and actions available for an account.
+Updates an `Account` object with the given `id`.
@@ -7935,7 +7938,9 @@ Returns a list of models and actions available for an account.
-
```typescript
-await client.hris.availableActions.retrieve();
+await client.crm.accounts.partialUpdate("id", {
+ model: {},
+});
```
@@ -7951,7 +7956,23 @@ await client.hris.availableActions.retrieve();
-
-**requestOptions:** `AvailableActions.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.PatchedCrmAccountEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
@@ -7962,9 +7983,7 @@ await client.hris.availableActions.retrieve();
-## Hris BankInfo
-
-client.hris.bankInfo.list({ ...params }) -> Merge.PaginatedBankInfoList
+client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -7976,7 +7995,7 @@ await client.hris.availableActions.retrieve();
-
-Returns a list of `BankInfo` objects.
+Returns metadata for `CRMAccount` PATCHs.
@@ -7992,7 +8011,7 @@ Returns a list of `BankInfo` objects.
-
```typescript
-await client.hris.bankInfo.list();
+await client.crm.accounts.metaPatchRetrieve("id");
```
@@ -8008,7 +8027,7 @@ await client.hris.bankInfo.list();
-
-**request:** `Merge.hris.BankInfoListRequest`
+**id:** `string`
@@ -8016,7 +8035,7 @@ await client.hris.bankInfo.list();
-
-**requestOptions:** `BankInfo.RequestOptions`
+**requestOptions:** `Accounts.RequestOptions`
@@ -8027,7 +8046,7 @@ await client.hris.bankInfo.list();
-client.hris.bankInfo.retrieve(id, { ...params }) -> Merge.BankInfo
+client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -8039,7 +8058,7 @@ await client.hris.bankInfo.list();
-
-Returns a `BankInfo` object with the given `id`.
+Returns metadata for `CRMAccount` POSTs.
@@ -8055,7 +8074,7 @@ Returns a `BankInfo` object with the given `id`.
-
```typescript
-await client.hris.bankInfo.retrieve("id");
+await client.crm.accounts.metaPostRetrieve();
```
@@ -8071,23 +8090,7 @@ await client.hris.bankInfo.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.BankInfoRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `BankInfo.RequestOptions`
+**requestOptions:** `Accounts.RequestOptions`
@@ -8098,9 +8101,7 @@ await client.hris.bankInfo.retrieve("id");
-## Hris Benefits
-
-client.hris.benefits.list({ ...params }) -> Merge.PaginatedBenefitList
+client.crm.accounts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -8112,7 +8113,7 @@ await client.hris.bankInfo.retrieve("id");
-
-Returns a list of `Benefit` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -8128,7 +8129,7 @@ Returns a list of `Benefit` objects.
-
```typescript
-await client.hris.benefits.list();
+await client.crm.accounts.remoteFieldClassesList();
```
@@ -8144,7 +8145,7 @@ await client.hris.benefits.list();
-
-**request:** `Merge.hris.BenefitsListRequest`
+**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest`
@@ -8152,7 +8153,7 @@ await client.hris.benefits.list();
-
-**requestOptions:** `Benefits.RequestOptions`
+**requestOptions:** `Accounts.RequestOptions`
@@ -8163,7 +8164,9 @@ await client.hris.benefits.list();
-client.hris.benefits.retrieve(id, { ...params }) -> Merge.Benefit
+## Crm AsyncPassthrough
+
+client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
-
@@ -8175,7 +8178,7 @@ await client.hris.benefits.list();
-
-Returns a `Benefit` object with the given `id`.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -8191,7 +8194,10 @@ Returns a `Benefit` object with the given `id`.
-
```typescript
-await client.hris.benefits.retrieve("id");
+await client.crm.asyncPassthrough.create({
+ method: "GET",
+ path: "/scooters",
+});
```
@@ -8207,15 +8213,7 @@ await client.hris.benefits.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.BenefitsRetrieveRequest`
+**request:** `Merge.DataPassthroughRequest`
@@ -8223,7 +8221,7 @@ await client.hris.benefits.retrieve("id");
-
-**requestOptions:** `Benefits.RequestOptions`
+**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -8234,9 +8232,7 @@ await client.hris.benefits.retrieve("id");
-## Hris Companies
-
-client.hris.companies.list({ ...params }) -> Merge.PaginatedCompanyList
+client.crm.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
-
@@ -8248,7 +8244,7 @@ await client.hris.benefits.retrieve("id");
-
-Returns a list of `Company` objects.
+Retrieves data from earlier async-passthrough POST request
@@ -8264,7 +8260,7 @@ Returns a list of `Company` objects.
-
```typescript
-await client.hris.companies.list();
+await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
```
@@ -8280,7 +8276,7 @@ await client.hris.companies.list();
-
-**request:** `Merge.hris.CompaniesListRequest`
+**asyncPassthroughReceiptId:** `string`
@@ -8288,7 +8284,7 @@ await client.hris.companies.list();
-
-**requestOptions:** `Companies.RequestOptions`
+**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -8299,7 +8295,9 @@ await client.hris.companies.list();
-client.hris.companies.retrieve(id, { ...params }) -> Merge.Company
+## Crm AuditTrail
+
+client.crm.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
-
@@ -8311,7 +8309,7 @@ await client.hris.companies.list();
-
-Returns a `Company` object with the given `id`.
+Gets a list of audit trail events.
@@ -8327,7 +8325,7 @@ Returns a `Company` object with the given `id`.
-
```typescript
-await client.hris.companies.retrieve("id");
+await client.crm.auditTrail.list();
```
@@ -8343,15 +8341,7 @@ await client.hris.companies.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.CompaniesRetrieveRequest`
+**request:** `Merge.crm.AuditTrailListRequest`
@@ -8359,7 +8349,7 @@ await client.hris.companies.retrieve("id");
-
-**requestOptions:** `Companies.RequestOptions`
+**requestOptions:** `AuditTrail.RequestOptions`
@@ -8370,9 +8360,9 @@ await client.hris.companies.retrieve("id");
-## Hris Scopes
+## Crm AvailableActions
-client.hris.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
+client.crm.availableActions.retrieve() -> Merge.AvailableActions
-
@@ -8384,7 +8374,7 @@ await client.hris.companies.retrieve("id");
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a list of models and actions available for an account.
@@ -8400,7 +8390,7 @@ Get the default permissions for Merge Common Models and fields across all Linked
-
```typescript
-await client.hris.scopes.defaultScopesRetrieve();
+await client.crm.availableActions.retrieve();
```
@@ -8416,7 +8406,7 @@ await client.hris.scopes.defaultScopesRetrieve();
-
-**requestOptions:** `Scopes.RequestOptions`
+**requestOptions:** `AvailableActions.RequestOptions`
@@ -8427,7 +8417,9 @@ await client.hris.scopes.defaultScopesRetrieve();
-client.hris.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
+## Crm Contacts
+
+client.crm.contacts.list({ ...params }) -> Merge.PaginatedContactList
-
@@ -8439,7 +8431,7 @@ await client.hris.scopes.defaultScopesRetrieve();
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a list of `Contact` objects.
@@ -8455,7 +8447,7 @@ Get all available permissions for Merge Common Models and fields for a single Li
-
```typescript
-await client.hris.scopes.linkedAccountScopesRetrieve();
+await client.crm.contacts.list();
```
@@ -8471,7 +8463,15 @@ await client.hris.scopes.linkedAccountScopesRetrieve();
-
-**requestOptions:** `Scopes.RequestOptions`
+**request:** `Merge.crm.ContactsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
@@ -8482,7 +8482,7 @@ await client.hris.scopes.linkedAccountScopesRetrieve();
-client.hris.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
+client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse
-
@@ -8494,7 +8494,7 @@ await client.hris.scopes.linkedAccountScopesRetrieve();
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+Creates a `Contact` object with the given values.
@@ -8510,32 +8510,8 @@ Update permissions for any Common Model or field for a single Linked Account. An
-
```typescript
-await client.hris.scopes.linkedAccountScopesCreate({
- commonModels: [
- {
- modelName: "Employee",
- modelPermissions: {
- READ: {
- isEnabled: true,
- },
- WRITE: {
- isEnabled: false,
- },
- },
- fieldPermissions: {
- enabledFields: ["avatar", "home_location"],
- disabledFields: ["work_location"],
- },
- },
- {
- modelName: "Benefit",
- modelPermissions: {
- WRITE: {
- isEnabled: false,
- },
- },
- },
- ],
+await client.crm.contacts.create({
+ model: {},
});
```
@@ -8552,7 +8528,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-
-**request:** `Merge.hris.LinkedAccountCommonModelScopeDeserializerRequest`
+**request:** `Merge.crm.CrmContactEndpointRequest`
@@ -8560,7 +8536,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-
-**requestOptions:** `Scopes.RequestOptions`
+**requestOptions:** `Contacts.RequestOptions`
@@ -8571,9 +8547,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-## Hris DeleteAccount
-
-client.hris.deleteAccount.delete() -> void
+client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact
-
@@ -8585,7 +8559,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-
-Delete a linked account.
+Returns a `Contact` object with the given `id`.
@@ -8601,7 +8575,7 @@ Delete a linked account.
-
```typescript
-await client.hris.deleteAccount.delete();
+await client.crm.contacts.retrieve("id");
```
@@ -8617,7 +8591,23 @@ await client.hris.deleteAccount.delete();
-
-**requestOptions:** `DeleteAccount.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.ContactsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
@@ -8628,9 +8618,7 @@ await client.hris.deleteAccount.delete();
-## Hris Dependents
-
-client.hris.dependents.list({ ...params }) -> Merge.PaginatedDependentList
+client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse
-
@@ -8642,7 +8630,7 @@ await client.hris.deleteAccount.delete();
-
-Returns a list of `Dependent` objects.
+Updates a `Contact` object with the given `id`.
@@ -8658,7 +8646,9 @@ Returns a list of `Dependent` objects.
-
```typescript
-await client.hris.dependents.list();
+await client.crm.contacts.partialUpdate("id", {
+ model: {},
+});
```
@@ -8674,7 +8664,7 @@ await client.hris.dependents.list();
-
-**request:** `Merge.hris.DependentsListRequest`
+**id:** `string`
@@ -8682,7 +8672,15 @@ await client.hris.dependents.list();
-
-**requestOptions:** `Dependents.RequestOptions`
+**request:** `Merge.crm.PatchedCrmContactEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
@@ -8693,7 +8691,7 @@ await client.hris.dependents.list();
-client.hris.dependents.retrieve(id, { ...params }) -> Merge.Dependent
+client.crm.contacts.ignoreCreate(modelId, { ...params }) -> void
-
@@ -8705,7 +8703,7 @@ await client.hris.dependents.list();
-
-Returns a `Dependent` object with the given `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.
@@ -8721,7 +8719,9 @@ Returns a `Dependent` object with the given `id`.
-
```typescript
-await client.hris.dependents.retrieve("id");
+await client.crm.contacts.ignoreCreate("model_id", {
+ reason: "GENERAL_CUSTOMER_REQUEST",
+});
```
@@ -8737,7 +8737,7 @@ await client.hris.dependents.retrieve("id");
-
-**id:** `string`
+**modelId:** `string`
@@ -8745,7 +8745,7 @@ await client.hris.dependents.retrieve("id");
-
-**request:** `Merge.hris.DependentsRetrieveRequest`
+**request:** `Merge.IgnoreCommonModelRequest`
@@ -8753,7 +8753,7 @@ await client.hris.dependents.retrieve("id");
-
-**requestOptions:** `Dependents.RequestOptions`
+**requestOptions:** `Contacts.RequestOptions`
@@ -8764,9 +8764,7 @@ await client.hris.dependents.retrieve("id");
-## Hris EmployeePayrollRuns
-
-client.hris.employeePayrollRuns.list({ ...params }) -> Merge.PaginatedEmployeePayrollRunList
+client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -8778,7 +8776,7 @@ await client.hris.dependents.retrieve("id");
-
-Returns a list of `EmployeePayrollRun` objects.
+Returns metadata for `CRMContact` PATCHs.
@@ -8794,7 +8792,7 @@ Returns a list of `EmployeePayrollRun` objects.
-
```typescript
-await client.hris.employeePayrollRuns.list();
+await client.crm.contacts.metaPatchRetrieve("id");
```
@@ -8810,7 +8808,7 @@ await client.hris.employeePayrollRuns.list();
-
-**request:** `Merge.hris.EmployeePayrollRunsListRequest`
+**id:** `string`
@@ -8818,7 +8816,7 @@ await client.hris.employeePayrollRuns.list();
-
-**requestOptions:** `EmployeePayrollRuns.RequestOptions`
+**requestOptions:** `Contacts.RequestOptions`
@@ -8829,7 +8827,7 @@ await client.hris.employeePayrollRuns.list();
-client.hris.employeePayrollRuns.retrieve(id, { ...params }) -> Merge.EmployeePayrollRun
+client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -8841,7 +8839,7 @@ await client.hris.employeePayrollRuns.list();
-
-Returns an `EmployeePayrollRun` object with the given `id`.
+Returns metadata for `CRMContact` POSTs.
@@ -8857,7 +8855,7 @@ Returns an `EmployeePayrollRun` object with the given `id`.
-
```typescript
-await client.hris.employeePayrollRuns.retrieve("id");
+await client.crm.contacts.metaPostRetrieve();
```
@@ -8873,23 +8871,7 @@ await client.hris.employeePayrollRuns.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.EmployeePayrollRunsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `EmployeePayrollRuns.RequestOptions`
+**requestOptions:** `Contacts.RequestOptions`
@@ -8900,9 +8882,7 @@ await client.hris.employeePayrollRuns.retrieve("id");
-## Hris Employees
-
-client.hris.employees.list({ ...params }) -> Merge.PaginatedEmployeeList
+client.crm.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -8914,7 +8894,7 @@ await client.hris.employeePayrollRuns.retrieve("id");
-
-Returns a list of `Employee` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -8930,7 +8910,7 @@ Returns a list of `Employee` objects.
-
```typescript
-await client.hris.employees.list();
+await client.crm.contacts.remoteFieldClassesList();
```
@@ -8946,7 +8926,7 @@ await client.hris.employees.list();
-
-**request:** `Merge.hris.EmployeesListRequest`
+**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest`
@@ -8954,7 +8934,7 @@ await client.hris.employees.list();
-
-**requestOptions:** `Employees.RequestOptions`
+**requestOptions:** `Contacts.RequestOptions`
@@ -8965,7 +8945,9 @@ await client.hris.employees.list();
-client.hris.employees.create({ ...params }) -> Merge.EmployeeResponse
+## Crm CustomObjectClasses
+
+client.crm.customObjectClasses.list({ ...params }) -> Merge.PaginatedCustomObjectClassList
-
@@ -8977,7 +8959,7 @@ await client.hris.employees.list();
-
-Creates an `Employee` object with the given values.
+Returns a list of `CustomObjectClass` objects.
@@ -8993,9 +8975,7 @@ Creates an `Employee` object with the given values.
-
```typescript
-await client.hris.employees.create({
- model: {},
-});
+await client.crm.customObjectClasses.list();
```
@@ -9011,7 +8991,7 @@ await client.hris.employees.create({
-
-**request:** `Merge.hris.EmployeeEndpointRequest`
+**request:** `Merge.crm.CustomObjectClassesListRequest`
@@ -9019,7 +8999,7 @@ await client.hris.employees.create({
-
-**requestOptions:** `Employees.RequestOptions`
+**requestOptions:** `CustomObjectClasses.RequestOptions`
@@ -9030,7 +9010,7 @@ await client.hris.employees.create({
-client.hris.employees.retrieve(id, { ...params }) -> Merge.Employee
+client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass
-
@@ -9042,7 +9022,7 @@ await client.hris.employees.create({
-
-Returns an `Employee` object with the given `id`.
+Returns a `CustomObjectClass` object with the given `id`.
@@ -9058,7 +9038,7 @@ Returns an `Employee` object with the given `id`.
-
```typescript
-await client.hris.employees.retrieve("id");
+await client.crm.customObjectClasses.retrieve("id");
```
@@ -9082,7 +9062,7 @@ await client.hris.employees.retrieve("id");
-
-**request:** `Merge.hris.EmployeesRetrieveRequest`
+**request:** `Merge.crm.CustomObjectClassesRetrieveRequest`
@@ -9090,7 +9070,7 @@ await client.hris.employees.retrieve("id");
-
-**requestOptions:** `Employees.RequestOptions`
+**requestOptions:** `CustomObjectClasses.RequestOptions`
@@ -9101,7 +9081,9 @@ await client.hris.employees.retrieve("id");
-client.hris.employees.ignoreCreate(modelId, { ...params }) -> void
+## Crm AssociationTypes
+
+client.crm.associationTypes.customObjectClassesAssociationTypesList(customObjectClassId, { ...params }) -> Merge.PaginatedAssociationTypeList
-
@@ -9113,7 +9095,7 @@ await client.hris.employees.retrieve("id");
-
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+Returns a list of `AssociationType` objects.
@@ -9129,9 +9111,7 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
-
```typescript
-await client.hris.employees.ignoreCreate("model_id", {
- reason: "GENERAL_CUSTOMER_REQUEST",
-});
+await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id");
```
@@ -9147,7 +9127,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-
-**modelId:** `string`
+**customObjectClassId:** `string`
@@ -9155,7 +9135,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-
-**request:** `Merge.hris.IgnoreCommonModelRequest`
+**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest`
@@ -9163,7 +9143,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-
-**requestOptions:** `Employees.RequestOptions`
+**requestOptions:** `AssociationTypes.RequestOptions`
@@ -9174,7 +9154,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-client.hris.employees.metaPostRetrieve() -> Merge.MetaResponse
+client.crm.associationTypes.customObjectClassesAssociationTypesCreate(customObjectClassId, { ...params }) -> Merge.CrmAssociationTypeResponse
-
@@ -9186,7 +9166,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-
-Returns metadata for `Employee` POSTs.
+Creates an `AssociationType` object with the given values.
@@ -9202,7 +9182,21 @@ Returns metadata for `Employee` POSTs.
-
```typescript
-await client.hris.employees.metaPostRetrieve();
+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",
+ },
+});
```
@@ -9218,7 +9212,23 @@ await client.hris.employees.metaPostRetrieve();
-
-**requestOptions:** `Employees.RequestOptions`
+**customObjectClassId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CrmAssociationTypeEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AssociationTypes.RequestOptions`
@@ -9229,9 +9239,7 @@ await client.hris.employees.metaPostRetrieve();
-## Hris EmployerBenefits
-
-client.hris.employerBenefits.list({ ...params }) -> Merge.PaginatedEmployerBenefitList
+client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(customObjectClassId, id, { ...params }) -> Merge.AssociationType
-
@@ -9243,7 +9251,7 @@ await client.hris.employees.metaPostRetrieve();
-
-Returns a list of `EmployerBenefit` objects.
+Returns an `AssociationType` object with the given `id`.
@@ -9259,7 +9267,7 @@ Returns a list of `EmployerBenefit` objects.
-
```typescript
-await client.hris.employerBenefits.list();
+await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id");
```
@@ -9275,7 +9283,7 @@ await client.hris.employerBenefits.list();
-
-**request:** `Merge.hris.EmployerBenefitsListRequest`
+**customObjectClassId:** `string`
@@ -9283,7 +9291,23 @@ await client.hris.employerBenefits.list();
-
-**requestOptions:** `EmployerBenefits.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AssociationTypes.RequestOptions`
@@ -9294,7 +9318,7 @@ await client.hris.employerBenefits.list();
-client.hris.employerBenefits.retrieve(id, { ...params }) -> Merge.EmployerBenefit
+client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
-
@@ -9306,7 +9330,7 @@ await client.hris.employerBenefits.list();
-
-Returns an `EmployerBenefit` object with the given `id`.
+Returns metadata for `CRMAssociationType` POSTs.
@@ -9322,7 +9346,7 @@ Returns an `EmployerBenefit` object with the given `id`.
-
```typescript
-await client.hris.employerBenefits.retrieve("id");
+await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id");
```
@@ -9338,15 +9362,7 @@ await client.hris.employerBenefits.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.EmployerBenefitsRetrieveRequest`
+**customObjectClassId:** `string`
@@ -9354,7 +9370,7 @@ await client.hris.employerBenefits.retrieve("id");
-
-**requestOptions:** `EmployerBenefits.RequestOptions`
+**requestOptions:** `AssociationTypes.RequestOptions`
@@ -9365,9 +9381,9 @@ await client.hris.employerBenefits.retrieve("id");
-## Hris Employments
+## Crm CustomObjects
-client.hris.employments.list({ ...params }) -> Merge.PaginatedEmploymentList
+client.crm.customObjects.customObjectClassesCustomObjectsList(customObjectClassId, { ...params }) -> Merge.PaginatedCustomObjectList
-
@@ -9379,7 +9395,7 @@ await client.hris.employerBenefits.retrieve("id");
-
-Returns a list of `Employment` objects.
+Returns a list of `CustomObject` objects.
@@ -9395,7 +9411,7 @@ Returns a list of `Employment` objects.
-
```typescript
-await client.hris.employments.list();
+await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id");
```
@@ -9411,7 +9427,7 @@ await client.hris.employments.list();
-
-**request:** `Merge.hris.EmploymentsListRequest`
+**customObjectClassId:** `string`
@@ -9419,7 +9435,15 @@ await client.hris.employments.list();
-
-**requestOptions:** `Employments.RequestOptions`
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjects.RequestOptions`
@@ -9430,7 +9454,7 @@ await client.hris.employments.list();
-client.hris.employments.retrieve(id, { ...params }) -> Merge.Employment
+client.crm.customObjects.customObjectClassesCustomObjectsCreate(customObjectClassId, { ...params }) -> Merge.CrmCustomObjectResponse
-
@@ -9442,7 +9466,7 @@ await client.hris.employments.list();
-
-Returns an `Employment` object with the given `id`.
+Creates a `CustomObject` object with the given values.
@@ -9458,7 +9482,13 @@ Returns an `Employment` object with the given `id`.
-
```typescript
-await client.hris.employments.retrieve("id");
+await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", {
+ model: {
+ fields: {
+ test_field: "hello",
+ },
+ },
+});
```
@@ -9474,7 +9504,7 @@ await client.hris.employments.retrieve("id");
-
-**id:** `string`
+**customObjectClassId:** `string`
@@ -9482,7 +9512,7 @@ await client.hris.employments.retrieve("id");
-
-**request:** `Merge.hris.EmploymentsRetrieveRequest`
+**request:** `Merge.crm.CrmCustomObjectEndpointRequest`
@@ -9490,7 +9520,7 @@ await client.hris.employments.retrieve("id");
-
-**requestOptions:** `Employments.RequestOptions`
+**requestOptions:** `CustomObjects.RequestOptions`
@@ -9501,9 +9531,7 @@ await client.hris.employments.retrieve("id");
-## Hris FieldMapping
-
-client.hris.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
+client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(customObjectClassId, id, { ...params }) -> Merge.CustomObject
-
@@ -9515,7 +9543,7 @@ await client.hris.employments.retrieve("id");
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns a `CustomObject` object with the given `id`.
@@ -9531,7 +9559,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
-
```typescript
-await client.hris.fieldMapping.fieldMappingsRetrieve();
+await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id");
```
@@ -9547,7 +9575,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve();
-
-**request:** `Merge.hris.FieldMappingsRetrieveRequest`
+**customObjectClassId:** `string`
@@ -9555,7 +9583,23 @@ await client.hris.fieldMapping.fieldMappingsRetrieve();
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjects.RequestOptions`
@@ -9566,7 +9610,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve();
-client.hris.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
+client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
-
@@ -9578,7 +9622,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve();
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns metadata for `CRMCustomObject` POSTs.
@@ -9594,14 +9638,7 @@ Create new Field Mappings that will be available after the next scheduled sync.
-
```typescript
-await client.hris.fieldMapping.fieldMappingsCreate({
- targetFieldName: "example_target_field_name",
- targetFieldDescription: "this is a example description of the target field",
- remoteFieldTraversalPath: ["example_remote_field"],
- remoteMethod: "GET",
- remoteUrlPath: "/example-url-path",
- commonModelName: "ExampleCommonModel",
-});
+await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id");
```
@@ -9617,7 +9654,7 @@ await client.hris.fieldMapping.fieldMappingsCreate({
-
-**request:** `Merge.hris.CreateFieldMappingRequest`
+**customObjectClassId:** `string`
@@ -9625,7 +9662,7 @@ await client.hris.fieldMapping.fieldMappingsCreate({
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**requestOptions:** `CustomObjects.RequestOptions`
@@ -9636,7 +9673,7 @@ await client.hris.fieldMapping.fieldMappingsCreate({
-client.hris.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
+client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -9648,7 +9685,7 @@ await client.hris.fieldMapping.fieldMappingsCreate({
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `RemoteFieldClass` objects.
@@ -9664,7 +9701,7 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
-
```typescript
-await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList();
```
@@ -9680,7 +9717,7 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**fieldMappingId:** `string`
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest`
@@ -9688,7 +9725,7 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**requestOptions:** `CustomObjects.RequestOptions`
@@ -9699,7 +9736,9 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-client.hris.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
+## Crm Associations
+
+client.crm.associations.customObjectClassesCustomObjectsAssociationsList(customObjectClassId, objectId, { ...params }) -> Merge.PaginatedAssociationList
-
@@ -9711,7 +9750,7 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `Association` objects.
@@ -9727,7 +9766,7 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
-
```typescript
-await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id");
```
@@ -9743,7 +9782,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-**fieldMappingId:** `string`
+**customObjectClassId:** `string`
@@ -9751,7 +9790,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-**request:** `Merge.hris.PatchedEditFieldMappingRequest`
+**objectId:** `string`
@@ -9759,7 +9798,15 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Associations.RequestOptions`
@@ -9770,7 +9817,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-client.hris.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
+client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(associationTypeId, sourceClassId, sourceObjectId, targetClassId, targetObjectId, { ...params }) -> Merge.Association
-
@@ -9782,7 +9829,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -9798,7 +9845,13 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
-
```typescript
-await client.hris.fieldMapping.remoteFieldsRetrieve();
+await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(
+ "association_type_id",
+ "source_class_id",
+ "source_object_id",
+ "target_class_id",
+ "target_object_id",
+);
```
@@ -9814,7 +9867,7 @@ await client.hris.fieldMapping.remoteFieldsRetrieve();
-
-**request:** `Merge.hris.RemoteFieldsRetrieveRequest`
+**associationTypeId:** `string`
@@ -9822,62 +9875,47 @@ await client.hris.fieldMapping.remoteFieldsRetrieve();
-
-**requestOptions:** `FieldMapping.RequestOptions`
-
-
-
-
-
+**sourceClassId:** `string`
-
-client.hris.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
-
-#### 📝 Description
+**sourceObjectId:** `string`
-
--
+
+
-
-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/).
+**targetClassId:** `string`
-
-
-
-#### 🔌 Usage
-
-
--
-
-```typescript
-await client.hris.fieldMapping.targetFieldsRetrieve();
-```
+**targetObjectId:** `string`
-
-
-#### ⚙️ Parameters
-
-
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest`
+
+
+
+
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**requestOptions:** `Associations.RequestOptions`
@@ -9888,9 +9926,9 @@ await client.hris.fieldMapping.targetFieldsRetrieve();
-## Hris GenerateKey
+## Crm Scopes
-client.hris.generateKey.create({ ...params }) -> Merge.RemoteKey
+client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
-
@@ -9902,7 +9940,7 @@ await client.hris.fieldMapping.targetFieldsRetrieve();
-
-Create a remote key.
+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).
@@ -9918,9 +9956,7 @@ Create a remote key.
-
```typescript
-await client.hris.generateKey.create({
- name: "Remote Deployment Key 1",
-});
+await client.crm.scopes.defaultScopesRetrieve();
```
@@ -9936,15 +9972,7 @@ await client.hris.generateKey.create({
-
-**request:** `Merge.hris.GenerateRemoteKeyRequest`
-
-
-
-
-
--
-
-**requestOptions:** `GenerateKey.RequestOptions`
+**requestOptions:** `Scopes.RequestOptions`
@@ -9955,9 +9983,7 @@ await client.hris.generateKey.create({
-## Hris Groups
-
-client.hris.groups.list({ ...params }) -> Merge.PaginatedGroupList
+client.crm.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
-
@@ -9969,7 +9995,7 @@ await client.hris.generateKey.create({
-
-Returns a list of `Group` objects.
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -9985,7 +10011,7 @@ Returns a list of `Group` objects.
-
```typescript
-await client.hris.groups.list();
+await client.crm.scopes.linkedAccountScopesRetrieve();
```
@@ -10001,15 +10027,7 @@ await client.hris.groups.list();
-
-**request:** `Merge.hris.GroupsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Groups.RequestOptions`
+**requestOptions:** `Scopes.RequestOptions`
@@ -10020,7 +10038,7 @@ await client.hris.groups.list();
-client.hris.groups.retrieve(id, { ...params }) -> Merge.Group
+client.crm.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
-
@@ -10032,7 +10050,7 @@ await client.hris.groups.list();
-
-Returns a `Group` object with the given `id`.
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -10048,7 +10066,33 @@ Returns a `Group` object with the given `id`.
-
```typescript
-await client.hris.groups.retrieve("id");
+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,
+ },
+ },
+ },
+ ],
+});
```
@@ -10064,15 +10108,7 @@ await client.hris.groups.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.GroupsRetrieveRequest`
+**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -10080,7 +10116,7 @@ await client.hris.groups.retrieve("id");
-
-**requestOptions:** `Groups.RequestOptions`
+**requestOptions:** `Scopes.RequestOptions`
@@ -10091,9 +10127,9 @@ await client.hris.groups.retrieve("id");
-## Hris Issues
+## Crm DeleteAccount
-client.hris.issues.list({ ...params }) -> Merge.PaginatedIssueList
+client.crm.deleteAccount.delete() -> void
-
@@ -10105,7 +10141,7 @@ await client.hris.groups.retrieve("id");
-
-Gets all issues for Organization.
+Delete a linked account.
@@ -10121,7 +10157,7 @@ Gets all issues for Organization.
-
```typescript
-await client.hris.issues.list();
+await client.crm.deleteAccount.delete();
```
@@ -10137,15 +10173,7 @@ await client.hris.issues.list();
-
-**request:** `Merge.hris.IssuesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Issues.RequestOptions`
+**requestOptions:** `DeleteAccount.RequestOptions`
@@ -10156,7 +10184,9 @@ await client.hris.issues.list();
-client.hris.issues.retrieve(id) -> Merge.Issue
+## Crm EngagementTypes
+
+client.crm.engagementTypes.list({ ...params }) -> Merge.PaginatedEngagementTypeList
-
@@ -10168,7 +10198,7 @@ await client.hris.issues.list();
-
-Get a specific issue.
+Returns a list of `EngagementType` objects.
@@ -10184,7 +10214,7 @@ Get a specific issue.
-
```typescript
-await client.hris.issues.retrieve("id");
+await client.crm.engagementTypes.list();
```
@@ -10200,7 +10230,7 @@ await client.hris.issues.retrieve("id");
-
-**id:** `string`
+**request:** `Merge.crm.EngagementTypesListRequest`
@@ -10208,7 +10238,7 @@ await client.hris.issues.retrieve("id");
-
-**requestOptions:** `Issues.RequestOptions`
+**requestOptions:** `EngagementTypes.RequestOptions`
@@ -10219,9 +10249,7 @@ await client.hris.issues.retrieve("id");
-## Hris LinkToken
-
-client.hris.linkToken.create({ ...params }) -> Merge.LinkToken
+client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType
-
@@ -10233,7 +10261,7 @@ await client.hris.issues.retrieve("id");
-
-Creates a link token to be used when linking a new end user.
+Returns an `EngagementType` object with the given `id`.
@@ -10249,12 +10277,7 @@ Creates a link token to be used when linking a new end user.
-
```typescript
-await client.hris.linkToken.create({
- endUserEmailAddress: "example@gmail.com",
- endUserOrganizationName: "Test Organization",
- endUserOriginId: "12345",
- categories: ["hris", "ats"],
-});
+await client.crm.engagementTypes.retrieve("id");
```
@@ -10270,7 +10293,7 @@ await client.hris.linkToken.create({
-
-**request:** `Merge.hris.EndUserDetailsRequest`
+**id:** `string`
@@ -10278,7 +10301,15 @@ await client.hris.linkToken.create({
-
-**requestOptions:** `LinkToken.RequestOptions`
+**request:** `Merge.crm.EngagementTypesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EngagementTypes.RequestOptions`
@@ -10289,9 +10320,7 @@ await client.hris.linkToken.create({
-## Hris LinkedAccounts
-
-client.hris.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -10303,7 +10332,7 @@ await client.hris.linkToken.create({
-
-List linked accounts for your organization.
+Returns a list of `RemoteFieldClass` objects.
@@ -10319,7 +10348,7 @@ List linked accounts for your organization.
-
```typescript
-await client.hris.linkedAccounts.list();
+await client.crm.engagementTypes.remoteFieldClassesList();
```
@@ -10335,7 +10364,7 @@ await client.hris.linkedAccounts.list();
-
-**request:** `Merge.hris.LinkedAccountsListRequest`
+**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest`
@@ -10343,7 +10372,7 @@ await client.hris.linkedAccounts.list();
-
-**requestOptions:** `LinkedAccounts.RequestOptions`
+**requestOptions:** `EngagementTypes.RequestOptions`
@@ -10354,9 +10383,9 @@ await client.hris.linkedAccounts.list();
-## Hris Locations
+## Crm Engagements
-client.hris.locations.list({ ...params }) -> Merge.PaginatedLocationList
+client.crm.engagements.list({ ...params }) -> Merge.PaginatedEngagementList
-
@@ -10368,7 +10397,7 @@ await client.hris.linkedAccounts.list();
-
-Returns a list of `Location` objects.
+Returns a list of `Engagement` objects.
@@ -10384,7 +10413,7 @@ Returns a list of `Location` objects.
-
```typescript
-await client.hris.locations.list();
+await client.crm.engagements.list();
```
@@ -10400,7 +10429,7 @@ await client.hris.locations.list();
-
-**request:** `Merge.hris.LocationsListRequest`
+**request:** `Merge.crm.EngagementsListRequest`
@@ -10408,7 +10437,7 @@ await client.hris.locations.list();
-
-**requestOptions:** `Locations.RequestOptions`
+**requestOptions:** `Engagements.RequestOptions`
@@ -10419,7 +10448,7 @@ await client.hris.locations.list();
-client.hris.locations.retrieve(id, { ...params }) -> Merge.Location
+client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse
-
@@ -10431,7 +10460,7 @@ await client.hris.locations.list();
-
-Returns a `Location` object with the given `id`.
+Creates an `Engagement` object with the given values.
@@ -10447,7 +10476,9 @@ Returns a `Location` object with the given `id`.
-
```typescript
-await client.hris.locations.retrieve("id");
+await client.crm.engagements.create({
+ model: {},
+});
```
@@ -10463,15 +10494,7 @@ await client.hris.locations.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.LocationsRetrieveRequest`
+**request:** `Merge.crm.EngagementEndpointRequest`
@@ -10479,7 +10502,7 @@ await client.hris.locations.retrieve("id");
-
-**requestOptions:** `Locations.RequestOptions`
+**requestOptions:** `Engagements.RequestOptions`
@@ -10490,9 +10513,7 @@ await client.hris.locations.retrieve("id");
-## Hris Passthrough
-
-client.hris.passthrough.create({ ...params }) -> Merge.RemoteResponse
+client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement
-
@@ -10504,7 +10525,7 @@ await client.hris.locations.retrieve("id");
-
-Pull data from an endpoint not currently supported by Merge.
+Returns an `Engagement` object with the given `id`.
@@ -10520,10 +10541,7 @@ Pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.hris.passthrough.create({
- method: "GET",
- path: "/scooters",
-});
+await client.crm.engagements.retrieve("id");
```
@@ -10539,7 +10557,7 @@ await client.hris.passthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
+**id:** `string`
@@ -10547,7 +10565,15 @@ await client.hris.passthrough.create({
-
-**requestOptions:** `Passthrough.RequestOptions`
+**request:** `Merge.crm.EngagementsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Engagements.RequestOptions`
@@ -10558,9 +10584,7 @@ await client.hris.passthrough.create({
-## Hris PayGroups
-
-client.hris.payGroups.list({ ...params }) -> Merge.PaginatedPayGroupList
+client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse
-
@@ -10572,7 +10596,7 @@ await client.hris.passthrough.create({
-
-Returns a list of `PayGroup` objects.
+Updates an `Engagement` object with the given `id`.
@@ -10588,7 +10612,9 @@ Returns a list of `PayGroup` objects.
-
```typescript
-await client.hris.payGroups.list();
+await client.crm.engagements.partialUpdate("id", {
+ model: {},
+});
```
@@ -10604,7 +10630,7 @@ await client.hris.payGroups.list();
-
-**request:** `Merge.hris.PayGroupsListRequest`
+**id:** `string`
@@ -10612,7 +10638,15 @@ await client.hris.payGroups.list();
-
-**requestOptions:** `PayGroups.RequestOptions`
+**request:** `Merge.crm.PatchedEngagementEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Engagements.RequestOptions`
@@ -10623,7 +10657,7 @@ await client.hris.payGroups.list();
-client.hris.payGroups.retrieve(id, { ...params }) -> Merge.PayGroup
+client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -10635,7 +10669,7 @@ await client.hris.payGroups.list();
-
-Returns a `PayGroup` object with the given `id`.
+Returns metadata for `Engagement` PATCHs.
@@ -10651,7 +10685,7 @@ Returns a `PayGroup` object with the given `id`.
-
```typescript
-await client.hris.payGroups.retrieve("id");
+await client.crm.engagements.metaPatchRetrieve("id");
```
@@ -10675,15 +10709,7 @@ await client.hris.payGroups.retrieve("id");
-
-**request:** `Merge.hris.PayGroupsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `PayGroups.RequestOptions`
+**requestOptions:** `Engagements.RequestOptions`
@@ -10694,9 +10720,7 @@ await client.hris.payGroups.retrieve("id");
-## Hris PayrollRuns
-
-client.hris.payrollRuns.list({ ...params }) -> Merge.PaginatedPayrollRunList
+client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -10708,7 +10732,7 @@ await client.hris.payGroups.retrieve("id");
-
-Returns a list of `PayrollRun` objects.
+Returns metadata for `Engagement` POSTs.
@@ -10724,7 +10748,7 @@ Returns a list of `PayrollRun` objects.
-
```typescript
-await client.hris.payrollRuns.list();
+await client.crm.engagements.metaPostRetrieve();
```
@@ -10740,15 +10764,7 @@ await client.hris.payrollRuns.list();
-
-**request:** `Merge.hris.PayrollRunsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `PayrollRuns.RequestOptions`
+**requestOptions:** `Engagements.RequestOptions`
@@ -10759,7 +10775,7 @@ await client.hris.payrollRuns.list();
-client.hris.payrollRuns.retrieve(id, { ...params }) -> Merge.PayrollRun
+client.crm.engagements.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -10771,7 +10787,7 @@ await client.hris.payrollRuns.list();
-
-Returns a `PayrollRun` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -10787,7 +10803,7 @@ Returns a `PayrollRun` object with the given `id`.
-
```typescript
-await client.hris.payrollRuns.retrieve("id");
+await client.crm.engagements.remoteFieldClassesList();
```
@@ -10803,15 +10819,7 @@ await client.hris.payrollRuns.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.PayrollRunsRetrieveRequest`
+**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest`
@@ -10819,7 +10827,7 @@ await client.hris.payrollRuns.retrieve("id");
-
-**requestOptions:** `PayrollRuns.RequestOptions`
+**requestOptions:** `Engagements.RequestOptions`
@@ -10830,9 +10838,9 @@ await client.hris.payrollRuns.retrieve("id");
-## Hris RegenerateKey
+## Crm FieldMapping
-client.hris.regenerateKey.create({ ...params }) -> Merge.RemoteKey
+client.crm.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
-
@@ -10844,7 +10852,7 @@ await client.hris.payrollRuns.retrieve("id");
-
-Exchange remote keys.
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -10860,9 +10868,7 @@ Exchange remote keys.
-
```typescript
-await client.hris.regenerateKey.create({
- name: "Remote Deployment Key 1",
-});
+await client.crm.fieldMapping.fieldMappingsRetrieve();
```
@@ -10878,7 +10884,7 @@ await client.hris.regenerateKey.create({
-
-**request:** `Merge.hris.RemoteKeyForRegenerationRequest`
+**request:** `Merge.crm.FieldMappingsRetrieveRequest`
@@ -10886,7 +10892,7 @@ await client.hris.regenerateKey.create({
-
-**requestOptions:** `RegenerateKey.RequestOptions`
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -10897,9 +10903,7 @@ await client.hris.regenerateKey.create({
-## Hris SyncStatus
-
-client.hris.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+client.crm.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
-
@@ -10911,7 +10915,7 @@ await client.hris.regenerateKey.create({
-
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+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.
@@ -10927,7 +10931,14 @@ Get sync status for the current sync and the most recently finished sync. `last_
-
```typescript
-await client.hris.syncStatus.list();
+await client.crm.fieldMapping.fieldMappingsCreate({
+ targetFieldName: "example_target_field_name",
+ targetFieldDescription: "this is a example description of the target field",
+ remoteFieldTraversalPath: ["example_remote_field"],
+ remoteMethod: "GET",
+ remoteUrlPath: "/example-url-path",
+ commonModelName: "ExampleCommonModel",
+});
```
@@ -10943,7 +10954,7 @@ await client.hris.syncStatus.list();
-
-**request:** `Merge.hris.SyncStatusListRequest`
+**request:** `Merge.crm.CreateFieldMappingRequest`
@@ -10951,7 +10962,7 @@ await client.hris.syncStatus.list();
-
-**requestOptions:** `SyncStatus.RequestOptions`
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -10962,9 +10973,7 @@ await client.hris.syncStatus.list();
-## Hris ForceResync
-
-client.hris.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+client.crm.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
-
@@ -10976,7 +10985,7 @@ await client.hris.syncStatus.list();
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+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.
@@ -10992,7 +11001,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
-
```typescript
-await client.hris.forceResync.syncStatusResyncCreate();
+await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
```
@@ -11008,7 +11017,15 @@ await client.hris.forceResync.syncStatusResyncCreate();
-
-**requestOptions:** `ForceResync.RequestOptions`
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -11019,9 +11036,7 @@ await client.hris.forceResync.syncStatusResyncCreate();
-## Hris Teams
-
-client.hris.teams.list({ ...params }) -> Merge.PaginatedTeamList
+client.crm.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
-
@@ -11033,7 +11048,7 @@ await client.hris.forceResync.syncStatusResyncCreate();
-
-Returns a list of `Team` 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.
@@ -11049,7 +11064,7 @@ Returns a list of `Team` objects.
-
```typescript
-await client.hris.teams.list();
+await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
```
@@ -11065,7 +11080,7 @@ await client.hris.teams.list();
-
-**request:** `Merge.hris.TeamsListRequest`
+**fieldMappingId:** `string`
@@ -11073,7 +11088,15 @@ await client.hris.teams.list();
-
-**requestOptions:** `Teams.RequestOptions`
+**request:** `Merge.crm.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -11084,7 +11107,7 @@ await client.hris.teams.list();
-client.hris.teams.retrieve(id, { ...params }) -> Merge.Team
+client.crm.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
-
@@ -11096,7 +11119,7 @@ await client.hris.teams.list();
-
-Returns a `Team` object with the given `id`.
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -11112,7 +11135,7 @@ Returns a `Team` object with the given `id`.
-
```typescript
-await client.hris.teams.retrieve("id");
+await client.crm.fieldMapping.remoteFieldsRetrieve();
```
@@ -11128,15 +11151,7 @@ await client.hris.teams.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.TeamsRetrieveRequest`
+**request:** `Merge.crm.RemoteFieldsRetrieveRequest`
@@ -11144,7 +11159,7 @@ await client.hris.teams.retrieve("id");
-
-**requestOptions:** `Teams.RequestOptions`
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -11155,9 +11170,7 @@ await client.hris.teams.retrieve("id");
-## Hris TimeOff
-
-client.hris.timeOff.list({ ...params }) -> Merge.PaginatedTimeOffList
+client.crm.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
-
@@ -11169,7 +11182,7 @@ await client.hris.teams.retrieve("id");
-
-Returns a list of `TimeOff` objects.
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -11185,7 +11198,7 @@ Returns a list of `TimeOff` objects.
-
```typescript
-await client.hris.timeOff.list();
+await client.crm.fieldMapping.targetFieldsRetrieve();
```
@@ -11201,15 +11214,7 @@ await client.hris.timeOff.list();
-
-**request:** `Merge.hris.TimeOffListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `TimeOff.RequestOptions`
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -11220,7 +11225,9 @@ await client.hris.timeOff.list();
-client.hris.timeOff.create({ ...params }) -> Merge.TimeOffResponse
+## Crm GenerateKey
+
+client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey
-
@@ -11232,7 +11239,7 @@ await client.hris.timeOff.list();
-
-Creates a `TimeOff` object with the given values.
+Create a remote key.
@@ -11248,8 +11255,8 @@ Creates a `TimeOff` object with the given values.
-
```typescript
-await client.hris.timeOff.create({
- model: {},
+await client.crm.generateKey.create({
+ name: "Remote Deployment Key 1",
});
```
@@ -11266,7 +11273,7 @@ await client.hris.timeOff.create({
-
-**request:** `Merge.hris.TimeOffEndpointRequest`
+**request:** `Merge.crm.GenerateRemoteKeyRequest`
@@ -11274,7 +11281,7 @@ await client.hris.timeOff.create({
-
-**requestOptions:** `TimeOff.RequestOptions`
+**requestOptions:** `GenerateKey.RequestOptions`
@@ -11285,7 +11292,9 @@ await client.hris.timeOff.create({
-client.hris.timeOff.retrieve(id, { ...params }) -> Merge.TimeOff
+## Crm Issues
+
+client.crm.issues.list({ ...params }) -> Merge.PaginatedIssueList
-
@@ -11297,7 +11306,7 @@ await client.hris.timeOff.create({
-
-Returns a `TimeOff` object with the given `id`.
+Gets all issues for Organization.
@@ -11313,7 +11322,7 @@ Returns a `TimeOff` object with the given `id`.
-
```typescript
-await client.hris.timeOff.retrieve("id");
+await client.crm.issues.list();
```
@@ -11329,15 +11338,7 @@ await client.hris.timeOff.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.TimeOffRetrieveRequest`
+**request:** `Merge.crm.IssuesListRequest`
@@ -11345,7 +11346,7 @@ await client.hris.timeOff.retrieve("id");
-
-**requestOptions:** `TimeOff.RequestOptions`
+**requestOptions:** `Issues.RequestOptions`
@@ -11356,7 +11357,7 @@ await client.hris.timeOff.retrieve("id");
-client.hris.timeOff.metaPostRetrieve() -> Merge.MetaResponse
+client.crm.issues.retrieve(id) -> Merge.Issue
-
@@ -11368,7 +11369,7 @@ await client.hris.timeOff.retrieve("id");
-
-Returns metadata for `TimeOff` POSTs.
+Get a specific issue.
@@ -11384,7 +11385,7 @@ Returns metadata for `TimeOff` POSTs.
-
```typescript
-await client.hris.timeOff.metaPostRetrieve();
+await client.crm.issues.retrieve("id");
```
@@ -11400,7 +11401,15 @@ await client.hris.timeOff.metaPostRetrieve();
-
-**requestOptions:** `TimeOff.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Issues.RequestOptions`
@@ -11411,9 +11420,9 @@ await client.hris.timeOff.metaPostRetrieve();
-## Hris TimeOffBalances
+## Crm Leads
-client.hris.timeOffBalances.list({ ...params }) -> Merge.PaginatedTimeOffBalanceList
+client.crm.leads.list({ ...params }) -> Merge.PaginatedLeadList
-
@@ -11425,7 +11434,7 @@ await client.hris.timeOff.metaPostRetrieve();
-
-Returns a list of `TimeOffBalance` objects.
+Returns a list of `Lead` objects.
@@ -11441,7 +11450,7 @@ Returns a list of `TimeOffBalance` objects.
-
```typescript
-await client.hris.timeOffBalances.list();
+await client.crm.leads.list();
```
@@ -11457,7 +11466,7 @@ await client.hris.timeOffBalances.list();
-
-**request:** `Merge.hris.TimeOffBalancesListRequest`
+**request:** `Merge.crm.LeadsListRequest`
@@ -11465,7 +11474,7 @@ await client.hris.timeOffBalances.list();
-
-**requestOptions:** `TimeOffBalances.RequestOptions`
+**requestOptions:** `Leads.RequestOptions`
@@ -11476,7 +11485,7 @@ await client.hris.timeOffBalances.list();
-client.hris.timeOffBalances.retrieve(id, { ...params }) -> Merge.TimeOffBalance
+client.crm.leads.create({ ...params }) -> Merge.LeadResponse
-
@@ -11488,7 +11497,7 @@ await client.hris.timeOffBalances.list();
-
-Returns a `TimeOffBalance` object with the given `id`.
+Creates a `Lead` object with the given values.
@@ -11504,7 +11513,9 @@ Returns a `TimeOffBalance` object with the given `id`.
-
```typescript
-await client.hris.timeOffBalances.retrieve("id");
+await client.crm.leads.create({
+ model: {},
+});
```
@@ -11520,15 +11531,7 @@ await client.hris.timeOffBalances.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.TimeOffBalancesRetrieveRequest`
+**request:** `Merge.crm.LeadEndpointRequest`
@@ -11536,7 +11539,7 @@ await client.hris.timeOffBalances.retrieve("id");
-
-**requestOptions:** `TimeOffBalances.RequestOptions`
+**requestOptions:** `Leads.RequestOptions`
@@ -11547,9 +11550,7 @@ await client.hris.timeOffBalances.retrieve("id");
-## Hris TimesheetEntries
-
-client.hris.timesheetEntries.list({ ...params }) -> Merge.PaginatedTimesheetEntryList
+client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead
-
@@ -11561,7 +11562,7 @@ await client.hris.timeOffBalances.retrieve("id");
-
-Returns a list of `TimesheetEntry` objects.
+Returns a `Lead` object with the given `id`.
@@ -11577,7 +11578,7 @@ Returns a list of `TimesheetEntry` objects.
-
```typescript
-await client.hris.timesheetEntries.list();
+await client.crm.leads.retrieve("id");
```
@@ -11593,7 +11594,7 @@ await client.hris.timesheetEntries.list();
-
-**request:** `Merge.hris.TimesheetEntriesListRequest`
+**id:** `string`
@@ -11601,7 +11602,15 @@ await client.hris.timesheetEntries.list();
-
-**requestOptions:** `TimesheetEntries.RequestOptions`
+**request:** `Merge.crm.LeadsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Leads.RequestOptions`
@@ -11612,7 +11621,7 @@ await client.hris.timesheetEntries.list();
-client.hris.timesheetEntries.create({ ...params }) -> Merge.TimesheetEntryResponse
+client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -11624,7 +11633,7 @@ await client.hris.timesheetEntries.list();
-
-Creates a `TimesheetEntry` object with the given values.
+Returns metadata for `Lead` POSTs.
@@ -11640,9 +11649,7 @@ Creates a `TimesheetEntry` object with the given values.
-
```typescript
-await client.hris.timesheetEntries.create({
- model: {},
-});
+await client.crm.leads.metaPostRetrieve();
```
@@ -11658,15 +11665,7 @@ await client.hris.timesheetEntries.create({
-
-**request:** `Merge.hris.TimesheetEntryEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `TimesheetEntries.RequestOptions`
+**requestOptions:** `Leads.RequestOptions`
@@ -11677,7 +11676,7 @@ await client.hris.timesheetEntries.create({
-client.hris.timesheetEntries.retrieve(id, { ...params }) -> Merge.TimesheetEntry
+client.crm.leads.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -11689,7 +11688,7 @@ await client.hris.timesheetEntries.create({
-
-Returns a `TimesheetEntry` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -11705,7 +11704,7 @@ Returns a `TimesheetEntry` object with the given `id`.
-
```typescript
-await client.hris.timesheetEntries.retrieve("id");
+await client.crm.leads.remoteFieldClassesList();
```
@@ -11721,15 +11720,7 @@ await client.hris.timesheetEntries.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.TimesheetEntriesRetrieveRequest`
+**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest`
@@ -11737,7 +11728,7 @@ await client.hris.timesheetEntries.retrieve("id");
-
-**requestOptions:** `TimesheetEntries.RequestOptions`
+**requestOptions:** `Leads.RequestOptions`
@@ -11748,7 +11739,9 @@ await client.hris.timesheetEntries.retrieve("id");
-client.hris.timesheetEntries.metaPostRetrieve() -> Merge.MetaResponse
+## Crm LinkToken
+
+client.crm.linkToken.create({ ...params }) -> Merge.LinkToken
-
@@ -11760,7 +11753,7 @@ await client.hris.timesheetEntries.retrieve("id");
-
-Returns metadata for `TimesheetEntry` POSTs.
+Creates a link token to be used when linking a new end user.
@@ -11776,7 +11769,12 @@ Returns metadata for `TimesheetEntry` POSTs.
-
```typescript
-await client.hris.timesheetEntries.metaPostRetrieve();
+await client.crm.linkToken.create({
+ endUserEmailAddress: "example@gmail.com",
+ endUserOrganizationName: "Test Organization",
+ endUserOriginId: "12345",
+ categories: ["hris", "ats"],
+});
```
@@ -11792,7 +11790,15 @@ await client.hris.timesheetEntries.metaPostRetrieve();
-
-**requestOptions:** `TimesheetEntries.RequestOptions`
+**request:** `Merge.crm.EndUserDetailsRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LinkToken.RequestOptions`
@@ -11803,9 +11809,9 @@ await client.hris.timesheetEntries.metaPostRetrieve();
-## Hris WebhookReceivers
+## Crm LinkedAccounts
-client.hris.webhookReceivers.list() -> Merge.WebhookReceiver[]
+client.crm.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
-
@@ -11817,7 +11823,7 @@ await client.hris.timesheetEntries.metaPostRetrieve();
-
-Returns a list of `WebhookReceiver` objects.
+List linked accounts for your organization.
@@ -11833,7 +11839,7 @@ Returns a list of `WebhookReceiver` objects.
-
```typescript
-await client.hris.webhookReceivers.list();
+await client.crm.linkedAccounts.list();
```
@@ -11849,7 +11855,15 @@ await client.hris.webhookReceivers.list();
-
-**requestOptions:** `WebhookReceivers.RequestOptions`
+**request:** `Merge.crm.LinkedAccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -11860,7 +11874,9 @@ await client.hris.webhookReceivers.list();
-client.hris.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
+## Crm Notes
+
+client.crm.notes.list({ ...params }) -> Merge.PaginatedNoteList
-
@@ -11872,7 +11888,7 @@ await client.hris.webhookReceivers.list();
-
-Creates a `WebhookReceiver` object with the given values.
+Returns a list of `Note` objects.
@@ -11888,10 +11904,7 @@ Creates a `WebhookReceiver` object with the given values.
-
```typescript
-await client.hris.webhookReceivers.create({
- event: "event",
- isActive: true,
-});
+await client.crm.notes.list();
```
@@ -11907,7 +11920,7 @@ await client.hris.webhookReceivers.create({
-
-**request:** `Merge.hris.WebhookReceiverRequest`
+**request:** `Merge.crm.NotesListRequest`
@@ -11915,7 +11928,7 @@ await client.hris.webhookReceivers.create({
-
-**requestOptions:** `WebhookReceivers.RequestOptions`
+**requestOptions:** `Notes.RequestOptions`
@@ -11926,9 +11939,7 @@ await client.hris.webhookReceivers.create({
-## Ticketing AccountDetails
-
-client.ticketing.accountDetails.retrieve() -> Merge.AccountDetails
+client.crm.notes.create({ ...params }) -> Merge.NoteResponse
-
@@ -11940,7 +11951,7 @@ await client.hris.webhookReceivers.create({
-
-Get details for a linked account.
+Creates a `Note` object with the given values.
@@ -11956,7 +11967,9 @@ Get details for a linked account.
-
```typescript
-await client.ticketing.accountDetails.retrieve();
+await client.crm.notes.create({
+ model: {},
+});
```
@@ -11972,7 +11985,15 @@ await client.ticketing.accountDetails.retrieve();
-
-**requestOptions:** `AccountDetails.RequestOptions`
+**request:** `Merge.crm.NoteEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Notes.RequestOptions`
@@ -11983,9 +12004,7 @@ await client.ticketing.accountDetails.retrieve();
-## Ticketing AccountToken
-
-client.ticketing.accountToken.retrieve(publicToken) -> Merge.AccountToken
+client.crm.notes.retrieve(id, { ...params }) -> Merge.Note
-
@@ -11997,7 +12016,7 @@ await client.ticketing.accountDetails.retrieve();
-
-Returns the account token for the end user with the provided public token.
+Returns a `Note` object with the given `id`.
@@ -12013,7 +12032,7 @@ Returns the account token for the end user with the provided public token.
-
```typescript
-await client.ticketing.accountToken.retrieve("public_token");
+await client.crm.notes.retrieve("id");
```
@@ -12029,7 +12048,7 @@ await client.ticketing.accountToken.retrieve("public_token");
-
-**publicToken:** `string`
+**id:** `string`
@@ -12037,7 +12056,15 @@ await client.ticketing.accountToken.retrieve("public_token");
-
-**requestOptions:** `AccountToken.RequestOptions`
+**request:** `Merge.crm.NotesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Notes.RequestOptions`
@@ -12048,9 +12075,7 @@ await client.ticketing.accountToken.retrieve("public_token");
-## Ticketing Accounts
-
-client.ticketing.accounts.list({ ...params }) -> Merge.PaginatedAccountList
+client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -12062,143 +12087,7 @@ await client.ticketing.accountToken.retrieve("public_token");
-
-Returns a list of `Account` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.accounts.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.AccountsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Accounts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.accounts.retrieve(id, { ...params }) -> Merge.Account
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns an `Account` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.accounts.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.AccountsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Accounts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing AsyncPassthrough
-
-client.ticketing.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns metadata for `Note` POSTs.
@@ -12214,10 +12103,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.ticketing.asyncPassthrough.create({
- method: "GET",
- path: "/scooters",
-});
+await client.crm.notes.metaPostRetrieve();
```
@@ -12233,15 +12119,7 @@ await client.ticketing.asyncPassthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
-
-
-
-
-
--
-
-**requestOptions:** `AsyncPassthrough.RequestOptions`
+**requestOptions:** `Notes.RequestOptions`
@@ -12252,7 +12130,7 @@ await client.ticketing.asyncPassthrough.create({
-client.ticketing.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
+client.crm.notes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -12264,7 +12142,7 @@ await client.ticketing.asyncPassthrough.create({
-
-Retrieves data from earlier async-passthrough POST request
+Returns a list of `RemoteFieldClass` objects.
@@ -12280,7 +12158,7 @@ Retrieves data from earlier async-passthrough POST request
-
```typescript
-await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+await client.crm.notes.remoteFieldClassesList();
```
@@ -12296,7 +12174,7 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
-
-**asyncPassthroughReceiptId:** `string`
+**request:** `Merge.crm.NotesRemoteFieldClassesListRequest`
@@ -12304,7 +12182,7 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
-
-**requestOptions:** `AsyncPassthrough.RequestOptions`
+**requestOptions:** `Notes.RequestOptions`
@@ -12315,9 +12193,9 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
-## Ticketing Attachments
+## Crm Opportunities
-client.ticketing.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList
+client.crm.opportunities.list({ ...params }) -> Merge.PaginatedOpportunityList
-
@@ -12329,7 +12207,7 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
-
-Returns a list of `Attachment` objects.
+Returns a list of `Opportunity` objects.
@@ -12345,7 +12223,7 @@ Returns a list of `Attachment` objects.
-
```typescript
-await client.ticketing.attachments.list();
+await client.crm.opportunities.list();
```
@@ -12361,7 +12239,7 @@ await client.ticketing.attachments.list();
-
-**request:** `Merge.ticketing.AttachmentsListRequest`
+**request:** `Merge.crm.OpportunitiesListRequest`
@@ -12369,7 +12247,7 @@ await client.ticketing.attachments.list();
-
-**requestOptions:** `Attachments.RequestOptions`
+**requestOptions:** `Opportunities.RequestOptions`
@@ -12380,7 +12258,7 @@ await client.ticketing.attachments.list();
-client.ticketing.attachments.create({ ...params }) -> Merge.TicketingAttachmentResponse
+client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse
-
@@ -12392,7 +12270,7 @@ await client.ticketing.attachments.list();
-
-Creates an `Attachment` object with the given values.
+Creates an `Opportunity` object with the given values.
@@ -12408,7 +12286,7 @@ Creates an `Attachment` object with the given values.
-
```typescript
-await client.ticketing.attachments.create({
+await client.crm.opportunities.create({
model: {},
});
```
@@ -12426,7 +12304,7 @@ await client.ticketing.attachments.create({
-
-**request:** `Merge.ticketing.TicketingAttachmentEndpointRequest`
+**request:** `Merge.crm.OpportunityEndpointRequest`
@@ -12434,7 +12312,7 @@ await client.ticketing.attachments.create({
-
-**requestOptions:** `Attachments.RequestOptions`
+**requestOptions:** `Opportunities.RequestOptions`
@@ -12445,7 +12323,7 @@ await client.ticketing.attachments.create({
-client.ticketing.attachments.retrieve(id, { ...params }) -> Merge.Attachment
+client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity
-
@@ -12457,7 +12335,7 @@ await client.ticketing.attachments.create({
-
-Returns an `Attachment` object with the given `id`.
+Returns an `Opportunity` object with the given `id`.
@@ -12473,7 +12351,7 @@ Returns an `Attachment` object with the given `id`.
-
```typescript
-await client.ticketing.attachments.retrieve("id");
+await client.crm.opportunities.retrieve("id");
```
@@ -12497,5939 +12375,15 @@ await client.ticketing.attachments.retrieve("id");
-
-**request:** `Merge.ticketing.AttachmentsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Attachments.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.attachments.metaPostRetrieve() -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `TicketingAttachment` POSTs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.attachments.metaPostRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Attachments.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing AuditTrail
-
-client.ticketing.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets a list of audit trail events.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.auditTrail.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.AuditTrailListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `AuditTrail.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing AvailableActions
-
-client.ticketing.availableActions.retrieve() -> Merge.AvailableActions
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of models and actions available for an account.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.availableActions.retrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `AvailableActions.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Collections
-
-client.ticketing.collections.list({ ...params }) -> Merge.PaginatedCollectionList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Collection` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.collections.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.CollectionsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Collections.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.collections.viewersList(collectionId, { ...params }) -> Merge.PaginatedViewerList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.collections.viewersList("collection_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**collectionId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.CollectionsViewersListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Collections.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.collections.retrieve(id, { ...params }) -> Merge.Collection
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Collection` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.collections.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.CollectionsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Collections.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Comments
-
-client.ticketing.comments.list({ ...params }) -> Merge.PaginatedCommentList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Comment` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.comments.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.CommentsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Comments.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.comments.create({ ...params }) -> Merge.CommentResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `Comment` object with the given values.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.comments.create({
- model: {},
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.CommentEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Comments.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.comments.retrieve(id, { ...params }) -> Merge.Comment
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Comment` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.comments.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.CommentsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Comments.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.comments.metaPostRetrieve() -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `Comment` POSTs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.comments.metaPostRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Comments.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Contacts
-
-client.ticketing.contacts.list({ ...params }) -> Merge.PaginatedContactList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Contact` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.contacts.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.ContactsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.contacts.create({ ...params }) -> Merge.TicketingContactResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `Contact` object with the given values.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.contacts.create({
- model: {},
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.TicketingContactEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.contacts.retrieve(id, { ...params }) -> Merge.Contact
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Contact` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.contacts.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.ContactsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.contacts.metaPostRetrieve() -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `TicketingContact` POSTs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.contacts.metaPostRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Scopes
-
-client.ticketing.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.scopes.defaultScopesRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Scopes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.scopes.linkedAccountScopesRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Scopes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.scopes.linkedAccountScopesCreate({
- commonModels: [
- {
- modelName: "Employee",
- modelPermissions: {
- READ: {
- isEnabled: true,
- },
- WRITE: {
- isEnabled: false,
- },
- },
- fieldPermissions: {
- enabledFields: ["avatar", "home_location"],
- disabledFields: ["work_location"],
- },
- },
- {
- modelName: "Benefit",
- modelPermissions: {
- WRITE: {
- isEnabled: false,
- },
- },
- },
- ],
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.LinkedAccountCommonModelScopeDeserializerRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Scopes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing DeleteAccount
-
-client.ticketing.deleteAccount.delete() -> void
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete a linked account.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.deleteAccount.delete();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `DeleteAccount.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing FieldMapping
-
-client.ticketing.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.fieldMapping.fieldMappingsRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.FieldMappingsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `FieldMapping.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.fieldMapping.fieldMappingsCreate({
- targetFieldName: "example_target_field_name",
- targetFieldDescription: "this is a example description of the target field",
- remoteFieldTraversalPath: ["example_remote_field"],
- remoteMethod: "GET",
- remoteUrlPath: "/example-url-path",
- commonModelName: "ExampleCommonModel",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.CreateFieldMappingRequest`
-
-
-
-
-
--
-
-**requestOptions:** `FieldMapping.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**fieldMappingId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `FieldMapping.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**fieldMappingId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.PatchedEditFieldMappingRequest`
-
-
-
-
-
--
-
-**requestOptions:** `FieldMapping.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.fieldMapping.remoteFieldsRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.RemoteFieldsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `FieldMapping.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.fieldMapping.targetFieldsRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `FieldMapping.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing GenerateKey
-
-client.ticketing.generateKey.create({ ...params }) -> Merge.RemoteKey
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a remote key.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.generateKey.create({
- name: "Remote Deployment Key 1",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.GenerateRemoteKeyRequest`
-
-
-
-
-
--
-
-**requestOptions:** `GenerateKey.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Issues
-
-client.ticketing.issues.list({ ...params }) -> Merge.PaginatedIssueList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets all issues for Organization.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.issues.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.IssuesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Issues.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.issues.retrieve(id) -> Merge.Issue
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get a specific issue.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.issues.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Issues.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing LinkToken
-
-client.ticketing.linkToken.create({ ...params }) -> Merge.LinkToken
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a link token to be used when linking a new end user.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.linkToken.create({
- endUserEmailAddress: "example@gmail.com",
- endUserOrganizationName: "Test Organization",
- endUserOriginId: "12345",
- categories: ["hris", "ats"],
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.EndUserDetailsRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LinkToken.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing LinkedAccounts
-
-client.ticketing.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-List linked accounts for your organization.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.linkedAccounts.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.LinkedAccountsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LinkedAccounts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Passthrough
-
-client.ticketing.passthrough.create({ ...params }) -> Merge.RemoteResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Pull data from an endpoint not currently supported by Merge.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.passthrough.create({
- method: "GET",
- path: "/scooters",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.DataPassthroughRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Passthrough.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Projects
-
-client.ticketing.projects.list({ ...params }) -> Merge.PaginatedProjectList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Project` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.projects.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.ProjectsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Projects.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.projects.retrieve(id, { ...params }) -> Merge.Project
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Project` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.projects.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.ProjectsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Projects.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.projects.usersList(parentId, { ...params }) -> Merge.PaginatedUserList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `User` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.projects.usersList("parent_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**parentId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.ProjectsUsersListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Projects.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing RegenerateKey
-
-client.ticketing.regenerateKey.create({ ...params }) -> Merge.RemoteKey
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Exchange remote keys.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.regenerateKey.create({
- name: "Remote Deployment Key 1",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.RemoteKeyForRegenerationRequest`
-
-
-
-
-
--
-
-**requestOptions:** `RegenerateKey.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Roles
-
-client.ticketing.roles.list({ ...params }) -> Merge.PaginatedRoleList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Role` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.roles.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.RolesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Roles.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.roles.retrieve(id, { ...params }) -> Merge.Role
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Role` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.roles.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.RolesRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Roles.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing SyncStatus
-
-client.ticketing.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.syncStatus.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.SyncStatusListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `SyncStatus.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing ForceResync
-
-client.ticketing.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.forceResync.syncStatusResyncCreate();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `ForceResync.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Tags
-
-client.ticketing.tags.list({ ...params }) -> Merge.PaginatedTagList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Tag` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.tags.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.TagsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Tags.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.tags.retrieve(id, { ...params }) -> Merge.Tag
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Tag` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.tags.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.TagsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Tags.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Teams
-
-client.ticketing.teams.list({ ...params }) -> Merge.PaginatedTeamList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Team` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.teams.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.TeamsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Teams.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.teams.retrieve(id, { ...params }) -> Merge.Team
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Team` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.teams.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.TeamsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Teams.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Tickets
-
-client.ticketing.tickets.list({ ...params }) -> Merge.PaginatedTicketList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Ticket` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.tickets.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.TicketsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Tickets.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.tickets.create({ ...params }) -> Merge.TicketResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `Ticket` object with the given values.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.tickets.create({
- model: {},
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.TicketEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Tickets.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.tickets.retrieve(id, { ...params }) -> Merge.Ticket
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Ticket` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.tickets.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.TicketsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Tickets.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.tickets.partialUpdate(id, { ...params }) -> Merge.TicketResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates a `Ticket` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.tickets.partialUpdate("id", {
- model: {},
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.PatchedTicketEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Tickets.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.tickets.viewersList(ticketId, { ...params }) -> Merge.PaginatedViewerList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.tickets.viewersList("ticket_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**ticketId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.TicketsViewersListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Tickets.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.tickets.metaPatchRetrieve(id) -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `Ticket` PATCHs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.tickets.metaPatchRetrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Tickets.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.tickets.metaPostRetrieve() -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `Ticket` POSTs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.tickets.metaPostRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Tickets.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.tickets.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `RemoteFieldClass` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.tickets.remoteFieldClassesList();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.TicketsRemoteFieldClassesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Tickets.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing Users
-
-client.ticketing.users.list({ ...params }) -> Merge.PaginatedUserList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `User` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.users.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.UsersListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Users.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.users.retrieve(id, { ...params }) -> Merge.User
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `User` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.users.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.UsersRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Users.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Ticketing WebhookReceivers
-
-client.ticketing.webhookReceivers.list() -> Merge.WebhookReceiver[]
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `WebhookReceiver` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.webhookReceivers.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `WebhookReceivers.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.ticketing.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `WebhookReceiver` object with the given values.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.ticketing.webhookReceivers.create({
- event: "event",
- isActive: true,
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.ticketing.WebhookReceiverRequest`
-
-
-
-
-
--
-
-**requestOptions:** `WebhookReceivers.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm AccountDetails
-
-client.crm.accountDetails.retrieve() -> Merge.AccountDetails
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get details for a linked account.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.accountDetails.retrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `AccountDetails.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm AccountToken
-
-client.crm.accountToken.retrieve(publicToken) -> Merge.AccountToken
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns the account token for the end user with the provided public token.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.accountToken.retrieve("public_token");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**publicToken:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `AccountToken.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm Accounts
-
-client.crm.accounts.list({ ...params }) -> Merge.PaginatedAccountList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Account` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.accounts.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.crm.AccountsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Accounts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates an `Account` object with the given values.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.accounts.create({
- model: {},
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.crm.CrmAccountEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Accounts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns an `Account` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.accounts.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.AccountsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Accounts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates an `Account` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.accounts.partialUpdate("id", {
- model: {},
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.PatchedCrmAccountEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Accounts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `CRMAccount` PATCHs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.accounts.metaPatchRetrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Accounts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `CRMAccount` POSTs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.accounts.metaPostRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Accounts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.accounts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `RemoteFieldClass` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.accounts.remoteFieldClassesList();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Accounts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm AsyncPassthrough
-
-client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.asyncPassthrough.create({
- method: "GET",
- path: "/scooters",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.DataPassthroughRequest`
-
-
-
-
-
--
-
-**requestOptions:** `AsyncPassthrough.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieves data from earlier async-passthrough POST request
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**asyncPassthroughReceiptId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `AsyncPassthrough.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm AuditTrail
-
-client.crm.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets a list of audit trail events.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.auditTrail.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.crm.AuditTrailListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `AuditTrail.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm AvailableActions
-
-client.crm.availableActions.retrieve() -> Merge.AvailableActions
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of models and actions available for an account.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.availableActions.retrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `AvailableActions.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm Contacts
-
-client.crm.contacts.list({ ...params }) -> Merge.PaginatedContactList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Contact` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.contacts.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.crm.ContactsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `Contact` object with the given values.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.contacts.create({
- model: {},
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.crm.CrmContactEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Contact` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.contacts.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.ContactsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates a `Contact` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.contacts.partialUpdate("id", {
- model: {},
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.PatchedCrmContactEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.contacts.ignoreCreate(modelId, { ...params }) -> void
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-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.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.contacts.ignoreCreate("model_id", {
- reason: "GENERAL_CUSTOMER_REQUEST",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**modelId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.IgnoreCommonModelRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `CRMContact` PATCHs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.contacts.metaPatchRetrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `CRMContact` POSTs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.contacts.metaPostRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `RemoteFieldClass` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.contacts.remoteFieldClassesList();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Contacts.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm CustomObjectClasses
-
-client.crm.customObjectClasses.list({ ...params }) -> Merge.PaginatedCustomObjectClassList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `CustomObjectClass` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.customObjectClasses.list();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CustomObjectClasses.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `CustomObjectClass` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.customObjectClasses.retrieve("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CustomObjectClasses.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm AssociationTypes
-
-client.crm.associationTypes.customObjectClassesAssociationTypesList(customObjectClassId, { ...params }) -> Merge.PaginatedAssociationTypeList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `AssociationType` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customObjectClassId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `AssociationTypes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.associationTypes.customObjectClassesAssociationTypesCreate(customObjectClassId, { ...params }) -> Merge.CrmAssociationTypeResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates an `AssociationType` object with the given values.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
- },
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customObjectClassId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CrmAssociationTypeEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `AssociationTypes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(customObjectClassId, id, { ...params }) -> Merge.AssociationType
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns an `AssociationType` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customObjectClassId:** `string`
-
-
-
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `AssociationTypes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `CRMAssociationType` POSTs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customObjectClassId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `AssociationTypes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm CustomObjects
-
-client.crm.customObjects.customObjectClassesCustomObjectsList(customObjectClassId, { ...params }) -> Merge.PaginatedCustomObjectList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `CustomObject` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customObjectClassId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CustomObjects.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.customObjects.customObjectClassesCustomObjectsCreate(customObjectClassId, { ...params }) -> Merge.CrmCustomObjectResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `CustomObject` object with the given values.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", {
- model: {
- fields: {
- test_field: "hello",
- },
- },
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customObjectClassId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CrmCustomObjectEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CustomObjects.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(customObjectClassId, id, { ...params }) -> Merge.CustomObject
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `CustomObject` object with the given `id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customObjectClassId:** `string`
-
-
-
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CustomObjects.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `CRMCustomObject` POSTs.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customObjectClassId:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `CustomObjects.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `RemoteFieldClass` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CustomObjects.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm Associations
-
-client.crm.associations.customObjectClassesCustomObjectsAssociationsList(customObjectClassId, objectId, { ...params }) -> Merge.PaginatedAssociationList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Association` objects.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**customObjectClassId:** `string`
-
-
-
-
-
--
-
-**objectId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Associations.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(associationTypeId, sourceClassId, sourceObjectId, targetClassId, targetObjectId, { ...params }) -> Merge.Association
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(
- "association_type_id",
- "source_class_id",
- "source_object_id",
- "target_class_id",
- "target_object_id",
-);
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**associationTypeId:** `string`
-
-
-
-
-
--
-
-**sourceClassId:** `string`
-
-
-
-
-
--
-
-**sourceObjectId:** `string`
-
-
-
-
-
--
-
-**targetClassId:** `string`
-
-
-
-
-
--
-
-**targetObjectId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Associations.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Crm Scopes
-
-client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.crm.scopes.defaultScopesRetrieve();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
+**request:** `Merge.crm.OpportunitiesRetrieveRequest`
+
+
+
+
-
-**requestOptions:** `Scopes.RequestOptions`
+**requestOptions:** `Opportunities.RequestOptions`
@@ -18440,7 +12394,7 @@ await client.crm.scopes.defaultScopesRetrieve();
-client.crm.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
+client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse
-
@@ -18452,7 +12406,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).
+Updates an `Opportunity` object with the given `id`.
@@ -18468,7 +12422,9 @@ Get all available permissions for Merge Common Models and fields for a single Li
-
```typescript
-await client.crm.scopes.linkedAccountScopesRetrieve();
+await client.crm.opportunities.partialUpdate("id", {
+ model: {},
+});
```
@@ -18484,7 +12440,23 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-
-**requestOptions:** `Scopes.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.PatchedOpportunityEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Opportunities.RequestOptions`
@@ -18495,7 +12467,7 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-client.crm.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
+client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -18507,7 +12479,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 metadata for `Opportunity` PATCHs.
@@ -18523,33 +12495,7 @@ Update permissions for any Common Model or field for a single Linked Account. An
-
```typescript
-await client.crm.scopes.linkedAccountScopesCreate({
- commonModels: [
- {
- modelName: "Employee",
- modelPermissions: {
- READ: {
- isEnabled: true,
- },
- WRITE: {
- isEnabled: false,
- },
- },
- fieldPermissions: {
- enabledFields: ["avatar", "home_location"],
- disabledFields: ["work_location"],
- },
- },
- {
- modelName: "Benefit",
- modelPermissions: {
- WRITE: {
- isEnabled: false,
- },
- },
- },
- ],
-});
+await client.crm.opportunities.metaPatchRetrieve("id");
```
@@ -18565,7 +12511,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-
-**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest`
+**id:** `string`
@@ -18573,7 +12519,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-
-**requestOptions:** `Scopes.RequestOptions`
+**requestOptions:** `Opportunities.RequestOptions`
@@ -18584,9 +12530,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-## Crm DeleteAccount
-
-client.crm.deleteAccount.delete() -> void
+client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -18598,7 +12542,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-
-Delete a linked account.
+Returns metadata for `Opportunity` POSTs.
@@ -18614,7 +12558,7 @@ Delete a linked account.
-
```typescript
-await client.crm.deleteAccount.delete();
+await client.crm.opportunities.metaPostRetrieve();
```
@@ -18630,7 +12574,7 @@ await client.crm.deleteAccount.delete();
-
-**requestOptions:** `DeleteAccount.RequestOptions`
+**requestOptions:** `Opportunities.RequestOptions`
@@ -18641,9 +12585,7 @@ await client.crm.deleteAccount.delete();
-## Crm EngagementTypes
-
-client.crm.engagementTypes.list({ ...params }) -> Merge.PaginatedEngagementTypeList
+client.crm.opportunities.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -18655,7 +12597,7 @@ await client.crm.deleteAccount.delete();
-
-Returns a list of `EngagementType` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -18671,7 +12613,7 @@ Returns a list of `EngagementType` objects.
-
```typescript
-await client.crm.engagementTypes.list();
+await client.crm.opportunities.remoteFieldClassesList();
```
@@ -18687,7 +12629,7 @@ await client.crm.engagementTypes.list();
-
-**request:** `Merge.crm.EngagementTypesListRequest`
+**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest`
@@ -18695,7 +12637,7 @@ await client.crm.engagementTypes.list();
-
-**requestOptions:** `EngagementTypes.RequestOptions`
+**requestOptions:** `Opportunities.RequestOptions`
@@ -18706,7 +12648,9 @@ await client.crm.engagementTypes.list();
-client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType
+## Crm Passthrough
+
+client.crm.passthrough.create({ ...params }) -> Merge.RemoteResponse
-
@@ -18718,7 +12662,7 @@ await client.crm.engagementTypes.list();
-
-Returns an `EngagementType` object with the given `id`.
+Pull data from an endpoint not currently supported by Merge.
@@ -18734,7 +12678,10 @@ Returns an `EngagementType` object with the given `id`.
-
```typescript
-await client.crm.engagementTypes.retrieve("id");
+await client.crm.passthrough.create({
+ method: "GET",
+ path: "/scooters",
+});
```
@@ -18750,15 +12697,7 @@ await client.crm.engagementTypes.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.EngagementTypesRetrieveRequest`
+**request:** `Merge.DataPassthroughRequest`
@@ -18766,7 +12705,7 @@ await client.crm.engagementTypes.retrieve("id");
-
-**requestOptions:** `EngagementTypes.RequestOptions`
+**requestOptions:** `Passthrough.RequestOptions`
@@ -18777,7 +12716,9 @@ await client.crm.engagementTypes.retrieve("id");
-client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+## Crm RegenerateKey
+
+client.crm.regenerateKey.create({ ...params }) -> Merge.RemoteKey
-
@@ -18789,7 +12730,7 @@ await client.crm.engagementTypes.retrieve("id");
-
-Returns a list of `RemoteFieldClass` objects.
+Exchange remote keys.
@@ -18805,7 +12746,9 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.engagementTypes.remoteFieldClassesList();
+await client.crm.regenerateKey.create({
+ name: "Remote Deployment Key 1",
+});
```
@@ -18821,7 +12764,7 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-
-**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest`
+**request:** `Merge.crm.RemoteKeyForRegenerationRequest`
@@ -18829,7 +12772,7 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-
-**requestOptions:** `EngagementTypes.RequestOptions`
+**requestOptions:** `RegenerateKey.RequestOptions`
@@ -18840,9 +12783,9 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-## Crm Engagements
+## Crm Stages
-client.crm.engagements.list({ ...params }) -> Merge.PaginatedEngagementList
+client.crm.stages.list({ ...params }) -> Merge.PaginatedStageList
-
@@ -18854,7 +12797,7 @@ await client.crm.engagementTypes.remoteFieldClassesList();
-
-Returns a list of `Engagement` objects.
+Returns a list of `Stage` objects.
@@ -18870,7 +12813,7 @@ Returns a list of `Engagement` objects.
-
```typescript
-await client.crm.engagements.list();
+await client.crm.stages.list();
```
@@ -18886,7 +12829,7 @@ await client.crm.engagements.list();
-
-**request:** `Merge.crm.EngagementsListRequest`
+**request:** `Merge.crm.StagesListRequest`
@@ -18894,7 +12837,7 @@ await client.crm.engagements.list();
-
-**requestOptions:** `Engagements.RequestOptions`
+**requestOptions:** `Stages.RequestOptions`
@@ -18905,7 +12848,7 @@ await client.crm.engagements.list();
-client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse
+client.crm.stages.retrieve(id, { ...params }) -> Merge.Stage
-
@@ -18917,7 +12860,7 @@ await client.crm.engagements.list();
-
-Creates an `Engagement` object with the given values.
+Returns a `Stage` object with the given `id`.
@@ -18933,9 +12876,7 @@ Creates an `Engagement` object with the given values.
-
```typescript
-await client.crm.engagements.create({
- model: {},
-});
+await client.crm.stages.retrieve("id");
```
@@ -18951,7 +12892,7 @@ await client.crm.engagements.create({
-
-**request:** `Merge.crm.EngagementEndpointRequest`
+**id:** `string`
@@ -18959,7 +12900,15 @@ await client.crm.engagements.create({
-
-**requestOptions:** `Engagements.RequestOptions`
+**request:** `Merge.crm.StagesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Stages.RequestOptions`
@@ -18970,7 +12919,7 @@ await client.crm.engagements.create({
-client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement
+client.crm.stages.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -18982,7 +12931,7 @@ await client.crm.engagements.create({
-
-Returns an `Engagement` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -18998,7 +12947,7 @@ Returns an `Engagement` object with the given `id`.
-
```typescript
-await client.crm.engagements.retrieve("id");
+await client.crm.stages.remoteFieldClassesList();
```
@@ -19014,15 +12963,7 @@ await client.crm.engagements.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.EngagementsRetrieveRequest`
+**request:** `Merge.crm.StagesRemoteFieldClassesListRequest`
@@ -19030,7 +12971,7 @@ await client.crm.engagements.retrieve("id");
-
-**requestOptions:** `Engagements.RequestOptions`
+**requestOptions:** `Stages.RequestOptions`
@@ -19041,7 +12982,9 @@ await client.crm.engagements.retrieve("id");
-client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse
+## Crm SyncStatus
+
+client.crm.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
-
@@ -19053,7 +12996,7 @@ await client.crm.engagements.retrieve("id");
-
-Updates an `Engagement` object with the given `id`.
+Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -19069,9 +13012,7 @@ Updates an `Engagement` object with the given `id`.
-
```typescript
-await client.crm.engagements.partialUpdate("id", {
- model: {},
-});
+await client.crm.syncStatus.list();
```
@@ -19087,15 +13028,7 @@ await client.crm.engagements.partialUpdate("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.PatchedEngagementEndpointRequest`
+**request:** `Merge.crm.SyncStatusListRequest`
@@ -19103,7 +13036,7 @@ await client.crm.engagements.partialUpdate("id", {
-
-**requestOptions:** `Engagements.RequestOptions`
+**requestOptions:** `SyncStatus.RequestOptions`
@@ -19114,7 +13047,9 @@ await client.crm.engagements.partialUpdate("id", {
-client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse
+## Crm ForceResync
+
+client.crm.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
-
@@ -19126,7 +13061,7 @@ await client.crm.engagements.partialUpdate("id", {
-
-Returns metadata for `Engagement` PATCHs.
+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.
@@ -19142,7 +13077,7 @@ Returns metadata for `Engagement` PATCHs.
-
```typescript
-await client.crm.engagements.metaPatchRetrieve("id");
+await client.crm.forceResync.syncStatusResyncCreate();
```
@@ -19158,15 +13093,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Engagements.RequestOptions`
+**requestOptions:** `ForceResync.RequestOptions`
@@ -19177,7 +13104,9 @@ await client.crm.engagements.metaPatchRetrieve("id");
-client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse
+## Crm Tasks
+
+client.crm.tasks.list({ ...params }) -> Merge.PaginatedTaskList
-
@@ -19189,7 +13118,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-
-Returns metadata for `Engagement` POSTs.
+Returns a list of `Task` objects.
@@ -19205,7 +13134,7 @@ Returns metadata for `Engagement` POSTs.
-
```typescript
-await client.crm.engagements.metaPostRetrieve();
+await client.crm.tasks.list();
```
@@ -19221,7 +13150,15 @@ await client.crm.engagements.metaPostRetrieve();
-
-**requestOptions:** `Engagements.RequestOptions`
+**request:** `Merge.crm.TasksListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tasks.RequestOptions`
@@ -19232,7 +13169,7 @@ await client.crm.engagements.metaPostRetrieve();
-client.crm.engagements.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.crm.tasks.create({ ...params }) -> Merge.TaskResponse
-
@@ -19244,7 +13181,7 @@ await client.crm.engagements.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Creates a `Task` object with the given values.
@@ -19260,7 +13197,9 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.engagements.remoteFieldClassesList();
+await client.crm.tasks.create({
+ model: {},
+});
```
@@ -19276,7 +13215,7 @@ await client.crm.engagements.remoteFieldClassesList();
-
-**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest`
+**request:** `Merge.crm.TaskEndpointRequest`
@@ -19284,7 +13223,7 @@ await client.crm.engagements.remoteFieldClassesList();
-
-**requestOptions:** `Engagements.RequestOptions`
+**requestOptions:** `Tasks.RequestOptions`
@@ -19295,9 +13234,7 @@ await client.crm.engagements.remoteFieldClassesList();
-## Crm FieldMapping
-
-client.crm.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
+client.crm.tasks.retrieve(id, { ...params }) -> Merge.Task
-
@@ -19309,7 +13246,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 `Task` object with the given `id`.
@@ -19325,7 +13262,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
-
```typescript
-await client.crm.fieldMapping.fieldMappingsRetrieve();
+await client.crm.tasks.retrieve("id");
```
@@ -19341,7 +13278,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-
-**request:** `Merge.crm.FieldMappingsRetrieveRequest`
+**id:** `string`
@@ -19349,7 +13286,15 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**request:** `Merge.crm.TasksRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tasks.RequestOptions`
@@ -19360,7 +13305,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve();
-client.crm.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
+client.crm.tasks.partialUpdate(id, { ...params }) -> Merge.TaskResponse
-
@@ -19372,7 +13317,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.
+Updates a `Task` object with the given `id`.
@@ -19388,13 +13333,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.tasks.partialUpdate("id", {
+ model: {},
});
```
@@ -19411,7 +13351,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-
-**request:** `Merge.crm.CreateFieldMappingRequest`
+**id:** `string`
@@ -19419,7 +13359,15 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**request:** `Merge.crm.PatchedTaskEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tasks.RequestOptions`
@@ -19430,7 +13378,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-client.crm.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
+client.crm.tasks.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -19442,7 +13390,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 metadata for `Task` PATCHs.
@@ -19458,7 +13406,7 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
-
```typescript
-await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+await client.crm.tasks.metaPatchRetrieve("id");
```
@@ -19474,7 +13422,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**fieldMappingId:** `string`
+**id:** `string`
@@ -19482,7 +13430,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**requestOptions:** `Tasks.RequestOptions`
@@ -19493,7 +13441,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-client.crm.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
+client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -19505,7 +13453,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 metadata for `Task` POSTs.
@@ -19521,7 +13469,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.tasks.metaPostRetrieve();
```
@@ -19537,23 +13485,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-**fieldMappingId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.PatchedEditFieldMappingRequest`
-
-
-
-
-
--
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**requestOptions:** `Tasks.RequestOptions`
@@ -19564,7 +13496,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-client.crm.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
+client.crm.tasks.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -19576,7 +13508,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns a list of `RemoteFieldClass` objects.
@@ -19592,7 +13524,7 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
-
```typescript
-await client.crm.fieldMapping.remoteFieldsRetrieve();
+await client.crm.tasks.remoteFieldClassesList();
```
@@ -19608,7 +13540,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-
-**request:** `Merge.crm.RemoteFieldsRetrieveRequest`
+**request:** `Merge.crm.TasksRemoteFieldClassesListRequest`
@@ -19616,7 +13548,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**requestOptions:** `Tasks.RequestOptions`
@@ -19627,7 +13559,9 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-client.crm.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
+## Crm Users
+
+client.crm.users.list({ ...params }) -> Merge.PaginatedUserList
-
@@ -19639,7 +13573,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve();
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Returns a list of `User` objects.
@@ -19655,7 +13589,7 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
-
```typescript
-await client.crm.fieldMapping.targetFieldsRetrieve();
+await client.crm.users.list();
```
@@ -19671,7 +13605,15 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**request:** `Merge.crm.UsersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.RequestOptions`
@@ -19682,9 +13624,7 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-## Crm GenerateKey
-
-client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey
+client.crm.users.retrieve(id, { ...params }) -> Merge.User
-
@@ -19696,7 +13636,7 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-
-Create a remote key.
+Returns a `User` object with the given `id`.
@@ -19712,9 +13652,7 @@ Create a remote key.
-
```typescript
-await client.crm.generateKey.create({
- name: "Remote Deployment Key 1",
-});
+await client.crm.users.retrieve("id");
```
@@ -19730,7 +13668,7 @@ await client.crm.generateKey.create({
-
-**request:** `Merge.crm.GenerateRemoteKeyRequest`
+**id:** `string`
@@ -19738,7 +13676,15 @@ await client.crm.generateKey.create({
-
-**requestOptions:** `GenerateKey.RequestOptions`
+**request:** `Merge.crm.UsersRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.RequestOptions`
@@ -19749,9 +13695,7 @@ await client.crm.generateKey.create({
-## Crm Issues
-
-client.crm.issues.list({ ...params }) -> Merge.PaginatedIssueList
+client.crm.users.ignoreCreate(modelId, { ...params }) -> void
-
@@ -19763,7 +13707,7 @@ await client.crm.generateKey.create({
-
-Gets all issues for Organization.
+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.
@@ -19779,7 +13723,9 @@ Gets all issues for Organization.
-
```typescript
-await client.crm.issues.list();
+await client.crm.users.ignoreCreate("model_id", {
+ reason: "GENERAL_CUSTOMER_REQUEST",
+});
```
@@ -19795,7 +13741,7 @@ await client.crm.issues.list();
-
-**request:** `Merge.crm.IssuesListRequest`
+**modelId:** `string`
@@ -19803,7 +13749,15 @@ await client.crm.issues.list();
-
-**requestOptions:** `Issues.RequestOptions`
+**request:** `Merge.IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.RequestOptions`
@@ -19814,7 +13768,7 @@ await client.crm.issues.list();
-client.crm.issues.retrieve(id) -> Merge.Issue
+client.crm.users.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -19826,7 +13780,7 @@ await client.crm.issues.list();
-
-Get a specific issue.
+Returns a list of `RemoteFieldClass` objects.
@@ -19842,7 +13796,7 @@ Get a specific issue.
-
```typescript
-await client.crm.issues.retrieve("id");
+await client.crm.users.remoteFieldClassesList();
```
@@ -19858,7 +13812,7 @@ await client.crm.issues.retrieve("id");
-
-**id:** `string`
+**request:** `Merge.crm.UsersRemoteFieldClassesListRequest`
@@ -19866,7 +13820,7 @@ await client.crm.issues.retrieve("id");
-
-**requestOptions:** `Issues.RequestOptions`
+**requestOptions:** `Users.RequestOptions`
@@ -19877,9 +13831,9 @@ await client.crm.issues.retrieve("id");
-## Crm Leads
+## Crm WebhookReceivers
-client.crm.leads.list({ ...params }) -> Merge.PaginatedLeadList
+client.crm.webhookReceivers.list() -> Merge.WebhookReceiver[]
-
@@ -19891,7 +13845,7 @@ await client.crm.issues.retrieve("id");
-
-Returns a list of `Lead` objects.
+Returns a list of `WebhookReceiver` objects.
@@ -19907,7 +13861,7 @@ Returns a list of `Lead` objects.
-
```typescript
-await client.crm.leads.list();
+await client.crm.webhookReceivers.list();
```
@@ -19923,15 +13877,7 @@ await client.crm.leads.list();
-
-**request:** `Merge.crm.LeadsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Leads.RequestOptions`
+**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -19942,7 +13888,7 @@ await client.crm.leads.list();
-client.crm.leads.create({ ...params }) -> Merge.LeadResponse
+client.crm.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
-
@@ -19954,7 +13900,7 @@ await client.crm.leads.list();
-
-Creates a `Lead` object with the given values.
+Creates a `WebhookReceiver` object with the given values.
@@ -19970,8 +13916,9 @@ Creates a `Lead` object with the given values.
-
```typescript
-await client.crm.leads.create({
- model: {},
+await client.crm.webhookReceivers.create({
+ event: "event",
+ isActive: true,
});
```
@@ -19988,7 +13935,7 @@ await client.crm.leads.create({
-
-**request:** `Merge.crm.LeadEndpointRequest`
+**request:** `Merge.crm.WebhookReceiverRequest`
@@ -19996,7 +13943,7 @@ await client.crm.leads.create({
-
-**requestOptions:** `Leads.RequestOptions`
+**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -20007,7 +13954,9 @@ await client.crm.leads.create({
-client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead
+## Hris AccountDetails
+
+client.hris.accountDetails.retrieve() -> Merge.AccountDetails
-
@@ -20019,7 +13968,7 @@ await client.crm.leads.create({
-
-Returns a `Lead` object with the given `id`.
+Get details for a linked account.
@@ -20035,7 +13984,7 @@ Returns a `Lead` object with the given `id`.
-
```typescript
-await client.crm.leads.retrieve("id");
+await client.hris.accountDetails.retrieve();
```
@@ -20051,23 +14000,7 @@ await client.crm.leads.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.LeadsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Leads.RequestOptions`
+**requestOptions:** `AccountDetails.RequestOptions`
@@ -20078,7 +14011,9 @@ await client.crm.leads.retrieve("id");
-client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse
+## Hris AccountToken
+
+client.hris.accountToken.retrieve(publicToken) -> Merge.AccountToken
-
@@ -20090,7 +14025,7 @@ await client.crm.leads.retrieve("id");
-
-Returns metadata for `Lead` POSTs.
+Returns the account token for the end user with the provided public token.
@@ -20106,7 +14041,7 @@ Returns metadata for `Lead` POSTs.
-
```typescript
-await client.crm.leads.metaPostRetrieve();
+await client.hris.accountToken.retrieve("public_token");
```
@@ -20122,7 +14057,15 @@ await client.crm.leads.metaPostRetrieve();
-
-**requestOptions:** `Leads.RequestOptions`
+**publicToken:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountToken.RequestOptions`
@@ -20133,7 +14076,9 @@ await client.crm.leads.metaPostRetrieve();
-client.crm.leads.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+## Hris AsyncPassthrough
+
+client.hris.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
-
@@ -20145,7 +14090,7 @@ await client.crm.leads.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -20161,7 +14106,10 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.leads.remoteFieldClassesList();
+await client.hris.asyncPassthrough.create({
+ method: "GET",
+ path: "/scooters",
+});
```
@@ -20177,7 +14125,7 @@ await client.crm.leads.remoteFieldClassesList();
-
-**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest`
+**request:** `Merge.DataPassthroughRequest`
@@ -20185,7 +14133,7 @@ await client.crm.leads.remoteFieldClassesList();
-
-**requestOptions:** `Leads.RequestOptions`
+**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -20196,9 +14144,7 @@ await client.crm.leads.remoteFieldClassesList();
-## Crm LinkToken
-
-client.crm.linkToken.create({ ...params }) -> Merge.LinkToken
+client.hris.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
-
@@ -20210,7 +14156,7 @@ await client.crm.leads.remoteFieldClassesList();
-
-Creates a link token to be used when linking a new end user.
+Retrieves data from earlier async-passthrough POST request
@@ -20226,12 +14172,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.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
```
@@ -20247,7 +14188,7 @@ await client.crm.linkToken.create({
-
-**request:** `Merge.crm.EndUserDetailsRequest`
+**asyncPassthroughReceiptId:** `string`
@@ -20255,7 +14196,7 @@ await client.crm.linkToken.create({
-
-**requestOptions:** `LinkToken.RequestOptions`
+**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -20266,9 +14207,9 @@ await client.crm.linkToken.create({
-## Crm LinkedAccounts
+## Hris AuditTrail
-client.crm.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+client.hris.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
-
@@ -20280,7 +14221,7 @@ await client.crm.linkToken.create({
-
-List linked accounts for your organization.
+Gets a list of audit trail events.
@@ -20296,7 +14237,7 @@ List linked accounts for your organization.
-
```typescript
-await client.crm.linkedAccounts.list();
+await client.hris.auditTrail.list();
```
@@ -20312,7 +14253,7 @@ await client.crm.linkedAccounts.list();
-
-**request:** `Merge.crm.LinkedAccountsListRequest`
+**request:** `Merge.hris.AuditTrailListRequest`
@@ -20320,7 +14261,7 @@ await client.crm.linkedAccounts.list();
-
-**requestOptions:** `LinkedAccounts.RequestOptions`
+**requestOptions:** `AuditTrail.RequestOptions`
@@ -20331,9 +14272,9 @@ await client.crm.linkedAccounts.list();
-## Crm Notes
+## Hris AvailableActions
-client.crm.notes.list({ ...params }) -> Merge.PaginatedNoteList
+client.hris.availableActions.retrieve() -> Merge.AvailableActions
-
@@ -20345,7 +14286,7 @@ await client.crm.linkedAccounts.list();
-
-Returns a list of `Note` objects.
+Returns a list of models and actions available for an account.
@@ -20361,7 +14302,7 @@ Returns a list of `Note` objects.
-
```typescript
-await client.crm.notes.list();
+await client.hris.availableActions.retrieve();
```
@@ -20377,15 +14318,7 @@ await client.crm.notes.list();
-
-**request:** `Merge.crm.NotesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Notes.RequestOptions`
+**requestOptions:** `AvailableActions.RequestOptions`
@@ -20396,7 +14329,9 @@ await client.crm.notes.list();
-client.crm.notes.create({ ...params }) -> Merge.NoteResponse
+## Hris BankInfo
+
+client.hris.bankInfo.list({ ...params }) -> Merge.PaginatedBankInfoList
-
@@ -20408,7 +14343,7 @@ await client.crm.notes.list();
-
-Creates a `Note` object with the given values.
+Returns a list of `BankInfo` objects.
@@ -20424,9 +14359,7 @@ Creates a `Note` object with the given values.
-
```typescript
-await client.crm.notes.create({
- model: {},
-});
+await client.hris.bankInfo.list();
```
@@ -20442,7 +14375,7 @@ await client.crm.notes.create({
-
-**request:** `Merge.crm.NoteEndpointRequest`
+**request:** `Merge.hris.BankInfoListRequest`
@@ -20450,7 +14383,7 @@ await client.crm.notes.create({
-
-**requestOptions:** `Notes.RequestOptions`
+**requestOptions:** `BankInfo.RequestOptions`
@@ -20461,7 +14394,7 @@ await client.crm.notes.create({
-client.crm.notes.retrieve(id, { ...params }) -> Merge.Note
+client.hris.bankInfo.retrieve(id, { ...params }) -> Merge.BankInfo
-
@@ -20473,7 +14406,7 @@ await client.crm.notes.create({
-
-Returns a `Note` object with the given `id`.
+Returns a `BankInfo` object with the given `id`.
@@ -20489,7 +14422,7 @@ Returns a `Note` object with the given `id`.
-
```typescript
-await client.crm.notes.retrieve("id");
+await client.hris.bankInfo.retrieve("id");
```
@@ -20513,7 +14446,7 @@ await client.crm.notes.retrieve("id");
-
-**request:** `Merge.crm.NotesRetrieveRequest`
+**request:** `Merge.hris.BankInfoRetrieveRequest`
@@ -20521,7 +14454,7 @@ await client.crm.notes.retrieve("id");
-
-**requestOptions:** `Notes.RequestOptions`
+**requestOptions:** `BankInfo.RequestOptions`
@@ -20532,7 +14465,9 @@ await client.crm.notes.retrieve("id");
-client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse
+## Hris Benefits
+
+client.hris.benefits.list({ ...params }) -> Merge.PaginatedBenefitList
-
@@ -20544,7 +14479,7 @@ await client.crm.notes.retrieve("id");
-
-Returns metadata for `Note` POSTs.
+Returns a list of `Benefit` objects.
@@ -20560,7 +14495,7 @@ Returns metadata for `Note` POSTs.
-
```typescript
-await client.crm.notes.metaPostRetrieve();
+await client.hris.benefits.list();
```
@@ -20576,7 +14511,15 @@ await client.crm.notes.metaPostRetrieve();
-
-**requestOptions:** `Notes.RequestOptions`
+**request:** `Merge.hris.BenefitsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Benefits.RequestOptions`
@@ -20587,7 +14530,7 @@ await client.crm.notes.metaPostRetrieve();
-client.crm.notes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.hris.benefits.retrieve(id, { ...params }) -> Merge.Benefit
-
@@ -20599,7 +14542,7 @@ await client.crm.notes.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a `Benefit` object with the given `id`.
@@ -20615,7 +14558,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.notes.remoteFieldClassesList();
+await client.hris.benefits.retrieve("id");
```
@@ -20631,7 +14574,7 @@ await client.crm.notes.remoteFieldClassesList();
-
-**request:** `Merge.crm.NotesRemoteFieldClassesListRequest`
+**id:** `string`
@@ -20639,7 +14582,15 @@ await client.crm.notes.remoteFieldClassesList();
-
-**requestOptions:** `Notes.RequestOptions`
+**request:** `Merge.hris.BenefitsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Benefits.RequestOptions`
@@ -20650,9 +14601,9 @@ await client.crm.notes.remoteFieldClassesList();
-## Crm Opportunities
+## Hris Companies
-client.crm.opportunities.list({ ...params }) -> Merge.PaginatedOpportunityList
+client.hris.companies.list({ ...params }) -> Merge.PaginatedCompanyList
-
@@ -20664,7 +14615,7 @@ await client.crm.notes.remoteFieldClassesList();
-
-Returns a list of `Opportunity` objects.
+Returns a list of `Company` objects.
@@ -20680,7 +14631,7 @@ Returns a list of `Opportunity` objects.
-
```typescript
-await client.crm.opportunities.list();
+await client.hris.companies.list();
```
@@ -20696,7 +14647,7 @@ await client.crm.opportunities.list();
-
-**request:** `Merge.crm.OpportunitiesListRequest`
+**request:** `Merge.hris.CompaniesListRequest`
@@ -20704,7 +14655,7 @@ await client.crm.opportunities.list();
-
-**requestOptions:** `Opportunities.RequestOptions`
+**requestOptions:** `Companies.RequestOptions`
@@ -20715,7 +14666,7 @@ await client.crm.opportunities.list();
-client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse
+client.hris.companies.retrieve(id, { ...params }) -> Merge.Company
-
@@ -20727,7 +14678,7 @@ await client.crm.opportunities.list();
-
-Creates an `Opportunity` object with the given values.
+Returns a `Company` object with the given `id`.
@@ -20743,9 +14694,7 @@ Creates an `Opportunity` object with the given values.
-
```typescript
-await client.crm.opportunities.create({
- model: {},
-});
+await client.hris.companies.retrieve("id");
```
@@ -20761,7 +14710,7 @@ await client.crm.opportunities.create({
-
-**request:** `Merge.crm.OpportunityEndpointRequest`
+**id:** `string`
@@ -20769,7 +14718,15 @@ await client.crm.opportunities.create({
-
-**requestOptions:** `Opportunities.RequestOptions`
+**request:** `Merge.hris.CompaniesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Companies.RequestOptions`
@@ -20780,7 +14737,9 @@ await client.crm.opportunities.create({
-client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity
+## Hris Scopes
+
+client.hris.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
-
@@ -20792,7 +14751,7 @@ await client.crm.opportunities.create({
-
-Returns an `Opportunity` 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).
@@ -20808,7 +14767,7 @@ Returns an `Opportunity` object with the given `id`.
-
```typescript
-await client.crm.opportunities.retrieve("id");
+await client.hris.scopes.defaultScopesRetrieve();
```
@@ -20824,23 +14783,62 @@ await client.crm.opportunities.retrieve("id");
-
-**id:** `string`
+**requestOptions:** `Scopes.RequestOptions`
+
+
+
+
+
+
+client.hris.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
-
-**request:** `Merge.crm.OpportunitiesRetrieveRequest`
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+
+
+
+#### 🔌 Usage
-
-**requestOptions:** `Opportunities.RequestOptions`
+
+-
+
+```typescript
+await client.hris.scopes.linkedAccountScopesRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Scopes.RequestOptions`
@@ -20851,7 +14849,7 @@ await client.crm.opportunities.retrieve("id");
-client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse
+client.hris.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
-
@@ -20863,7 +14861,7 @@ await client.crm.opportunities.retrieve("id");
-
-Updates an `Opportunity` object with the given `id`.
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -20879,8 +14877,32 @@ Updates an `Opportunity` object with the given `id`.
-
```typescript
-await client.crm.opportunities.partialUpdate("id", {
- model: {},
+await client.hris.scopes.linkedAccountScopesCreate({
+ commonModels: [
+ {
+ modelName: "Employee",
+ modelPermissions: {
+ READ: {
+ isEnabled: true,
+ },
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ fieldPermissions: {
+ enabledFields: ["avatar", "home_location"],
+ disabledFields: ["work_location"],
+ },
+ },
+ {
+ modelName: "Benefit",
+ modelPermissions: {
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ },
+ ],
});
```
@@ -20897,15 +14919,7 @@ await client.crm.opportunities.partialUpdate("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.PatchedOpportunityEndpointRequest`
+**request:** `Merge.hris.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -20913,7 +14927,7 @@ await client.crm.opportunities.partialUpdate("id", {
-
-**requestOptions:** `Opportunities.RequestOptions`
+**requestOptions:** `Scopes.RequestOptions`
@@ -20924,7 +14938,9 @@ await client.crm.opportunities.partialUpdate("id", {
-client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse
+## Hris DeleteAccount
+
+client.hris.deleteAccount.delete() -> void
-
@@ -20936,7 +14952,7 @@ await client.crm.opportunities.partialUpdate("id", {
-
-Returns metadata for `Opportunity` PATCHs.
+Delete a linked account.
@@ -20952,7 +14968,7 @@ Returns metadata for `Opportunity` PATCHs.
-
```typescript
-await client.crm.opportunities.metaPatchRetrieve("id");
+await client.hris.deleteAccount.delete();
```
@@ -20968,15 +14984,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Opportunities.RequestOptions`
+**requestOptions:** `DeleteAccount.RequestOptions`
@@ -20987,7 +14995,9 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse
+## Hris Dependents
+
+client.hris.dependents.list({ ...params }) -> Merge.PaginatedDependentList
-
@@ -20999,7 +15009,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-
-Returns metadata for `Opportunity` POSTs.
+Returns a list of `Dependent` objects.
@@ -21015,7 +15025,7 @@ Returns metadata for `Opportunity` POSTs.
-
```typescript
-await client.crm.opportunities.metaPostRetrieve();
+await client.hris.dependents.list();
```
@@ -21031,7 +15041,15 @@ await client.crm.opportunities.metaPostRetrieve();
-
-**requestOptions:** `Opportunities.RequestOptions`
+**request:** `Merge.hris.DependentsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Dependents.RequestOptions`
@@ -21042,7 +15060,7 @@ await client.crm.opportunities.metaPostRetrieve();
-client.crm.opportunities.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.hris.dependents.retrieve(id, { ...params }) -> Merge.Dependent
-
@@ -21054,7 +15072,7 @@ await client.crm.opportunities.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a `Dependent` object with the given `id`.
@@ -21070,7 +15088,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.opportunities.remoteFieldClassesList();
+await client.hris.dependents.retrieve("id");
```
@@ -21086,7 +15104,7 @@ await client.crm.opportunities.remoteFieldClassesList();
-
-**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest`
+**id:** `string`
@@ -21094,7 +15112,15 @@ await client.crm.opportunities.remoteFieldClassesList();
-
-**requestOptions:** `Opportunities.RequestOptions`
+**request:** `Merge.hris.DependentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Dependents.RequestOptions`
@@ -21105,9 +15131,9 @@ await client.crm.opportunities.remoteFieldClassesList();
-## Crm Passthrough
+## Hris EmployeePayrollRuns
-client.crm.passthrough.create({ ...params }) -> Merge.RemoteResponse
+client.hris.employeePayrollRuns.list({ ...params }) -> Merge.PaginatedEmployeePayrollRunList
-
@@ -21119,7 +15145,7 @@ await client.crm.opportunities.remoteFieldClassesList();
-
-Pull data from an endpoint not currently supported by Merge.
+Returns a list of `EmployeePayrollRun` objects.
@@ -21135,10 +15161,7 @@ Pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.crm.passthrough.create({
- method: "GET",
- path: "/scooters",
-});
+await client.hris.employeePayrollRuns.list();
```
@@ -21154,7 +15177,7 @@ await client.crm.passthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
+**request:** `Merge.hris.EmployeePayrollRunsListRequest`
@@ -21162,7 +15185,7 @@ await client.crm.passthrough.create({
-
-**requestOptions:** `Passthrough.RequestOptions`
+**requestOptions:** `EmployeePayrollRuns.RequestOptions`
@@ -21173,9 +15196,7 @@ await client.crm.passthrough.create({
-## Crm RegenerateKey
-
-client.crm.regenerateKey.create({ ...params }) -> Merge.RemoteKey
+client.hris.employeePayrollRuns.retrieve(id, { ...params }) -> Merge.EmployeePayrollRun
-
@@ -21187,7 +15208,7 @@ await client.crm.passthrough.create({
-
-Exchange remote keys.
+Returns an `EmployeePayrollRun` object with the given `id`.
@@ -21203,9 +15224,7 @@ Exchange remote keys.
-
```typescript
-await client.crm.regenerateKey.create({
- name: "Remote Deployment Key 1",
-});
+await client.hris.employeePayrollRuns.retrieve("id");
```
@@ -21221,7 +15240,7 @@ await client.crm.regenerateKey.create({
-
-**request:** `Merge.crm.RemoteKeyForRegenerationRequest`
+**id:** `string`
@@ -21229,7 +15248,15 @@ await client.crm.regenerateKey.create({
-
-**requestOptions:** `RegenerateKey.RequestOptions`
+**request:** `Merge.hris.EmployeePayrollRunsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EmployeePayrollRuns.RequestOptions`
@@ -21240,9 +15267,9 @@ await client.crm.regenerateKey.create({
-## Crm Stages
+## Hris Employees
-client.crm.stages.list({ ...params }) -> Merge.PaginatedStageList
+client.hris.employees.list({ ...params }) -> Merge.PaginatedEmployeeList
-
@@ -21254,7 +15281,7 @@ await client.crm.regenerateKey.create({
-
-Returns a list of `Stage` objects.
+Returns a list of `Employee` objects.
@@ -21270,7 +15297,7 @@ Returns a list of `Stage` objects.
-
```typescript
-await client.crm.stages.list();
+await client.hris.employees.list();
```
@@ -21286,7 +15313,7 @@ await client.crm.stages.list();
-
-**request:** `Merge.crm.StagesListRequest`
+**request:** `Merge.hris.EmployeesListRequest`
@@ -21294,7 +15321,7 @@ await client.crm.stages.list();
-
-**requestOptions:** `Stages.RequestOptions`
+**requestOptions:** `Employees.RequestOptions`
@@ -21305,7 +15332,7 @@ await client.crm.stages.list();
-client.crm.stages.retrieve(id, { ...params }) -> Merge.Stage
+client.hris.employees.create({ ...params }) -> Merge.EmployeeResponse
-
@@ -21317,7 +15344,7 @@ await client.crm.stages.list();
-
-Returns a `Stage` object with the given `id`.
+Creates an `Employee` object with the given values.
@@ -21333,7 +15360,9 @@ Returns a `Stage` object with the given `id`.
-
```typescript
-await client.crm.stages.retrieve("id");
+await client.hris.employees.create({
+ model: {},
+});
```
@@ -21349,15 +15378,7 @@ await client.crm.stages.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.StagesRetrieveRequest`
+**request:** `Merge.hris.EmployeeEndpointRequest`
@@ -21365,7 +15386,7 @@ await client.crm.stages.retrieve("id");
-
-**requestOptions:** `Stages.RequestOptions`
+**requestOptions:** `Employees.RequestOptions`
@@ -21376,7 +15397,7 @@ await client.crm.stages.retrieve("id");
-client.crm.stages.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.hris.employees.retrieve(id, { ...params }) -> Merge.Employee
-
@@ -21388,7 +15409,7 @@ await client.crm.stages.retrieve("id");
-
-Returns a list of `RemoteFieldClass` objects.
+Returns an `Employee` object with the given `id`.
@@ -21404,7 +15425,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.stages.remoteFieldClassesList();
+await client.hris.employees.retrieve("id");
```
@@ -21420,7 +15441,7 @@ await client.crm.stages.remoteFieldClassesList();
-
-**request:** `Merge.crm.StagesRemoteFieldClassesListRequest`
+**id:** `string`
@@ -21428,7 +15449,15 @@ await client.crm.stages.remoteFieldClassesList();
-
-**requestOptions:** `Stages.RequestOptions`
+**request:** `Merge.hris.EmployeesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Employees.RequestOptions`
@@ -21439,9 +15468,7 @@ await client.crm.stages.remoteFieldClassesList();
-## Crm SyncStatus
-
-client.crm.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+client.hris.employees.ignoreCreate(modelId, { ...params }) -> void
-
@@ -21453,7 +15480,7 @@ await client.crm.stages.remoteFieldClassesList();
-
-Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+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.
@@ -21469,7 +15496,9 @@ Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SY
-
```typescript
-await client.crm.syncStatus.list();
+await client.hris.employees.ignoreCreate("model_id", {
+ reason: "GENERAL_CUSTOMER_REQUEST",
+});
```
@@ -21485,7 +15514,7 @@ await client.crm.syncStatus.list();
-
-**request:** `Merge.crm.SyncStatusListRequest`
+**modelId:** `string`
@@ -21493,7 +15522,15 @@ await client.crm.syncStatus.list();
-
-**requestOptions:** `SyncStatus.RequestOptions`
+**request:** `Merge.hris.IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Employees.RequestOptions`
@@ -21504,9 +15541,7 @@ await client.crm.syncStatus.list();
-## Crm ForceResync
-
-client.crm.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+client.hris.employees.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -21518,7 +15553,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 metadata for `Employee` POSTs.
@@ -21534,7 +15569,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
-
```typescript
-await client.crm.forceResync.syncStatusResyncCreate();
+await client.hris.employees.metaPostRetrieve();
```
@@ -21550,7 +15585,7 @@ await client.crm.forceResync.syncStatusResyncCreate();
-
-**requestOptions:** `ForceResync.RequestOptions`
+**requestOptions:** `Employees.RequestOptions`
@@ -21561,9 +15596,9 @@ await client.crm.forceResync.syncStatusResyncCreate();
-## Crm Tasks
+## Hris EmployerBenefits
-client.crm.tasks.list({ ...params }) -> Merge.PaginatedTaskList
+client.hris.employerBenefits.list({ ...params }) -> Merge.PaginatedEmployerBenefitList
-
@@ -21575,7 +15610,7 @@ await client.crm.forceResync.syncStatusResyncCreate();
-
-Returns a list of `Task` objects.
+Returns a list of `EmployerBenefit` objects.
@@ -21591,7 +15626,7 @@ Returns a list of `Task` objects.
-
```typescript
-await client.crm.tasks.list();
+await client.hris.employerBenefits.list();
```
@@ -21607,7 +15642,7 @@ await client.crm.tasks.list();
-
-**request:** `Merge.crm.TasksListRequest`
+**request:** `Merge.hris.EmployerBenefitsListRequest`
@@ -21615,7 +15650,7 @@ await client.crm.tasks.list();
-
-**requestOptions:** `Tasks.RequestOptions`
+**requestOptions:** `EmployerBenefits.RequestOptions`
@@ -21626,7 +15661,7 @@ await client.crm.tasks.list();
-client.crm.tasks.create({ ...params }) -> Merge.TaskResponse
+client.hris.employerBenefits.retrieve(id, { ...params }) -> Merge.EmployerBenefit
-
@@ -21638,7 +15673,7 @@ await client.crm.tasks.list();
-
-Creates a `Task` object with the given values.
+Returns an `EmployerBenefit` object with the given `id`.
@@ -21654,9 +15689,7 @@ Creates a `Task` object with the given values.
-
```typescript
-await client.crm.tasks.create({
- model: {},
-});
+await client.hris.employerBenefits.retrieve("id");
```
@@ -21672,7 +15705,7 @@ await client.crm.tasks.create({
-
-**request:** `Merge.crm.TaskEndpointRequest`
+**id:** `string`
@@ -21680,7 +15713,15 @@ await client.crm.tasks.create({
-
-**requestOptions:** `Tasks.RequestOptions`
+**request:** `Merge.hris.EmployerBenefitsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EmployerBenefits.RequestOptions`
@@ -21691,7 +15732,9 @@ await client.crm.tasks.create({
-client.crm.tasks.retrieve(id, { ...params }) -> Merge.Task
+## Hris Employments
+
+client.hris.employments.list({ ...params }) -> Merge.PaginatedEmploymentList
-
@@ -21703,7 +15746,7 @@ await client.crm.tasks.create({
-
-Returns a `Task` object with the given `id`.
+Returns a list of `Employment` objects.
@@ -21719,7 +15762,7 @@ Returns a `Task` object with the given `id`.
-
```typescript
-await client.crm.tasks.retrieve("id");
+await client.hris.employments.list();
```
@@ -21735,15 +15778,7 @@ await client.crm.tasks.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.TasksRetrieveRequest`
+**request:** `Merge.hris.EmploymentsListRequest`
@@ -21751,7 +15786,7 @@ await client.crm.tasks.retrieve("id");
-
-**requestOptions:** `Tasks.RequestOptions`
+**requestOptions:** `Employments.RequestOptions`
@@ -21762,7 +15797,7 @@ await client.crm.tasks.retrieve("id");
-client.crm.tasks.partialUpdate(id, { ...params }) -> Merge.TaskResponse
+client.hris.employments.retrieve(id, { ...params }) -> Merge.Employment
-
@@ -21774,7 +15809,7 @@ await client.crm.tasks.retrieve("id");
-
-Updates a `Task` object with the given `id`.
+Returns an `Employment` object with the given `id`.
@@ -21790,9 +15825,7 @@ Updates a `Task` object with the given `id`.
-
```typescript
-await client.crm.tasks.partialUpdate("id", {
- model: {},
-});
+await client.hris.employments.retrieve("id");
```
@@ -21816,7 +15849,7 @@ await client.crm.tasks.partialUpdate("id", {
-
-**request:** `Merge.crm.PatchedTaskEndpointRequest`
+**request:** `Merge.hris.EmploymentsRetrieveRequest`
@@ -21824,7 +15857,7 @@ await client.crm.tasks.partialUpdate("id", {
-
-**requestOptions:** `Tasks.RequestOptions`
+**requestOptions:** `Employments.RequestOptions`
@@ -21835,7 +15868,9 @@ await client.crm.tasks.partialUpdate("id", {
-client.crm.tasks.metaPatchRetrieve(id) -> Merge.MetaResponse
+## Hris FieldMapping
+
+client.hris.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
-
@@ -21847,7 +15882,7 @@ await client.crm.tasks.partialUpdate("id", {
-
-Returns metadata for `Task` PATCHs.
+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/).
@@ -21863,7 +15898,7 @@ Returns metadata for `Task` PATCHs.
-
```typescript
-await client.crm.tasks.metaPatchRetrieve("id");
+await client.hris.fieldMapping.fieldMappingsRetrieve();
```
@@ -21879,7 +15914,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-
-**id:** `string`
+**request:** `Merge.hris.FieldMappingsRetrieveRequest`
@@ -21887,7 +15922,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-
-**requestOptions:** `Tasks.RequestOptions`
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -21898,7 +15933,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse
+client.hris.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
-
@@ -21910,7 +15945,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-
-Returns metadata for `Task` POSTs.
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -21926,7 +15961,14 @@ Returns metadata for `Task` POSTs.
-
```typescript
-await client.crm.tasks.metaPostRetrieve();
+await client.hris.fieldMapping.fieldMappingsCreate({
+ targetFieldName: "example_target_field_name",
+ targetFieldDescription: "this is a example description of the target field",
+ remoteFieldTraversalPath: ["example_remote_field"],
+ remoteMethod: "GET",
+ remoteUrlPath: "/example-url-path",
+ commonModelName: "ExampleCommonModel",
+});
```
@@ -21942,7 +15984,15 @@ await client.crm.tasks.metaPostRetrieve();
-
-**requestOptions:** `Tasks.RequestOptions`
+**request:** `Merge.hris.CreateFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -21953,7 +16003,7 @@ await client.crm.tasks.metaPostRetrieve();
-client.crm.tasks.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.hris.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
-
@@ -21965,7 +16015,7 @@ await client.crm.tasks.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -21981,7 +16031,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.tasks.remoteFieldClassesList();
+await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
```
@@ -21997,7 +16047,7 @@ await client.crm.tasks.remoteFieldClassesList();
-
-**request:** `Merge.crm.TasksRemoteFieldClassesListRequest`
+**fieldMappingId:** `string`
@@ -22005,7 +16055,7 @@ await client.crm.tasks.remoteFieldClassesList();
-
-**requestOptions:** `Tasks.RequestOptions`
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -22016,9 +16066,7 @@ await client.crm.tasks.remoteFieldClassesList();
-## Crm Users
-
-client.crm.users.list({ ...params }) -> Merge.PaginatedUserList
+client.hris.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
-
@@ -22030,7 +16078,7 @@ await client.crm.tasks.remoteFieldClassesList();
-
-Returns a list of `User` objects.
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -22046,7 +16094,7 @@ Returns a list of `User` objects.
-
```typescript
-await client.crm.users.list();
+await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
```
@@ -22062,7 +16110,7 @@ await client.crm.users.list();
-
-**request:** `Merge.crm.UsersListRequest`
+**fieldMappingId:** `string`
@@ -22070,7 +16118,15 @@ await client.crm.users.list();
-
-**requestOptions:** `Users.RequestOptions`
+**request:** `Merge.hris.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -22081,7 +16137,7 @@ await client.crm.users.list();
-client.crm.users.retrieve(id, { ...params }) -> Merge.User
+client.hris.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
-
@@ -22093,7 +16149,7 @@ await client.crm.users.list();
-
-Returns a `User` object with the given `id`.
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -22109,7 +16165,7 @@ Returns a `User` object with the given `id`.
-
```typescript
-await client.crm.users.retrieve("id");
+await client.hris.fieldMapping.remoteFieldsRetrieve();
```
@@ -22125,15 +16181,7 @@ await client.crm.users.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.UsersRetrieveRequest`
+**request:** `Merge.hris.RemoteFieldsRetrieveRequest`
@@ -22141,7 +16189,7 @@ await client.crm.users.retrieve("id");
-
-**requestOptions:** `Users.RequestOptions`
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -22152,7 +16200,7 @@ await client.crm.users.retrieve("id");
-client.crm.users.ignoreCreate(modelId, { ...params }) -> void
+client.hris.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
-
@@ -22164,7 +16212,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.
+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/).
@@ -22180,9 +16228,7 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
-
```typescript
-await client.crm.users.ignoreCreate("model_id", {
- reason: "GENERAL_CUSTOMER_REQUEST",
-});
+await client.hris.fieldMapping.targetFieldsRetrieve();
```
@@ -22198,23 +16244,7 @@ await client.crm.users.ignoreCreate("model_id", {
-
-**modelId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.IgnoreCommonModelRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Users.RequestOptions`
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -22225,7 +16255,9 @@ await client.crm.users.ignoreCreate("model_id", {
-client.crm.users.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+## Hris GenerateKey
+
+client.hris.generateKey.create({ ...params }) -> Merge.RemoteKey
-
@@ -22237,7 +16269,7 @@ await client.crm.users.ignoreCreate("model_id", {
-
-Returns a list of `RemoteFieldClass` objects.
+Create a remote key.
@@ -22253,7 +16285,9 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.users.remoteFieldClassesList();
+await client.hris.generateKey.create({
+ name: "Remote Deployment Key 1",
+});
```
@@ -22269,7 +16303,7 @@ await client.crm.users.remoteFieldClassesList();
-
-**request:** `Merge.crm.UsersRemoteFieldClassesListRequest`
+**request:** `Merge.hris.GenerateRemoteKeyRequest`
@@ -22277,7 +16311,7 @@ await client.crm.users.remoteFieldClassesList();
-
-**requestOptions:** `Users.RequestOptions`
+**requestOptions:** `GenerateKey.RequestOptions`
@@ -22288,9 +16322,9 @@ await client.crm.users.remoteFieldClassesList();
-## Crm WebhookReceivers
+## Hris Groups
-client.crm.webhookReceivers.list() -> Merge.WebhookReceiver[]
+client.hris.groups.list({ ...params }) -> Merge.PaginatedGroupList
-
@@ -22302,7 +16336,7 @@ await client.crm.users.remoteFieldClassesList();
-
-Returns a list of `WebhookReceiver` objects.
+Returns a list of `Group` objects.
@@ -22318,7 +16352,7 @@ Returns a list of `WebhookReceiver` objects.
-
```typescript
-await client.crm.webhookReceivers.list();
+await client.hris.groups.list();
```
@@ -22334,7 +16368,15 @@ await client.crm.webhookReceivers.list();
-
-**requestOptions:** `WebhookReceivers.RequestOptions`
+**request:** `Merge.hris.GroupsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Groups.RequestOptions`
@@ -22345,7 +16387,7 @@ await client.crm.webhookReceivers.list();
-client.crm.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
+client.hris.groups.retrieve(id, { ...params }) -> Merge.Group
-
@@ -22357,7 +16399,7 @@ await client.crm.webhookReceivers.list();
-
-Creates a `WebhookReceiver` object with the given values.
+Returns a `Group` object with the given `id`.
@@ -22373,10 +16415,7 @@ Creates a `WebhookReceiver` object with the given values.
-
```typescript
-await client.crm.webhookReceivers.create({
- event: "event",
- isActive: true,
-});
+await client.hris.groups.retrieve("id");
```
@@ -22392,7 +16431,7 @@ await client.crm.webhookReceivers.create({
-
-**request:** `Merge.crm.WebhookReceiverRequest`
+**id:** `string`
@@ -22400,7 +16439,15 @@ await client.crm.webhookReceivers.create({
-
-**requestOptions:** `WebhookReceivers.RequestOptions`
+**request:** `Merge.hris.GroupsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Groups.RequestOptions`
@@ -22411,9 +16458,9 @@ await client.crm.webhookReceivers.create({
-## Accounting AccountDetails
+## Hris Issues
-client.accounting.accountDetails.retrieve() -> Merge.AccountDetails
+client.hris.issues.list({ ...params }) -> Merge.PaginatedIssueList
-
@@ -22425,7 +16472,7 @@ await client.crm.webhookReceivers.create({
-
-Get details for a linked account.
+Gets all issues for Organization.
@@ -22441,7 +16488,7 @@ Get details for a linked account.
-
```typescript
-await client.accounting.accountDetails.retrieve();
+await client.hris.issues.list();
```
@@ -22457,7 +16504,15 @@ await client.accounting.accountDetails.retrieve();
-
-**requestOptions:** `AccountDetails.RequestOptions`
+**request:** `Merge.hris.IssuesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Issues.RequestOptions`
@@ -22468,9 +16523,7 @@ await client.accounting.accountDetails.retrieve();
-## Accounting AccountToken
-
-client.accounting.accountToken.retrieve(publicToken) -> Merge.AccountToken
+client.hris.issues.retrieve(id) -> Merge.Issue
-
@@ -22482,7 +16535,7 @@ await client.accounting.accountDetails.retrieve();
-
-Returns the account token for the end user with the provided public token.
+Get a specific issue.
@@ -22498,7 +16551,7 @@ Returns the account token for the end user with the provided public token.
-
```typescript
-await client.accounting.accountToken.retrieve("public_token");
+await client.hris.issues.retrieve("id");
```
@@ -22514,7 +16567,7 @@ await client.accounting.accountToken.retrieve("public_token");
-
-**publicToken:** `string`
+**id:** `string`
@@ -22522,7 +16575,7 @@ await client.accounting.accountToken.retrieve("public_token");
-
-**requestOptions:** `AccountToken.RequestOptions`
+**requestOptions:** `Issues.RequestOptions`
@@ -22533,9 +16586,9 @@ await client.accounting.accountToken.retrieve("public_token");
-## Accounting AccountingPeriods
+## Hris LinkToken
-client.accounting.accountingPeriods.list({ ...params }) -> Merge.PaginatedAccountingPeriodList
+client.hris.linkToken.create({ ...params }) -> Merge.LinkToken
-
@@ -22547,7 +16600,7 @@ await client.accounting.accountToken.retrieve("public_token");
-
-Returns a list of `AccountingPeriod` objects.
+Creates a link token to be used when linking a new end user.
@@ -22563,7 +16616,12 @@ Returns a list of `AccountingPeriod` objects.
-
```typescript
-await client.accounting.accountingPeriods.list();
+await client.hris.linkToken.create({
+ endUserEmailAddress: "example@gmail.com",
+ endUserOrganizationName: "Test Organization",
+ endUserOriginId: "12345",
+ categories: ["hris", "ats"],
+});
```
@@ -22579,7 +16637,7 @@ await client.accounting.accountingPeriods.list();
-
-**request:** `Merge.accounting.AccountingPeriodsListRequest`
+**request:** `Merge.hris.EndUserDetailsRequest`
@@ -22587,7 +16645,7 @@ await client.accounting.accountingPeriods.list();
-
-**requestOptions:** `AccountingPeriods.RequestOptions`
+**requestOptions:** `LinkToken.RequestOptions`
@@ -22598,7 +16656,9 @@ await client.accounting.accountingPeriods.list();
-client.accounting.accountingPeriods.retrieve(id, { ...params }) -> Merge.AccountingPeriod
+## Hris LinkedAccounts
+
+client.hris.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
-
@@ -22610,7 +16670,7 @@ await client.accounting.accountingPeriods.list();
-
-Returns an `AccountingPeriod` object with the given `id`.
+List linked accounts for your organization.
@@ -22626,7 +16686,7 @@ Returns an `AccountingPeriod` object with the given `id`.
-
```typescript
-await client.accounting.accountingPeriods.retrieve("id");
+await client.hris.linkedAccounts.list();
```
@@ -22642,15 +16702,7 @@ await client.accounting.accountingPeriods.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.AccountingPeriodsRetrieveRequest`
+**request:** `Merge.hris.LinkedAccountsListRequest`
@@ -22658,7 +16710,7 @@ await client.accounting.accountingPeriods.retrieve("id");
-
-**requestOptions:** `AccountingPeriods.RequestOptions`
+**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -22669,9 +16721,9 @@ await client.accounting.accountingPeriods.retrieve("id");
-## Accounting Accounts
+## Hris Locations
-client.accounting.accounts.list({ ...params }) -> Merge.PaginatedAccountList
+client.hris.locations.list({ ...params }) -> Merge.PaginatedLocationList
-
@@ -22683,7 +16735,7 @@ await client.accounting.accountingPeriods.retrieve("id");
-
-Returns a list of `Account` objects.
+Returns a list of `Location` objects.
@@ -22699,7 +16751,7 @@ Returns a list of `Account` objects.
-
```typescript
-await client.accounting.accounts.list();
+await client.hris.locations.list();
```
@@ -22715,7 +16767,7 @@ await client.accounting.accounts.list();
-
-**request:** `Merge.accounting.AccountsListRequest`
+**request:** `Merge.hris.LocationsListRequest`
@@ -22723,7 +16775,7 @@ await client.accounting.accounts.list();
-
-**requestOptions:** `Accounts.RequestOptions`
+**requestOptions:** `Locations.RequestOptions`
@@ -22734,7 +16786,7 @@ await client.accounting.accounts.list();
-client.accounting.accounts.create({ ...params }) -> Merge.AccountResponse
+client.hris.locations.retrieve(id, { ...params }) -> Merge.Location
-
@@ -22746,7 +16798,7 @@ await client.accounting.accounts.list();
-
-Creates an `Account` object with the given values.
+Returns a `Location` object with the given `id`.
@@ -22762,9 +16814,7 @@ Creates an `Account` object with the given values.
-
```typescript
-await client.accounting.accounts.create({
- model: {},
-});
+await client.hris.locations.retrieve("id");
```
@@ -22780,7 +16830,7 @@ await client.accounting.accounts.create({
-
-**request:** `Merge.accounting.AccountEndpointRequest`
+**id:** `string`
@@ -22788,7 +16838,15 @@ await client.accounting.accounts.create({
-
-**requestOptions:** `Accounts.RequestOptions`
+**request:** `Merge.hris.LocationsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Locations.RequestOptions`
@@ -22799,7 +16857,9 @@ await client.accounting.accounts.create({
-client.accounting.accounts.retrieve(id, { ...params }) -> Merge.Account
+## Hris Passthrough
+
+client.hris.passthrough.create({ ...params }) -> Merge.RemoteResponse
-
@@ -22811,7 +16871,7 @@ await client.accounting.accounts.create({
-
-Returns an `Account` object with the given `id`.
+Pull data from an endpoint not currently supported by Merge.
@@ -22827,7 +16887,10 @@ Returns an `Account` object with the given `id`.
-
```typescript
-await client.accounting.accounts.retrieve("id");
+await client.hris.passthrough.create({
+ method: "GET",
+ path: "/scooters",
+});
```
@@ -22843,15 +16906,7 @@ await client.accounting.accounts.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.AccountsRetrieveRequest`
+**request:** `Merge.DataPassthroughRequest`
@@ -22859,7 +16914,7 @@ await client.accounting.accounts.retrieve("id");
-
-**requestOptions:** `Accounts.RequestOptions`
+**requestOptions:** `Passthrough.RequestOptions`
@@ -22870,7 +16925,9 @@ await client.accounting.accounts.retrieve("id");
-client.accounting.accounts.metaPostRetrieve() -> Merge.MetaResponse
+## Hris PayGroups
+
+client.hris.payGroups.list({ ...params }) -> Merge.PaginatedPayGroupList
-
@@ -22882,7 +16939,7 @@ await client.accounting.accounts.retrieve("id");
-
-Returns metadata for `Account` POSTs.
+Returns a list of `PayGroup` objects.
@@ -22898,7 +16955,7 @@ Returns metadata for `Account` POSTs.
-
```typescript
-await client.accounting.accounts.metaPostRetrieve();
+await client.hris.payGroups.list();
```
@@ -22914,7 +16971,15 @@ await client.accounting.accounts.metaPostRetrieve();
-
-**requestOptions:** `Accounts.RequestOptions`
+**request:** `Merge.hris.PayGroupsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PayGroups.RequestOptions`
@@ -22925,9 +16990,7 @@ await client.accounting.accounts.metaPostRetrieve();
-## Accounting Addresses
-
-client.accounting.addresses.retrieve(id, { ...params }) -> Merge.Address
+client.hris.payGroups.retrieve(id, { ...params }) -> Merge.PayGroup
-
@@ -22939,7 +17002,7 @@ await client.accounting.accounts.metaPostRetrieve();
-
-Returns an `Address` object with the given `id`.
+Returns a `PayGroup` object with the given `id`.
@@ -22955,7 +17018,7 @@ Returns an `Address` object with the given `id`.
-
```typescript
-await client.accounting.addresses.retrieve("id");
+await client.hris.payGroups.retrieve("id");
```
@@ -22979,7 +17042,7 @@ await client.accounting.addresses.retrieve("id");
-
-**request:** `Merge.accounting.AddressesRetrieveRequest`
+**request:** `Merge.hris.PayGroupsRetrieveRequest`
@@ -22987,7 +17050,7 @@ await client.accounting.addresses.retrieve("id");
-
-**requestOptions:** `Addresses.RequestOptions`
+**requestOptions:** `PayGroups.RequestOptions`
@@ -22998,9 +17061,9 @@ await client.accounting.addresses.retrieve("id");
-## Accounting AsyncPassthrough
+## Hris PayrollRuns
-client.accounting.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
+client.hris.payrollRuns.list({ ...params }) -> Merge.PaginatedPayrollRunList
-
@@ -23012,7 +17075,7 @@ await client.accounting.addresses.retrieve("id");
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns a list of `PayrollRun` objects.
@@ -23028,10 +17091,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.accounting.asyncPassthrough.create({
- method: "GET",
- path: "/scooters",
-});
+await client.hris.payrollRuns.list();
```
@@ -23047,7 +17107,7 @@ await client.accounting.asyncPassthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
+**request:** `Merge.hris.PayrollRunsListRequest`
@@ -23055,7 +17115,7 @@ await client.accounting.asyncPassthrough.create({
-
-**requestOptions:** `AsyncPassthrough.RequestOptions`
+**requestOptions:** `PayrollRuns.RequestOptions`
@@ -23066,7 +17126,7 @@ await client.accounting.asyncPassthrough.create({
-client.accounting.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
+client.hris.payrollRuns.retrieve(id, { ...params }) -> Merge.PayrollRun
-
@@ -23078,7 +17138,7 @@ await client.accounting.asyncPassthrough.create({
-
-Retrieves data from earlier async-passthrough POST request
+Returns a `PayrollRun` object with the given `id`.
@@ -23094,7 +17154,7 @@ Retrieves data from earlier async-passthrough POST request
-
```typescript
-await client.accounting.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+await client.hris.payrollRuns.retrieve("id");
```
@@ -23110,7 +17170,7 @@ await client.accounting.asyncPassthrough.retrieve("async_passthrough_receipt_id"
-
-**asyncPassthroughReceiptId:** `string`
+**id:** `string`
@@ -23118,7 +17178,15 @@ await client.accounting.asyncPassthrough.retrieve("async_passthrough_receipt_id"
-
-**requestOptions:** `AsyncPassthrough.RequestOptions`
+**request:** `Merge.hris.PayrollRunsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PayrollRuns.RequestOptions`
@@ -23129,9 +17197,9 @@ await client.accounting.asyncPassthrough.retrieve("async_passthrough_receipt_id"
-## Accounting AsyncTasks
+## Hris RegenerateKey
-client.accounting.asyncTasks.retrieve(id) -> Merge.AsyncPostTask
+client.hris.regenerateKey.create({ ...params }) -> Merge.RemoteKey
-
@@ -23143,7 +17211,7 @@ await client.accounting.asyncPassthrough.retrieve("async_passthrough_receipt_id"
-
-Returns an `AsyncPostTask` object with the given `id`.
+Exchange remote keys.
@@ -23159,7 +17227,9 @@ Returns an `AsyncPostTask` object with the given `id`.
-
```typescript
-await client.accounting.asyncTasks.retrieve("id");
+await client.hris.regenerateKey.create({
+ name: "Remote Deployment Key 1",
+});
```
@@ -23175,7 +17245,7 @@ await client.accounting.asyncTasks.retrieve("id");
-
-**id:** `string`
+**request:** `Merge.hris.RemoteKeyForRegenerationRequest`
@@ -23183,7 +17253,7 @@ await client.accounting.asyncTasks.retrieve("id");
-
-**requestOptions:** `AsyncTasks.RequestOptions`
+**requestOptions:** `RegenerateKey.RequestOptions`
@@ -23194,9 +17264,9 @@ await client.accounting.asyncTasks.retrieve("id");
-## Accounting Attachments
+## Hris SyncStatus
-client.accounting.attachments.list({ ...params }) -> Merge.PaginatedAccountingAttachmentList
+client.hris.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
-
@@ -23208,7 +17278,7 @@ await client.accounting.asyncTasks.retrieve("id");
-
-Returns a list of `AccountingAttachment` 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).
@@ -23224,7 +17294,7 @@ Returns a list of `AccountingAttachment` objects.
-
```typescript
-await client.accounting.attachments.list();
+await client.hris.syncStatus.list();
```
@@ -23240,7 +17310,7 @@ await client.accounting.attachments.list();
-
-**request:** `Merge.accounting.AttachmentsListRequest`
+**request:** `Merge.hris.SyncStatusListRequest`
@@ -23248,7 +17318,7 @@ await client.accounting.attachments.list();
-
-**requestOptions:** `Attachments.RequestOptions`
+**requestOptions:** `SyncStatus.RequestOptions`
@@ -23259,7 +17329,9 @@ await client.accounting.attachments.list();
-client.accounting.attachments.create({ ...params }) -> Merge.AccountingAttachmentResponse
+## Hris ForceResync
+
+client.hris.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
-
@@ -23271,7 +17343,7 @@ await client.accounting.attachments.list();
-
-Creates an `AccountingAttachment` object with the given values.
+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.
@@ -23287,9 +17359,7 @@ Creates an `AccountingAttachment` object with the given values.
-
```typescript
-await client.accounting.attachments.create({
- model: {},
-});
+await client.hris.forceResync.syncStatusResyncCreate();
```
@@ -23305,15 +17375,7 @@ await client.accounting.attachments.create({
-
-**request:** `Merge.accounting.AccountingAttachmentEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Attachments.RequestOptions`
+**requestOptions:** `ForceResync.RequestOptions`
@@ -23324,7 +17386,9 @@ await client.accounting.attachments.create({
-client.accounting.attachments.retrieve(id, { ...params }) -> Merge.AccountingAttachment
+## Hris Teams
+
+client.hris.teams.list({ ...params }) -> Merge.PaginatedTeamList
-
@@ -23336,7 +17400,7 @@ await client.accounting.attachments.create({
-
-Returns an `AccountingAttachment` object with the given `id`.
+Returns a list of `Team` objects.
@@ -23352,7 +17416,7 @@ Returns an `AccountingAttachment` object with the given `id`.
-
```typescript
-await client.accounting.attachments.retrieve("id");
+await client.hris.teams.list();
```
@@ -23368,15 +17432,7 @@ await client.accounting.attachments.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.AttachmentsRetrieveRequest`
+**request:** `Merge.hris.TeamsListRequest`
@@ -23384,7 +17440,7 @@ await client.accounting.attachments.retrieve("id");
-
-**requestOptions:** `Attachments.RequestOptions`
+**requestOptions:** `Teams.RequestOptions`
@@ -23395,7 +17451,7 @@ await client.accounting.attachments.retrieve("id");
-client.accounting.attachments.metaPostRetrieve() -> Merge.MetaResponse
+client.hris.teams.retrieve(id, { ...params }) -> Merge.Team
-
@@ -23407,7 +17463,7 @@ await client.accounting.attachments.retrieve("id");
-
-Returns metadata for `AccountingAttachment` POSTs.
+Returns a `Team` object with the given `id`.
@@ -23423,7 +17479,7 @@ Returns metadata for `AccountingAttachment` POSTs.
-
```typescript
-await client.accounting.attachments.metaPostRetrieve();
+await client.hris.teams.retrieve("id");
```
@@ -23439,7 +17495,23 @@ await client.accounting.attachments.metaPostRetrieve();
-
-**requestOptions:** `Attachments.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.TeamsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Teams.RequestOptions`
@@ -23450,9 +17522,9 @@ await client.accounting.attachments.metaPostRetrieve();
-## Accounting AuditTrail
+## Hris TimeOff
-client.accounting.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+client.hris.timeOff.list({ ...params }) -> Merge.PaginatedTimeOffList
-
@@ -23464,7 +17536,7 @@ await client.accounting.attachments.metaPostRetrieve();
-
-Gets a list of audit trail events.
+Returns a list of `TimeOff` objects.
@@ -23480,7 +17552,7 @@ Gets a list of audit trail events.
-
```typescript
-await client.accounting.auditTrail.list();
+await client.hris.timeOff.list();
```
@@ -23496,7 +17568,7 @@ await client.accounting.auditTrail.list();
-
-**request:** `Merge.accounting.AuditTrailListRequest`
+**request:** `Merge.hris.TimeOffListRequest`
@@ -23504,7 +17576,7 @@ await client.accounting.auditTrail.list();
-
-**requestOptions:** `AuditTrail.RequestOptions`
+**requestOptions:** `TimeOff.RequestOptions`
@@ -23515,9 +17587,7 @@ await client.accounting.auditTrail.list();
-## Accounting AvailableActions
-
-client.accounting.availableActions.retrieve() -> Merge.AvailableActions
+client.hris.timeOff.create({ ...params }) -> Merge.TimeOffResponse
-
@@ -23529,7 +17599,7 @@ await client.accounting.auditTrail.list();
-
-Returns a list of models and actions available for an account.
+Creates a `TimeOff` object with the given values.
@@ -23545,7 +17615,9 @@ Returns a list of models and actions available for an account.
-
```typescript
-await client.accounting.availableActions.retrieve();
+await client.hris.timeOff.create({
+ model: {},
+});
```
@@ -23561,7 +17633,15 @@ await client.accounting.availableActions.retrieve();
-
-**requestOptions:** `AvailableActions.RequestOptions`
+**request:** `Merge.hris.TimeOffEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimeOff.RequestOptions`
@@ -23572,9 +17652,7 @@ await client.accounting.availableActions.retrieve();
-## Accounting BalanceSheets
-
-client.accounting.balanceSheets.list({ ...params }) -> Merge.PaginatedBalanceSheetList
+client.hris.timeOff.retrieve(id, { ...params }) -> Merge.TimeOff
-
@@ -23586,7 +17664,7 @@ await client.accounting.availableActions.retrieve();
-
-Returns a list of `BalanceSheet` objects.
+Returns a `TimeOff` object with the given `id`.
@@ -23602,7 +17680,7 @@ Returns a list of `BalanceSheet` objects.
-
```typescript
-await client.accounting.balanceSheets.list();
+await client.hris.timeOff.retrieve("id");
```
@@ -23618,7 +17696,7 @@ await client.accounting.balanceSheets.list();
-
-**request:** `Merge.accounting.BalanceSheetsListRequest`
+**id:** `string`
@@ -23626,7 +17704,15 @@ await client.accounting.balanceSheets.list();
-
-**requestOptions:** `BalanceSheets.RequestOptions`
+**request:** `Merge.hris.TimeOffRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimeOff.RequestOptions`
@@ -23637,7 +17723,7 @@ await client.accounting.balanceSheets.list();
-client.accounting.balanceSheets.retrieve(id, { ...params }) -> Merge.BalanceSheet
+client.hris.timeOff.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -23649,7 +17735,7 @@ await client.accounting.balanceSheets.list();
-
-Returns a `BalanceSheet` object with the given `id`.
+Returns metadata for `TimeOff` POSTs.
@@ -23665,7 +17751,7 @@ Returns a `BalanceSheet` object with the given `id`.
-
```typescript
-await client.accounting.balanceSheets.retrieve("id");
+await client.hris.timeOff.metaPostRetrieve();
```
@@ -23681,23 +17767,7 @@ await client.accounting.balanceSheets.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.BalanceSheetsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `BalanceSheets.RequestOptions`
+**requestOptions:** `TimeOff.RequestOptions`
@@ -23708,9 +17778,9 @@ await client.accounting.balanceSheets.retrieve("id");
-## Accounting BankFeedAccounts
+## Hris TimeOffBalances
-client.accounting.bankFeedAccounts.list({ ...params }) -> Merge.PaginatedBankFeedAccountList
+client.hris.timeOffBalances.list({ ...params }) -> Merge.PaginatedTimeOffBalanceList
-
@@ -23722,7 +17792,7 @@ await client.accounting.balanceSheets.retrieve("id");
-
-Returns a list of `BankFeedAccount` objects.
+Returns a list of `TimeOffBalance` objects.
@@ -23738,7 +17808,7 @@ Returns a list of `BankFeedAccount` objects.
-
```typescript
-await client.accounting.bankFeedAccounts.list();
+await client.hris.timeOffBalances.list();
```
@@ -23754,7 +17824,7 @@ await client.accounting.bankFeedAccounts.list();
-
-**request:** `Merge.accounting.BankFeedAccountsListRequest`
+**request:** `Merge.hris.TimeOffBalancesListRequest`
@@ -23762,7 +17832,7 @@ await client.accounting.bankFeedAccounts.list();
-
-**requestOptions:** `BankFeedAccounts.RequestOptions`
+**requestOptions:** `TimeOffBalances.RequestOptions`
@@ -23773,7 +17843,7 @@ await client.accounting.bankFeedAccounts.list();
-client.accounting.bankFeedAccounts.create({ ...params }) -> Merge.BankFeedAccountResponse
+client.hris.timeOffBalances.retrieve(id, { ...params }) -> Merge.TimeOffBalance
-
@@ -23785,7 +17855,7 @@ await client.accounting.bankFeedAccounts.list();
-
-Creates a `BankFeedAccount` object with the given values.
+Returns a `TimeOffBalance` object with the given `id`.
@@ -23801,9 +17871,7 @@ Creates a `BankFeedAccount` object with the given values.
-
```typescript
-await client.accounting.bankFeedAccounts.create({
- model: {},
-});
+await client.hris.timeOffBalances.retrieve("id");
```
@@ -23819,7 +17887,7 @@ await client.accounting.bankFeedAccounts.create({
-
-**request:** `Merge.accounting.BankFeedAccountEndpointRequest`
+**id:** `string`
@@ -23827,7 +17895,15 @@ await client.accounting.bankFeedAccounts.create({
-
-**requestOptions:** `BankFeedAccounts.RequestOptions`
+**request:** `Merge.hris.TimeOffBalancesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimeOffBalances.RequestOptions`
@@ -23838,7 +17914,9 @@ await client.accounting.bankFeedAccounts.create({
-client.accounting.bankFeedAccounts.retrieve(id, { ...params }) -> Merge.BankFeedAccount
+## Hris TimesheetEntries
+
+client.hris.timesheetEntries.list({ ...params }) -> Merge.PaginatedTimesheetEntryList
-
@@ -23850,7 +17928,7 @@ await client.accounting.bankFeedAccounts.create({
-
-Returns a `BankFeedAccount` object with the given `id`.
+Returns a list of `TimesheetEntry` objects.
@@ -23866,7 +17944,7 @@ Returns a `BankFeedAccount` object with the given `id`.
-
```typescript
-await client.accounting.bankFeedAccounts.retrieve("id");
+await client.hris.timesheetEntries.list();
```
@@ -23882,15 +17960,7 @@ await client.accounting.bankFeedAccounts.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.BankFeedAccountsRetrieveRequest`
+**request:** `Merge.hris.TimesheetEntriesListRequest`
@@ -23898,7 +17968,7 @@ await client.accounting.bankFeedAccounts.retrieve("id");
-
-**requestOptions:** `BankFeedAccounts.RequestOptions`
+**requestOptions:** `TimesheetEntries.RequestOptions`
@@ -23909,7 +17979,7 @@ await client.accounting.bankFeedAccounts.retrieve("id");
-client.accounting.bankFeedAccounts.metaPostRetrieve() -> Merge.MetaResponse
+client.hris.timesheetEntries.create({ ...params }) -> Merge.TimesheetEntryResponse
-
@@ -23921,7 +17991,7 @@ await client.accounting.bankFeedAccounts.retrieve("id");
-
-Returns metadata for `BankFeedAccount` POSTs.
+Creates a `TimesheetEntry` object with the given values.
@@ -23937,7 +18007,9 @@ Returns metadata for `BankFeedAccount` POSTs.
-
```typescript
-await client.accounting.bankFeedAccounts.metaPostRetrieve();
+await client.hris.timesheetEntries.create({
+ model: {},
+});
```
@@ -23953,7 +18025,15 @@ await client.accounting.bankFeedAccounts.metaPostRetrieve();
-
-**requestOptions:** `BankFeedAccounts.RequestOptions`
+**request:** `Merge.hris.TimesheetEntryEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimesheetEntries.RequestOptions`
@@ -23964,9 +18044,7 @@ await client.accounting.bankFeedAccounts.metaPostRetrieve();
-## Accounting BankFeedTransactions
-
-client.accounting.bankFeedTransactions.list({ ...params }) -> Merge.PaginatedBankFeedTransactionList
+client.hris.timesheetEntries.retrieve(id, { ...params }) -> Merge.TimesheetEntry
-
@@ -23978,7 +18056,7 @@ await client.accounting.bankFeedAccounts.metaPostRetrieve();
-
-Returns a list of `BankFeedTransaction` objects.
+Returns a `TimesheetEntry` object with the given `id`.
@@ -23994,7 +18072,7 @@ Returns a list of `BankFeedTransaction` objects.
-
```typescript
-await client.accounting.bankFeedTransactions.list();
+await client.hris.timesheetEntries.retrieve("id");
```
@@ -24010,7 +18088,7 @@ await client.accounting.bankFeedTransactions.list();
-
-**request:** `Merge.accounting.BankFeedTransactionsListRequest`
+**id:** `string`
@@ -24018,7 +18096,15 @@ await client.accounting.bankFeedTransactions.list();
-
-**requestOptions:** `BankFeedTransactions.RequestOptions`
+**request:** `Merge.hris.TimesheetEntriesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimesheetEntries.RequestOptions`
@@ -24029,7 +18115,7 @@ await client.accounting.bankFeedTransactions.list();
-client.accounting.bankFeedTransactions.create({ ...params }) -> Merge.BankFeedTransactionResponse
+client.hris.timesheetEntries.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -24041,7 +18127,7 @@ await client.accounting.bankFeedTransactions.list();
-
-Creates a `BankFeedTransaction` object with the given values.
+Returns metadata for `TimesheetEntry` POSTs.
@@ -24057,9 +18143,7 @@ Creates a `BankFeedTransaction` object with the given values.
-
```typescript
-await client.accounting.bankFeedTransactions.create({
- model: {},
-});
+await client.hris.timesheetEntries.metaPostRetrieve();
```
@@ -24075,15 +18159,7 @@ await client.accounting.bankFeedTransactions.create({
-
-**request:** `Merge.accounting.BankFeedTransactionEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `BankFeedTransactions.RequestOptions`
+**requestOptions:** `TimesheetEntries.RequestOptions`
@@ -24094,7 +18170,9 @@ await client.accounting.bankFeedTransactions.create({
-client.accounting.bankFeedTransactions.retrieve(id, { ...params }) -> Merge.BankFeedTransaction
+## Hris WebhookReceivers
+
+client.hris.webhookReceivers.list() -> Merge.WebhookReceiver[]
-
@@ -24106,7 +18184,7 @@ await client.accounting.bankFeedTransactions.create({
-
-Returns a `BankFeedTransaction` object with the given `id`.
+Returns a list of `WebhookReceiver` objects.
@@ -24122,7 +18200,7 @@ Returns a `BankFeedTransaction` object with the given `id`.
-
```typescript
-await client.accounting.bankFeedTransactions.retrieve("id");
+await client.hris.webhookReceivers.list();
```
@@ -24138,23 +18216,7 @@ await client.accounting.bankFeedTransactions.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.BankFeedTransactionsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `BankFeedTransactions.RequestOptions`
+**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -24165,7 +18227,7 @@ await client.accounting.bankFeedTransactions.retrieve("id");
-client.accounting.bankFeedTransactions.metaPostRetrieve() -> Merge.MetaResponse
+client.hris.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
-
@@ -24177,7 +18239,7 @@ await client.accounting.bankFeedTransactions.retrieve("id");
-
-Returns metadata for `BankFeedTransaction` POSTs.
+Creates a `WebhookReceiver` object with the given values.
@@ -24193,7 +18255,10 @@ Returns metadata for `BankFeedTransaction` POSTs.
-
```typescript
-await client.accounting.bankFeedTransactions.metaPostRetrieve();
+await client.hris.webhookReceivers.create({
+ event: "event",
+ isActive: true,
+});
```
@@ -24209,7 +18274,15 @@ await client.accounting.bankFeedTransactions.metaPostRetrieve();
-
-**requestOptions:** `BankFeedTransactions.RequestOptions`
+**request:** `Merge.hris.WebhookReceiverRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -24220,9 +18293,9 @@ await client.accounting.bankFeedTransactions.metaPostRetrieve();
-## Accounting CashFlowStatements
+## Ticketing AccountDetails
-client.accounting.cashFlowStatements.list({ ...params }) -> Merge.PaginatedCashFlowStatementList
+client.ticketing.accountDetails.retrieve() -> Merge.AccountDetails
-
@@ -24234,7 +18307,7 @@ await client.accounting.bankFeedTransactions.metaPostRetrieve();
-
-Returns a list of `CashFlowStatement` objects.
+Get details for a linked account.
@@ -24250,7 +18323,7 @@ Returns a list of `CashFlowStatement` objects.
-
```typescript
-await client.accounting.cashFlowStatements.list();
+await client.ticketing.accountDetails.retrieve();
```
@@ -24266,15 +18339,7 @@ await client.accounting.cashFlowStatements.list();
-
-**request:** `Merge.accounting.CashFlowStatementsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CashFlowStatements.RequestOptions`
+**requestOptions:** `AccountDetails.RequestOptions`
@@ -24285,7 +18350,9 @@ await client.accounting.cashFlowStatements.list();
-client.accounting.cashFlowStatements.retrieve(id, { ...params }) -> Merge.CashFlowStatement
+## Ticketing AccountToken
+
+client.ticketing.accountToken.retrieve(publicToken) -> Merge.AccountToken
-
@@ -24297,7 +18364,7 @@ await client.accounting.cashFlowStatements.list();
-
-Returns a `CashFlowStatement` object with the given `id`.
+Returns the account token for the end user with the provided public token.
@@ -24313,7 +18380,7 @@ Returns a `CashFlowStatement` object with the given `id`.
-
```typescript
-await client.accounting.cashFlowStatements.retrieve("id");
+await client.ticketing.accountToken.retrieve("public_token");
```
@@ -24329,15 +18396,7 @@ await client.accounting.cashFlowStatements.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.CashFlowStatementsRetrieveRequest`
+**publicToken:** `string`
@@ -24345,7 +18404,7 @@ await client.accounting.cashFlowStatements.retrieve("id");
-
-**requestOptions:** `CashFlowStatements.RequestOptions`
+**requestOptions:** `AccountToken.RequestOptions`
@@ -24356,9 +18415,9 @@ await client.accounting.cashFlowStatements.retrieve("id");
-## Accounting CompanyInfo
+## Ticketing Accounts
-client.accounting.companyInfo.list({ ...params }) -> Merge.PaginatedCompanyInfoList
+client.ticketing.accounts.list({ ...params }) -> Merge.PaginatedAccountList
-
@@ -24370,7 +18429,7 @@ await client.accounting.cashFlowStatements.retrieve("id");
-
-Returns a list of `CompanyInfo` objects.
+Returns a list of `Account` objects.
@@ -24386,7 +18445,7 @@ Returns a list of `CompanyInfo` objects.
-
```typescript
-await client.accounting.companyInfo.list();
+await client.ticketing.accounts.list();
```
@@ -24402,7 +18461,7 @@ await client.accounting.companyInfo.list();
-
-**request:** `Merge.accounting.CompanyInfoListRequest`
+**request:** `Merge.ticketing.AccountsListRequest`
@@ -24410,7 +18469,7 @@ await client.accounting.companyInfo.list();
-
-**requestOptions:** `CompanyInfo.RequestOptions`
+**requestOptions:** `Accounts.RequestOptions`
@@ -24421,7 +18480,7 @@ await client.accounting.companyInfo.list();
-client.accounting.companyInfo.retrieve(id, { ...params }) -> Merge.CompanyInfo
+client.ticketing.accounts.retrieve(id, { ...params }) -> Merge.Account
-
@@ -24433,7 +18492,7 @@ await client.accounting.companyInfo.list();
-
-Returns a `CompanyInfo` object with the given `id`.
+Returns an `Account` object with the given `id`.
@@ -24449,7 +18508,7 @@ Returns a `CompanyInfo` object with the given `id`.
-
```typescript
-await client.accounting.companyInfo.retrieve("id");
+await client.ticketing.accounts.retrieve("id");
```
@@ -24473,7 +18532,7 @@ await client.accounting.companyInfo.retrieve("id");
-
-**request:** `Merge.accounting.CompanyInfoRetrieveRequest`
+**request:** `Merge.ticketing.AccountsRetrieveRequest`
@@ -24481,7 +18540,7 @@ await client.accounting.companyInfo.retrieve("id");
-
-**requestOptions:** `CompanyInfo.RequestOptions`
+**requestOptions:** `Accounts.RequestOptions`
@@ -24492,9 +18551,9 @@ await client.accounting.companyInfo.retrieve("id");
-## Accounting Contacts
+## Ticketing AsyncPassthrough
-client.accounting.contacts.list({ ...params }) -> Merge.PaginatedContactList
+client.ticketing.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
-
@@ -24506,7 +18565,7 @@ await client.accounting.companyInfo.retrieve("id");
-
-Returns a list of `Contact` objects.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -24522,7 +18581,10 @@ Returns a list of `Contact` objects.
-
```typescript
-await client.accounting.contacts.list();
+await client.ticketing.asyncPassthrough.create({
+ method: "GET",
+ path: "/scooters",
+});
```
@@ -24538,7 +18600,7 @@ await client.accounting.contacts.list();
-
-**request:** `Merge.accounting.ContactsListRequest`
+**request:** `Merge.DataPassthroughRequest`
@@ -24546,7 +18608,7 @@ await client.accounting.contacts.list();
-
-**requestOptions:** `Contacts.RequestOptions`
+**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -24557,7 +18619,7 @@ await client.accounting.contacts.list();
-client.accounting.contacts.create({ ...params }) -> Merge.ContactResponse
+client.ticketing.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
-
@@ -24569,7 +18631,7 @@ await client.accounting.contacts.list();
-
-Creates a `Contact` object with the given values.
+Retrieves data from earlier async-passthrough POST request
@@ -24585,9 +18647,7 @@ Creates a `Contact` object with the given values.
-
```typescript
-await client.accounting.contacts.create({
- model: {},
-});
+await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id");
```
@@ -24603,7 +18663,7 @@ await client.accounting.contacts.create({
-
-**request:** `Merge.accounting.ContactEndpointRequest`
+**asyncPassthroughReceiptId:** `string`
@@ -24611,7 +18671,7 @@ await client.accounting.contacts.create({
-
-**requestOptions:** `Contacts.RequestOptions`
+**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -24622,7 +18682,9 @@ await client.accounting.contacts.create({
-client.accounting.contacts.retrieve(id, { ...params }) -> Merge.Contact
+## Ticketing Attachments
+
+client.ticketing.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList
-
@@ -24634,7 +18696,7 @@ await client.accounting.contacts.create({
-
-Returns a `Contact` object with the given `id`.
+Returns a list of `Attachment` objects.
@@ -24650,7 +18712,7 @@ Returns a `Contact` object with the given `id`.
-
```typescript
-await client.accounting.contacts.retrieve("id");
+await client.ticketing.attachments.list();
```
@@ -24666,15 +18728,7 @@ await client.accounting.contacts.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.ContactsRetrieveRequest`
+**request:** `Merge.ticketing.AttachmentsListRequest`
@@ -24682,7 +18736,7 @@ await client.accounting.contacts.retrieve("id");
-
-**requestOptions:** `Contacts.RequestOptions`
+**requestOptions:** `Attachments.RequestOptions`
@@ -24693,7 +18747,7 @@ await client.accounting.contacts.retrieve("id");
-client.accounting.contacts.metaPostRetrieve() -> Merge.MetaResponse
+client.ticketing.attachments.create({ ...params }) -> Merge.TicketingAttachmentResponse
-
@@ -24705,7 +18759,7 @@ await client.accounting.contacts.retrieve("id");
-
-Returns metadata for `Contact` POSTs.
+Creates an `Attachment` object with the given values.
@@ -24721,7 +18775,9 @@ Returns metadata for `Contact` POSTs.
-
```typescript
-await client.accounting.contacts.metaPostRetrieve();
+await client.ticketing.attachments.create({
+ model: {},
+});
```
@@ -24737,7 +18793,15 @@ await client.accounting.contacts.metaPostRetrieve();
-
-**requestOptions:** `Contacts.RequestOptions`
+**request:** `Merge.ticketing.TicketingAttachmentEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
@@ -24748,7 +18812,7 @@ await client.accounting.contacts.metaPostRetrieve();
-client.accounting.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.ticketing.attachments.retrieve(id, { ...params }) -> Merge.Attachment
-
@@ -24760,7 +18824,7 @@ await client.accounting.contacts.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Returns an `Attachment` object with the given `id`.
@@ -24776,7 +18840,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.contacts.remoteFieldClassesList();
+await client.ticketing.attachments.retrieve("id");
```
@@ -24792,7 +18856,7 @@ await client.accounting.contacts.remoteFieldClassesList();
-
-**request:** `Merge.accounting.ContactsRemoteFieldClassesListRequest`
+**id:** `string`
@@ -24800,7 +18864,15 @@ await client.accounting.contacts.remoteFieldClassesList();
-
-**requestOptions:** `Contacts.RequestOptions`
+**request:** `Merge.ticketing.AttachmentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
@@ -24811,9 +18883,7 @@ await client.accounting.contacts.remoteFieldClassesList();
-## Accounting CreditNotes
-
-client.accounting.creditNotes.list({ ...params }) -> Merge.PaginatedCreditNoteList
+client.ticketing.attachments.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -24825,7 +18895,7 @@ await client.accounting.contacts.remoteFieldClassesList();
-
-Returns a list of `CreditNote` objects.
+Returns metadata for `TicketingAttachment` POSTs.
@@ -24841,7 +18911,7 @@ Returns a list of `CreditNote` objects.
-
```typescript
-await client.accounting.creditNotes.list();
+await client.ticketing.attachments.metaPostRetrieve();
```
@@ -24857,15 +18927,7 @@ await client.accounting.creditNotes.list();
-
-**request:** `Merge.accounting.CreditNotesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CreditNotes.RequestOptions`
+**requestOptions:** `Attachments.RequestOptions`
@@ -24876,7 +18938,9 @@ await client.accounting.creditNotes.list();
-client.accounting.creditNotes.create({ ...params }) -> Merge.CreditNoteResponse
+## Ticketing AuditTrail
+
+client.ticketing.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
-
@@ -24888,7 +18952,7 @@ await client.accounting.creditNotes.list();
-
-Creates a `CreditNote` object with the given values.
+Gets a list of audit trail events.
@@ -24904,9 +18968,7 @@ Creates a `CreditNote` object with the given values.
-
```typescript
-await client.accounting.creditNotes.create({
- model: {},
-});
+await client.ticketing.auditTrail.list();
```
@@ -24922,7 +18984,7 @@ await client.accounting.creditNotes.create({
-
-**request:** `Merge.accounting.CreditNoteEndpointRequest`
+**request:** `Merge.ticketing.AuditTrailListRequest`
@@ -24930,7 +18992,7 @@ await client.accounting.creditNotes.create({
-
-**requestOptions:** `CreditNotes.RequestOptions`
+**requestOptions:** `AuditTrail.RequestOptions`
@@ -24941,7 +19003,9 @@ await client.accounting.creditNotes.create({
-client.accounting.creditNotes.retrieve(id, { ...params }) -> Merge.CreditNote
+## Ticketing AvailableActions
+
+client.ticketing.availableActions.retrieve() -> Merge.AvailableActions
-
@@ -24953,7 +19017,7 @@ await client.accounting.creditNotes.create({
-
-Returns a `CreditNote` object with the given `id`.
+Returns a list of models and actions available for an account.
@@ -24969,7 +19033,7 @@ Returns a `CreditNote` object with the given `id`.
-
```typescript
-await client.accounting.creditNotes.retrieve("id");
+await client.ticketing.availableActions.retrieve();
```
@@ -24985,23 +19049,7 @@ await client.accounting.creditNotes.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.CreditNotesRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CreditNotes.RequestOptions`
+**requestOptions:** `AvailableActions.RequestOptions`
@@ -25012,7 +19060,9 @@ await client.accounting.creditNotes.retrieve("id");
-client.accounting.creditNotes.metaPostRetrieve() -> Merge.MetaResponse
+## Ticketing Collections
+
+client.ticketing.collections.list({ ...params }) -> Merge.PaginatedCollectionList
-
@@ -25024,7 +19074,7 @@ await client.accounting.creditNotes.retrieve("id");
-
-Returns metadata for `CreditNote` POSTs.
+Returns a list of `Collection` objects.
@@ -25040,7 +19090,7 @@ Returns metadata for `CreditNote` POSTs.
-
```typescript
-await client.accounting.creditNotes.metaPostRetrieve();
+await client.ticketing.collections.list();
```
@@ -25056,7 +19106,15 @@ await client.accounting.creditNotes.metaPostRetrieve();
-
-**requestOptions:** `CreditNotes.RequestOptions`
+**request:** `Merge.ticketing.CollectionsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Collections.RequestOptions`
@@ -25067,9 +19125,7 @@ await client.accounting.creditNotes.metaPostRetrieve();
-## Accounting Scopes
-
-client.accounting.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
+client.ticketing.collections.viewersList(collectionId, { ...params }) -> Merge.PaginatedViewerList
-
@@ -25081,7 +19137,7 @@ await client.accounting.creditNotes.metaPostRetrieve();
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
@@ -25097,7 +19153,7 @@ Get the default permissions for Merge Common Models and fields across all Linked
-
```typescript
-await client.accounting.scopes.defaultScopesRetrieve();
+await client.ticketing.collections.viewersList("collection_id");
```
@@ -25113,7 +19169,23 @@ await client.accounting.scopes.defaultScopesRetrieve();
-
-**requestOptions:** `Scopes.RequestOptions`
+**collectionId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.CollectionsViewersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Collections.RequestOptions`
@@ -25124,7 +19196,7 @@ await client.accounting.scopes.defaultScopesRetrieve();
-client.accounting.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
+client.ticketing.collections.retrieve(id, { ...params }) -> Merge.Collection
-
@@ -25136,7 +19208,7 @@ await client.accounting.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 `Collection` object with the given `id`.
@@ -25152,7 +19224,7 @@ Get all available permissions for Merge Common Models and fields for a single Li
-
```typescript
-await client.accounting.scopes.linkedAccountScopesRetrieve();
+await client.ticketing.collections.retrieve("id");
```
@@ -25168,7 +19240,23 @@ await client.accounting.scopes.linkedAccountScopesRetrieve();
-
-**requestOptions:** `Scopes.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.CollectionsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Collections.RequestOptions`
@@ -25179,7 +19267,9 @@ await client.accounting.scopes.linkedAccountScopesRetrieve();
-client.accounting.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
+## Ticketing Comments
+
+client.ticketing.comments.list({ ...params }) -> Merge.PaginatedCommentList
-
@@ -25191,7 +19281,7 @@ await client.accounting.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 `Comment` objects.
@@ -25207,33 +19297,7 @@ Update permissions for any Common Model or field for a single Linked Account. An
-
```typescript
-await client.accounting.scopes.linkedAccountScopesCreate({
- commonModels: [
- {
- modelName: "Employee",
- modelPermissions: {
- READ: {
- isEnabled: true,
- },
- WRITE: {
- isEnabled: false,
- },
- },
- fieldPermissions: {
- enabledFields: ["avatar", "home_location"],
- disabledFields: ["work_location"],
- },
- },
- {
- modelName: "Benefit",
- modelPermissions: {
- WRITE: {
- isEnabled: false,
- },
- },
- },
- ],
-});
+await client.ticketing.comments.list();
```
@@ -25249,7 +19313,7 @@ await client.accounting.scopes.linkedAccountScopesCreate({
-
-**request:** `Merge.accounting.LinkedAccountCommonModelScopeDeserializerRequest`
+**request:** `Merge.ticketing.CommentsListRequest`
@@ -25257,7 +19321,7 @@ await client.accounting.scopes.linkedAccountScopesCreate({
-
-**requestOptions:** `Scopes.RequestOptions`
+**requestOptions:** `Comments.RequestOptions`
@@ -25268,9 +19332,7 @@ await client.accounting.scopes.linkedAccountScopesCreate({
-## Accounting DeleteAccount
-
-client.accounting.deleteAccount.delete() -> void
+client.ticketing.comments.create({ ...params }) -> Merge.CommentResponse
-
@@ -25282,7 +19344,7 @@ await client.accounting.scopes.linkedAccountScopesCreate({
-
-Delete a linked account.
+Creates a `Comment` object with the given values.
@@ -25298,7 +19360,9 @@ Delete a linked account.
-
```typescript
-await client.accounting.deleteAccount.delete();
+await client.ticketing.comments.create({
+ model: {},
+});
```
@@ -25314,7 +19378,15 @@ await client.accounting.deleteAccount.delete();
-
-**requestOptions:** `DeleteAccount.RequestOptions`
+**request:** `Merge.ticketing.CommentEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
@@ -25325,9 +19397,7 @@ await client.accounting.deleteAccount.delete();
-## Accounting Employees
-
-client.accounting.employees.list({ ...params }) -> Merge.PaginatedEmployeeList
+client.ticketing.comments.retrieve(id, { ...params }) -> Merge.Comment
-
@@ -25339,7 +19409,7 @@ await client.accounting.deleteAccount.delete();
-
-Returns a list of `Employee` objects.
+Returns a `Comment` object with the given `id`.
@@ -25355,7 +19425,7 @@ Returns a list of `Employee` objects.
-
```typescript
-await client.accounting.employees.list();
+await client.ticketing.comments.retrieve("id");
```
@@ -25371,7 +19441,7 @@ await client.accounting.employees.list();
-
-**request:** `Merge.accounting.EmployeesListRequest`
+**id:** `string`
@@ -25379,7 +19449,15 @@ await client.accounting.employees.list();
-
-**requestOptions:** `Employees.RequestOptions`
+**request:** `Merge.ticketing.CommentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
@@ -25390,7 +19468,7 @@ await client.accounting.employees.list();
-client.accounting.employees.retrieve(id, { ...params }) -> Merge.Employee
+client.ticketing.comments.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -25402,7 +19480,7 @@ await client.accounting.employees.list();
-
-Returns an `Employee` object with the given `id`.
+Returns metadata for `Comment` POSTs.
@@ -25418,7 +19496,7 @@ Returns an `Employee` object with the given `id`.
-
```typescript
-await client.accounting.employees.retrieve("id");
+await client.ticketing.comments.metaPostRetrieve();
```
@@ -25434,23 +19512,7 @@ await client.accounting.employees.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.EmployeesRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Employees.RequestOptions`
+**requestOptions:** `Comments.RequestOptions`
@@ -25461,9 +19523,9 @@ await client.accounting.employees.retrieve("id");
-## Accounting Expenses
+## Ticketing Contacts
-client.accounting.expenses.list({ ...params }) -> Merge.PaginatedExpenseList
+client.ticketing.contacts.list({ ...params }) -> Merge.PaginatedContactList
-
@@ -25475,7 +19537,7 @@ await client.accounting.employees.retrieve("id");
-
-Returns a list of `Expense` objects.
+Returns a list of `Contact` objects.
@@ -25491,7 +19553,7 @@ Returns a list of `Expense` objects.
-
```typescript
-await client.accounting.expenses.list();
+await client.ticketing.contacts.list();
```
@@ -25507,7 +19569,7 @@ await client.accounting.expenses.list();
-
-**request:** `Merge.accounting.ExpensesListRequest`
+**request:** `Merge.ticketing.ContactsListRequest`
@@ -25515,7 +19577,7 @@ await client.accounting.expenses.list();
-
-**requestOptions:** `Expenses.RequestOptions`
+**requestOptions:** `Contacts.RequestOptions`
@@ -25526,7 +19588,7 @@ await client.accounting.expenses.list();
-client.accounting.expenses.create({ ...params }) -> Merge.ExpenseResponse
+client.ticketing.contacts.create({ ...params }) -> Merge.TicketingContactResponse
-
@@ -25538,7 +19600,7 @@ await client.accounting.expenses.list();
-
-Creates an `Expense` object with the given values.
+Creates a `Contact` object with the given values.
@@ -25554,7 +19616,7 @@ Creates an `Expense` object with the given values.
-
```typescript
-await client.accounting.expenses.create({
+await client.ticketing.contacts.create({
model: {},
});
```
@@ -25572,7 +19634,7 @@ await client.accounting.expenses.create({
-
-**request:** `Merge.accounting.ExpenseEndpointRequest`
+**request:** `Merge.ticketing.TicketingContactEndpointRequest`
@@ -25580,7 +19642,7 @@ await client.accounting.expenses.create({
-
-**requestOptions:** `Expenses.RequestOptions`
+**requestOptions:** `Contacts.RequestOptions`
@@ -25591,7 +19653,7 @@ await client.accounting.expenses.create({
-client.accounting.expenses.retrieve(id, { ...params }) -> Merge.Expense
+client.ticketing.contacts.retrieve(id, { ...params }) -> Merge.Contact
-
@@ -25603,7 +19665,7 @@ await client.accounting.expenses.create({
-
-Returns an `Expense` object with the given `id`.
+Returns a `Contact` object with the given `id`.
@@ -25619,7 +19681,7 @@ Returns an `Expense` object with the given `id`.
-
```typescript
-await client.accounting.expenses.retrieve("id");
+await client.ticketing.contacts.retrieve("id");
```
@@ -25643,7 +19705,7 @@ await client.accounting.expenses.retrieve("id");
-
-**request:** `Merge.accounting.ExpensesRetrieveRequest`
+**request:** `Merge.ticketing.ContactsRetrieveRequest`
@@ -25651,7 +19713,7 @@ await client.accounting.expenses.retrieve("id");
-
-**requestOptions:** `Expenses.RequestOptions`
+**requestOptions:** `Contacts.RequestOptions`
@@ -25662,7 +19724,7 @@ await client.accounting.expenses.retrieve("id");
-client.accounting.expenses.linesRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.ticketing.contacts.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -25674,7 +19736,7 @@ await client.accounting.expenses.retrieve("id");
-
-Returns a list of `RemoteFieldClass` objects.
+Returns metadata for `TicketingContact` POSTs.
@@ -25690,7 +19752,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.expenses.linesRemoteFieldClassesList();
+await client.ticketing.contacts.metaPostRetrieve();
```
@@ -25706,15 +19768,7 @@ await client.accounting.expenses.linesRemoteFieldClassesList();
-
-**request:** `Merge.accounting.ExpensesLinesRemoteFieldClassesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Expenses.RequestOptions`
+**requestOptions:** `Contacts.RequestOptions`
@@ -25725,7 +19779,9 @@ await client.accounting.expenses.linesRemoteFieldClassesList();
-client.accounting.expenses.metaPostRetrieve() -> Merge.MetaResponse
+## Ticketing Scopes
+
+client.ticketing.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
-
@@ -25737,7 +19793,7 @@ await client.accounting.expenses.linesRemoteFieldClassesList();
-
-Returns metadata for `Expense` POSTs.
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -25753,7 +19809,7 @@ Returns metadata for `Expense` POSTs.
-
```typescript
-await client.accounting.expenses.metaPostRetrieve();
+await client.ticketing.scopes.defaultScopesRetrieve();
```
@@ -25769,7 +19825,7 @@ await client.accounting.expenses.metaPostRetrieve();
-
-**requestOptions:** `Expenses.RequestOptions`
+**requestOptions:** `Scopes.RequestOptions`
@@ -25780,7 +19836,7 @@ await client.accounting.expenses.metaPostRetrieve();
-client.accounting.expenses.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.ticketing.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
-
@@ -25792,7 +19848,7 @@ await client.accounting.expenses.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -25808,7 +19864,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.expenses.remoteFieldClassesList();
+await client.ticketing.scopes.linkedAccountScopesRetrieve();
```
@@ -25824,15 +19880,7 @@ await client.accounting.expenses.remoteFieldClassesList();
-
-**request:** `Merge.accounting.ExpensesRemoteFieldClassesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Expenses.RequestOptions`
+**requestOptions:** `Scopes.RequestOptions`
@@ -25843,9 +19891,7 @@ await client.accounting.expenses.remoteFieldClassesList();
-## Accounting FieldMapping
-
-client.accounting.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
+client.ticketing.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
-
@@ -25857,7 +19903,7 @@ await client.accounting.expenses.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/).
+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)
@@ -25873,7 +19919,33 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
-
```typescript
-await client.accounting.fieldMapping.fieldMappingsRetrieve();
+await client.ticketing.scopes.linkedAccountScopesCreate({
+ commonModels: [
+ {
+ modelName: "Employee",
+ modelPermissions: {
+ READ: {
+ isEnabled: true,
+ },
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ fieldPermissions: {
+ enabledFields: ["avatar", "home_location"],
+ disabledFields: ["work_location"],
+ },
+ },
+ {
+ modelName: "Benefit",
+ modelPermissions: {
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ },
+ ],
+});
```
@@ -25889,7 +19961,7 @@ await client.accounting.fieldMapping.fieldMappingsRetrieve();
-
-**request:** `Merge.accounting.FieldMappingsRetrieveRequest`
+**request:** `Merge.ticketing.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -25897,7 +19969,7 @@ await client.accounting.fieldMapping.fieldMappingsRetrieve();
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**requestOptions:** `Scopes.RequestOptions`
@@ -25908,7 +19980,9 @@ await client.accounting.fieldMapping.fieldMappingsRetrieve();
-client.accounting.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
+## Ticketing DeleteAccount
+
+client.ticketing.deleteAccount.delete() -> void
-
@@ -25920,7 +19994,7 @@ await client.accounting.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.
+Delete a linked account.
@@ -25936,14 +20010,7 @@ Create new Field Mappings that will be available after the next scheduled sync.
-
```typescript
-await client.accounting.fieldMapping.fieldMappingsCreate({
- targetFieldName: "example_target_field_name",
- targetFieldDescription: "this is a example description of the target field",
- remoteFieldTraversalPath: ["example_remote_field"],
- remoteMethod: "GET",
- remoteUrlPath: "/example-url-path",
- commonModelName: "ExampleCommonModel",
-});
+await client.ticketing.deleteAccount.delete();
```
@@ -25959,15 +20026,7 @@ await client.accounting.fieldMapping.fieldMappingsCreate({
-
-**request:** `Merge.accounting.CreateFieldMappingRequest`
-
-
-
-
-
--
-
-**requestOptions:** `FieldMapping.RequestOptions`
+**requestOptions:** `DeleteAccount.RequestOptions`
@@ -25978,7 +20037,9 @@ await client.accounting.fieldMapping.fieldMappingsCreate({
-client.accounting.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
+## Ticketing FieldMapping
+
+client.ticketing.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
-
@@ -25990,7 +20051,7 @@ await client.accounting.fieldMapping.fieldMappingsCreate({
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Get all 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/).
@@ -26006,7 +20067,7 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
-
```typescript
-await client.accounting.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+await client.ticketing.fieldMapping.fieldMappingsRetrieve();
```
@@ -26022,7 +20083,7 @@ await client.accounting.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**fieldMappingId:** `string`
+**request:** `Merge.ticketing.FieldMappingsRetrieveRequest`
@@ -26041,7 +20102,7 @@ await client.accounting.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-client.accounting.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
+client.ticketing.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
-
@@ -26053,7 +20114,7 @@ await client.accounting.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Create 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.
@@ -26069,7 +20130,14 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
-
```typescript
-await client.accounting.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+await client.ticketing.fieldMapping.fieldMappingsCreate({
+ targetFieldName: "example_target_field_name",
+ targetFieldDescription: "this is a example description of the target field",
+ remoteFieldTraversalPath: ["example_remote_field"],
+ remoteMethod: "GET",
+ remoteUrlPath: "/example-url-path",
+ commonModelName: "ExampleCommonModel",
+});
```
@@ -26085,15 +20153,7 @@ await client.accounting.fieldMapping.fieldMappingsPartialUpdate("field_mapping_i
-
-**fieldMappingId:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.PatchedEditFieldMappingRequest`
+**request:** `Merge.ticketing.CreateFieldMappingRequest`
@@ -26112,7 +20172,7 @@ await client.accounting.fieldMapping.fieldMappingsPartialUpdate("field_mapping_i
-client.accounting.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
+client.ticketing.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
-
@@ -26124,7 +20184,7 @@ await client.accounting.fieldMapping.fieldMappingsPartialUpdate("field_mapping_i
-
-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/).
+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.
@@ -26140,7 +20200,7 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
-
```typescript
-await client.accounting.fieldMapping.remoteFieldsRetrieve();
+await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id");
```
@@ -26156,7 +20216,7 @@ await client.accounting.fieldMapping.remoteFieldsRetrieve();
-
-**request:** `Merge.accounting.RemoteFieldsRetrieveRequest`
+**fieldMappingId:** `string`
@@ -26175,7 +20235,7 @@ await client.accounting.fieldMapping.remoteFieldsRetrieve();
-client.accounting.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
+client.ticketing.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
-
@@ -26187,7 +20247,7 @@ await client.accounting.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/).
+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.
@@ -26203,7 +20263,7 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
-
```typescript
-await client.accounting.fieldMapping.targetFieldsRetrieve();
+await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
```
@@ -26219,6 +20279,22 @@ await client.accounting.fieldMapping.targetFieldsRetrieve();
-
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
**requestOptions:** `FieldMapping.RequestOptions`
@@ -26230,9 +20306,7 @@ await client.accounting.fieldMapping.targetFieldsRetrieve();
-## Accounting GeneralLedgerTransactions
-
-client.accounting.generalLedgerTransactions.list({ ...params }) -> Merge.PaginatedGeneralLedgerTransactionList
+client.ticketing.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
-
@@ -26244,7 +20318,7 @@ await client.accounting.fieldMapping.targetFieldsRetrieve();
-
-Returns a list of `GeneralLedgerTransaction` 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/).
@@ -26260,7 +20334,7 @@ Returns a list of `GeneralLedgerTransaction` objects.
-
```typescript
-await client.accounting.generalLedgerTransactions.list();
+await client.ticketing.fieldMapping.remoteFieldsRetrieve();
```
@@ -26276,7 +20350,7 @@ await client.accounting.generalLedgerTransactions.list();
-
-**request:** `Merge.accounting.GeneralLedgerTransactionsListRequest`
+**request:** `Merge.ticketing.RemoteFieldsRetrieveRequest`
@@ -26284,7 +20358,7 @@ await client.accounting.generalLedgerTransactions.list();
-
-**requestOptions:** `GeneralLedgerTransactions.RequestOptions`
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -26295,7 +20369,7 @@ await client.accounting.generalLedgerTransactions.list();
-client.accounting.generalLedgerTransactions.retrieve(id, { ...params }) -> Merge.GeneralLedgerTransaction
+client.ticketing.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
-
@@ -26307,7 +20381,7 @@ await client.accounting.generalLedgerTransactions.list();
-
-Returns a `GeneralLedgerTransaction` object with the given `id`.
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -26323,7 +20397,7 @@ Returns a `GeneralLedgerTransaction` object with the given `id`.
-
```typescript
-await client.accounting.generalLedgerTransactions.retrieve("id");
+await client.ticketing.fieldMapping.targetFieldsRetrieve();
```
@@ -26339,23 +20413,7 @@ await client.accounting.generalLedgerTransactions.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.GeneralLedgerTransactionsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `GeneralLedgerTransactions.RequestOptions`
+**requestOptions:** `FieldMapping.RequestOptions`
@@ -26366,9 +20424,9 @@ await client.accounting.generalLedgerTransactions.retrieve("id");
-## Accounting GenerateKey
+## Ticketing GenerateKey
-client.accounting.generateKey.create({ ...params }) -> Merge.RemoteKey
+client.ticketing.generateKey.create({ ...params }) -> Merge.RemoteKey
-
@@ -26396,7 +20454,7 @@ Create a remote key.
-
```typescript
-await client.accounting.generateKey.create({
+await client.ticketing.generateKey.create({
name: "Remote Deployment Key 1",
});
```
@@ -26414,7 +20472,7 @@ await client.accounting.generateKey.create({
-
-**request:** `Merge.accounting.GenerateRemoteKeyRequest`
+**request:** `Merge.ticketing.GenerateRemoteKeyRequest`
@@ -26433,9 +20491,9 @@ await client.accounting.generateKey.create({
-## Accounting IncomeStatements
+## Ticketing Issues
-client.accounting.incomeStatements.list({ ...params }) -> Merge.PaginatedIncomeStatementList
+client.ticketing.issues.list({ ...params }) -> Merge.PaginatedIssueList
-
@@ -26447,7 +20505,7 @@ await client.accounting.generateKey.create({
-
-Returns a list of `IncomeStatement` objects.
+Gets all issues for Organization.
@@ -26463,7 +20521,7 @@ Returns a list of `IncomeStatement` objects.
-
```typescript
-await client.accounting.incomeStatements.list();
+await client.ticketing.issues.list();
```
@@ -26479,7 +20537,7 @@ await client.accounting.incomeStatements.list();
-
-**request:** `Merge.accounting.IncomeStatementsListRequest`
+**request:** `Merge.ticketing.IssuesListRequest`
@@ -26487,7 +20545,7 @@ await client.accounting.incomeStatements.list();
-
-**requestOptions:** `IncomeStatements.RequestOptions`
+**requestOptions:** `Issues.RequestOptions`
@@ -26498,7 +20556,7 @@ await client.accounting.incomeStatements.list();
-client.accounting.incomeStatements.retrieve(id, { ...params }) -> Merge.IncomeStatement
+client.ticketing.issues.retrieve(id) -> Merge.Issue
-
@@ -26510,7 +20568,7 @@ await client.accounting.incomeStatements.list();
-
-Returns an `IncomeStatement` object with the given `id`.
+Get a specific issue.
@@ -26526,7 +20584,7 @@ Returns an `IncomeStatement` object with the given `id`.
-
```typescript
-await client.accounting.incomeStatements.retrieve("id");
+await client.ticketing.issues.retrieve("id");
```
@@ -26550,15 +20608,7 @@ await client.accounting.incomeStatements.retrieve("id");
-
-**request:** `Merge.accounting.IncomeStatementsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `IncomeStatements.RequestOptions`
+**requestOptions:** `Issues.RequestOptions`
@@ -26569,9 +20619,9 @@ await client.accounting.incomeStatements.retrieve("id");
-## Accounting Invoices
+## Ticketing LinkToken
-client.accounting.invoices.list({ ...params }) -> Merge.PaginatedInvoiceList
+client.ticketing.linkToken.create({ ...params }) -> Merge.LinkToken
-
@@ -26583,7 +20633,7 @@ await client.accounting.incomeStatements.retrieve("id");
-
-Returns a list of `Invoice` objects.
+Creates a link token to be used when linking a new end user.
@@ -26599,7 +20649,12 @@ Returns a list of `Invoice` objects.
-
```typescript
-await client.accounting.invoices.list();
+await client.ticketing.linkToken.create({
+ endUserEmailAddress: "example@gmail.com",
+ endUserOrganizationName: "Test Organization",
+ endUserOriginId: "12345",
+ categories: ["hris", "ats"],
+});
```
@@ -26615,7 +20670,7 @@ await client.accounting.invoices.list();
-
-**request:** `Merge.accounting.InvoicesListRequest`
+**request:** `Merge.ticketing.EndUserDetailsRequest`
@@ -26623,7 +20678,7 @@ await client.accounting.invoices.list();
-
-**requestOptions:** `Invoices.RequestOptions`
+**requestOptions:** `LinkToken.RequestOptions`
@@ -26634,7 +20689,9 @@ await client.accounting.invoices.list();
-client.accounting.invoices.create({ ...params }) -> Merge.InvoiceResponse
+## Ticketing LinkedAccounts
+
+client.ticketing.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
-
@@ -26646,8 +20703,7 @@ await client.accounting.invoices.list();
-
-Creates an `Invoice` object with the given values.
-Including a `PurchaseOrder` id in the `purchase_orders` property will generate an Accounts Payable Invoice from the specified Purchase Order(s).
+List linked accounts for your organization.
@@ -26663,9 +20719,7 @@ Including a `PurchaseOrder` id in the `purchase_orders` property will generate a
-
```typescript
-await client.accounting.invoices.create({
- model: {},
-});
+await client.ticketing.linkedAccounts.list();
```
@@ -26681,7 +20735,7 @@ await client.accounting.invoices.create({
-
-**request:** `Merge.accounting.InvoiceEndpointRequest`
+**request:** `Merge.ticketing.LinkedAccountsListRequest`
@@ -26689,7 +20743,7 @@ await client.accounting.invoices.create({
-
-**requestOptions:** `Invoices.RequestOptions`
+**requestOptions:** `LinkedAccounts.RequestOptions`
@@ -26700,7 +20754,9 @@ await client.accounting.invoices.create({
-client.accounting.invoices.retrieve(id, { ...params }) -> Merge.Invoice
+## Ticketing Passthrough
+
+client.ticketing.passthrough.create({ ...params }) -> Merge.RemoteResponse
-
@@ -26712,7 +20768,7 @@ await client.accounting.invoices.create({
-
-Returns an `Invoice` object with the given `id`.
+Pull data from an endpoint not currently supported by Merge.
@@ -26728,7 +20784,10 @@ Returns an `Invoice` object with the given `id`.
-
```typescript
-await client.accounting.invoices.retrieve("id");
+await client.ticketing.passthrough.create({
+ method: "GET",
+ path: "/scooters",
+});
```
@@ -26744,15 +20803,7 @@ await client.accounting.invoices.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.InvoicesRetrieveRequest`
+**request:** `Merge.DataPassthroughRequest`
@@ -26760,7 +20811,7 @@ await client.accounting.invoices.retrieve("id");
-
-**requestOptions:** `Invoices.RequestOptions`
+**requestOptions:** `Passthrough.RequestOptions`
@@ -26771,7 +20822,9 @@ await client.accounting.invoices.retrieve("id");
-client.accounting.invoices.partialUpdate(id, { ...params }) -> Merge.InvoiceResponse
+## Ticketing Projects
+
+client.ticketing.projects.list({ ...params }) -> Merge.PaginatedProjectList
-
@@ -26783,7 +20836,7 @@ await client.accounting.invoices.retrieve("id");
-
-Updates an `Invoice` object with the given `id`.
+Returns a list of `Project` objects.
@@ -26799,9 +20852,7 @@ Updates an `Invoice` object with the given `id`.
-
```typescript
-await client.accounting.invoices.partialUpdate("id", {
- model: {},
-});
+await client.ticketing.projects.list();
```
@@ -26817,15 +20868,7 @@ await client.accounting.invoices.partialUpdate("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.PatchedInvoiceEndpointRequest`
+**request:** `Merge.ticketing.ProjectsListRequest`
@@ -26833,7 +20876,7 @@ await client.accounting.invoices.partialUpdate("id", {
-
-**requestOptions:** `Invoices.RequestOptions`
+**requestOptions:** `Projects.RequestOptions`
@@ -26844,7 +20887,7 @@ await client.accounting.invoices.partialUpdate("id", {
-client.accounting.invoices.lineItemsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.ticketing.projects.retrieve(id, { ...params }) -> Merge.Project
-
@@ -26856,7 +20899,7 @@ await client.accounting.invoices.partialUpdate("id", {
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a `Project` object with the given `id`.
@@ -26872,7 +20915,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.invoices.lineItemsRemoteFieldClassesList();
+await client.ticketing.projects.retrieve("id");
```
@@ -26888,7 +20931,15 @@ await client.accounting.invoices.lineItemsRemoteFieldClassesList();
-
-**request:** `Merge.accounting.InvoicesLineItemsRemoteFieldClassesListRequest`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.ProjectsRetrieveRequest`
@@ -26896,7 +20947,7 @@ await client.accounting.invoices.lineItemsRemoteFieldClassesList();
-
-**requestOptions:** `Invoices.RequestOptions`
+**requestOptions:** `Projects.RequestOptions`
@@ -26907,7 +20958,7 @@ await client.accounting.invoices.lineItemsRemoteFieldClassesList();
-client.accounting.invoices.metaPatchRetrieve(id) -> Merge.MetaResponse
+client.ticketing.projects.usersList(parentId, { ...params }) -> Merge.PaginatedUserList
-
@@ -26919,7 +20970,7 @@ await client.accounting.invoices.lineItemsRemoteFieldClassesList();
-
-Returns metadata for `Invoice` PATCHs.
+Returns a list of `User` objects.
@@ -26935,7 +20986,7 @@ Returns metadata for `Invoice` PATCHs.
-
```typescript
-await client.accounting.invoices.metaPatchRetrieve("id");
+await client.ticketing.projects.usersList("parent_id");
```
@@ -26951,7 +21002,15 @@ await client.accounting.invoices.metaPatchRetrieve("id");
-
-**id:** `string`
+**parentId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.ProjectsUsersListRequest`
@@ -26959,7 +21018,7 @@ await client.accounting.invoices.metaPatchRetrieve("id");
-
-**requestOptions:** `Invoices.RequestOptions`
+**requestOptions:** `Projects.RequestOptions`
@@ -26970,7 +21029,9 @@ await client.accounting.invoices.metaPatchRetrieve("id");
-client.accounting.invoices.metaPostRetrieve() -> Merge.MetaResponse
+## Ticketing RegenerateKey
+
+client.ticketing.regenerateKey.create({ ...params }) -> Merge.RemoteKey
-
@@ -26982,7 +21043,7 @@ await client.accounting.invoices.metaPatchRetrieve("id");
-
-Returns metadata for `Invoice` POSTs.
+Exchange remote keys.
@@ -26998,7 +21059,9 @@ Returns metadata for `Invoice` POSTs.
-
```typescript
-await client.accounting.invoices.metaPostRetrieve();
+await client.ticketing.regenerateKey.create({
+ name: "Remote Deployment Key 1",
+});
```
@@ -27014,7 +21077,15 @@ await client.accounting.invoices.metaPostRetrieve();
-
-**requestOptions:** `Invoices.RequestOptions`
+**request:** `Merge.ticketing.RemoteKeyForRegenerationRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `RegenerateKey.RequestOptions`
@@ -27025,7 +21096,9 @@ await client.accounting.invoices.metaPostRetrieve();
-client.accounting.invoices.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+## Ticketing Roles
+
+client.ticketing.roles.list({ ...params }) -> Merge.PaginatedRoleList
-
@@ -27037,7 +21110,7 @@ await client.accounting.invoices.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `Role` objects.
@@ -27053,7 +21126,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.invoices.remoteFieldClassesList();
+await client.ticketing.roles.list();
```
@@ -27069,7 +21142,7 @@ await client.accounting.invoices.remoteFieldClassesList();
-
-**request:** `Merge.accounting.InvoicesRemoteFieldClassesListRequest`
+**request:** `Merge.ticketing.RolesListRequest`
@@ -27077,7 +21150,7 @@ await client.accounting.invoices.remoteFieldClassesList();
-
-**requestOptions:** `Invoices.RequestOptions`
+**requestOptions:** `Roles.RequestOptions`
@@ -27088,9 +21161,7 @@ await client.accounting.invoices.remoteFieldClassesList();
-## Accounting Issues
-
-client.accounting.issues.list({ ...params }) -> Merge.PaginatedIssueList
+client.ticketing.roles.retrieve(id, { ...params }) -> Merge.Role
-
@@ -27102,7 +21173,7 @@ await client.accounting.invoices.remoteFieldClassesList();
-
-Gets all issues for Organization.
+Returns a `Role` object with the given `id`.
@@ -27118,7 +21189,7 @@ Gets all issues for Organization.
-
```typescript
-await client.accounting.issues.list();
+await client.ticketing.roles.retrieve("id");
```
@@ -27134,7 +21205,7 @@ await client.accounting.issues.list();
-
-**request:** `Merge.accounting.IssuesListRequest`
+**id:** `string`
@@ -27142,7 +21213,15 @@ await client.accounting.issues.list();
-
-**requestOptions:** `Issues.RequestOptions`
+**request:** `Merge.ticketing.RolesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Roles.RequestOptions`
@@ -27153,7 +21232,9 @@ await client.accounting.issues.list();
-client.accounting.issues.retrieve(id) -> Merge.Issue
+## Ticketing SyncStatus
+
+client.ticketing.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
-
@@ -27165,7 +21246,7 @@ await client.accounting.issues.list();
-
-Get a specific issue.
+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).
@@ -27181,7 +21262,7 @@ Get a specific issue.
-
```typescript
-await client.accounting.issues.retrieve("id");
+await client.ticketing.syncStatus.list();
```
@@ -27197,7 +21278,7 @@ await client.accounting.issues.retrieve("id");
-
-**id:** `string`
+**request:** `Merge.ticketing.SyncStatusListRequest`
@@ -27205,7 +21286,7 @@ await client.accounting.issues.retrieve("id");
-
-**requestOptions:** `Issues.RequestOptions`
+**requestOptions:** `SyncStatus.RequestOptions`
@@ -27216,9 +21297,9 @@ await client.accounting.issues.retrieve("id");
-## Accounting Items
+## Ticketing ForceResync
-client.accounting.items.list({ ...params }) -> Merge.PaginatedItemList
+client.ticketing.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
-
@@ -27230,7 +21311,7 @@ await client.accounting.issues.retrieve("id");
-
-Returns a list of `Item` objects.
+Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -27246,7 +21327,7 @@ Returns a list of `Item` objects.
-
```typescript
-await client.accounting.items.list();
+await client.ticketing.forceResync.syncStatusResyncCreate();
```
@@ -27262,15 +21343,7 @@ await client.accounting.items.list();
-
-**request:** `Merge.accounting.ItemsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Items.RequestOptions`
+**requestOptions:** `ForceResync.RequestOptions`
@@ -27281,7 +21354,9 @@ await client.accounting.items.list();
-client.accounting.items.retrieve(id, { ...params }) -> Merge.Item
+## Ticketing Tags
+
+client.ticketing.tags.list({ ...params }) -> Merge.PaginatedTagList
-
@@ -27293,7 +21368,7 @@ await client.accounting.items.list();
-
-Returns an `Item` object with the given `id`.
+Returns a list of `Tag` objects.
@@ -27309,7 +21384,7 @@ Returns an `Item` object with the given `id`.
-
```typescript
-await client.accounting.items.retrieve("id");
+await client.ticketing.tags.list();
```
@@ -27325,15 +21400,7 @@ await client.accounting.items.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.ItemsRetrieveRequest`
+**request:** `Merge.ticketing.TagsListRequest`
@@ -27341,7 +21408,7 @@ await client.accounting.items.retrieve("id");
-
-**requestOptions:** `Items.RequestOptions`
+**requestOptions:** `Tags.RequestOptions`
@@ -27352,9 +21419,7 @@ await client.accounting.items.retrieve("id");
-## Accounting JournalEntries
-
-client.accounting.journalEntries.list({ ...params }) -> Merge.PaginatedJournalEntryList
+client.ticketing.tags.retrieve(id, { ...params }) -> Merge.Tag
-
@@ -27366,7 +21431,7 @@ await client.accounting.items.retrieve("id");
-
-Returns a list of `JournalEntry` objects.
+Returns a `Tag` object with the given `id`.
@@ -27382,7 +21447,7 @@ Returns a list of `JournalEntry` objects.
-
```typescript
-await client.accounting.journalEntries.list();
+await client.ticketing.tags.retrieve("id");
```
@@ -27398,7 +21463,15 @@ await client.accounting.journalEntries.list();
-
-**request:** `Merge.accounting.JournalEntriesListRequest`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.TagsRetrieveRequest`
@@ -27406,7 +21479,7 @@ await client.accounting.journalEntries.list();
-
-**requestOptions:** `JournalEntries.RequestOptions`
+**requestOptions:** `Tags.RequestOptions`
@@ -27417,7 +21490,9 @@ await client.accounting.journalEntries.list();
-client.accounting.journalEntries.create({ ...params }) -> Merge.JournalEntryResponse
+## Ticketing Teams
+
+client.ticketing.teams.list({ ...params }) -> Merge.PaginatedTeamList
-
@@ -27429,7 +21504,7 @@ await client.accounting.journalEntries.list();
-
-Creates a `JournalEntry` object with the given values.
+Returns a list of `Team` objects.
@@ -27445,9 +21520,7 @@ Creates a `JournalEntry` object with the given values.
-
```typescript
-await client.accounting.journalEntries.create({
- model: {},
-});
+await client.ticketing.teams.list();
```
@@ -27463,7 +21536,7 @@ await client.accounting.journalEntries.create({
-
-**request:** `Merge.accounting.JournalEntryEndpointRequest`
+**request:** `Merge.ticketing.TeamsListRequest`
@@ -27471,7 +21544,7 @@ await client.accounting.journalEntries.create({
-
-**requestOptions:** `JournalEntries.RequestOptions`
+**requestOptions:** `Teams.RequestOptions`
@@ -27482,7 +21555,7 @@ await client.accounting.journalEntries.create({
-client.accounting.journalEntries.retrieve(id, { ...params }) -> Merge.JournalEntry
+client.ticketing.teams.retrieve(id, { ...params }) -> Merge.Team
-
@@ -27494,7 +21567,7 @@ await client.accounting.journalEntries.create({
-
-Returns a `JournalEntry` object with the given `id`.
+Returns a `Team` object with the given `id`.
@@ -27510,7 +21583,7 @@ Returns a `JournalEntry` object with the given `id`.
-
```typescript
-await client.accounting.journalEntries.retrieve("id");
+await client.ticketing.teams.retrieve("id");
```
@@ -27534,7 +21607,7 @@ await client.accounting.journalEntries.retrieve("id");
-
-**request:** `Merge.accounting.JournalEntriesRetrieveRequest`
+**request:** `Merge.ticketing.TeamsRetrieveRequest`
@@ -27542,7 +21615,7 @@ await client.accounting.journalEntries.retrieve("id");
-
-**requestOptions:** `JournalEntries.RequestOptions`
+**requestOptions:** `Teams.RequestOptions`
@@ -27553,7 +21626,9 @@ await client.accounting.journalEntries.retrieve("id");
-client.accounting.journalEntries.linesRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+## Ticketing Tickets
+
+client.ticketing.tickets.list({ ...params }) -> Merge.PaginatedTicketList
-
@@ -27565,7 +21640,7 @@ await client.accounting.journalEntries.retrieve("id");
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `Ticket` objects.
@@ -27581,7 +21656,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.journalEntries.linesRemoteFieldClassesList();
+await client.ticketing.tickets.list();
```
@@ -27597,7 +21672,7 @@ await client.accounting.journalEntries.linesRemoteFieldClassesList();
-
-**request:** `Merge.accounting.JournalEntriesLinesRemoteFieldClassesListRequest`
+**request:** `Merge.ticketing.TicketsListRequest`
@@ -27605,7 +21680,7 @@ await client.accounting.journalEntries.linesRemoteFieldClassesList();
-
-**requestOptions:** `JournalEntries.RequestOptions`
+**requestOptions:** `Tickets.RequestOptions`
@@ -27616,7 +21691,7 @@ await client.accounting.journalEntries.linesRemoteFieldClassesList();
-client.accounting.journalEntries.metaPostRetrieve() -> Merge.MetaResponse
+client.ticketing.tickets.create({ ...params }) -> Merge.TicketResponse
-
@@ -27628,7 +21703,7 @@ await client.accounting.journalEntries.linesRemoteFieldClassesList();
-
-Returns metadata for `JournalEntry` POSTs.
+Creates a `Ticket` object with the given values.
@@ -27644,7 +21719,9 @@ Returns metadata for `JournalEntry` POSTs.
-
```typescript
-await client.accounting.journalEntries.metaPostRetrieve();
+await client.ticketing.tickets.create({
+ model: {},
+});
```
@@ -27660,7 +21737,15 @@ await client.accounting.journalEntries.metaPostRetrieve();
-
-**requestOptions:** `JournalEntries.RequestOptions`
+**request:** `Merge.ticketing.TicketEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
@@ -27671,7 +21756,7 @@ await client.accounting.journalEntries.metaPostRetrieve();
-client.accounting.journalEntries.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.ticketing.tickets.retrieve(id, { ...params }) -> Merge.Ticket
-
@@ -27683,7 +21768,7 @@ await client.accounting.journalEntries.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a `Ticket` object with the given `id`.
@@ -27699,7 +21784,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.journalEntries.remoteFieldClassesList();
+await client.ticketing.tickets.retrieve("id");
```
@@ -27715,7 +21800,15 @@ await client.accounting.journalEntries.remoteFieldClassesList();
-
-**request:** `Merge.accounting.JournalEntriesRemoteFieldClassesListRequest`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.TicketsRetrieveRequest`
@@ -27723,7 +21816,7 @@ await client.accounting.journalEntries.remoteFieldClassesList();
-
-**requestOptions:** `JournalEntries.RequestOptions`
+**requestOptions:** `Tickets.RequestOptions`
@@ -27734,9 +21827,7 @@ await client.accounting.journalEntries.remoteFieldClassesList();
-## Accounting LinkToken
-
-client.accounting.linkToken.create({ ...params }) -> Merge.LinkToken
+client.ticketing.tickets.partialUpdate(id, { ...params }) -> Merge.TicketResponse
-
@@ -27748,7 +21839,7 @@ await client.accounting.journalEntries.remoteFieldClassesList();
-
-Creates a link token to be used when linking a new end user.
+Updates a `Ticket` object with the given `id`.
@@ -27764,11 +21855,8 @@ Creates a link token to be used when linking a new end user.
-
```typescript
-await client.accounting.linkToken.create({
- endUserEmailAddress: "example@gmail.com",
- endUserOrganizationName: "Test Organization",
- endUserOriginId: "12345",
- categories: ["hris", "ats"],
+await client.ticketing.tickets.partialUpdate("id", {
+ model: {},
});
```
@@ -27785,7 +21873,7 @@ await client.accounting.linkToken.create({
-
-**request:** `Merge.accounting.EndUserDetailsRequest`
+**id:** `string`
@@ -27793,7 +21881,15 @@ await client.accounting.linkToken.create({
-
-**requestOptions:** `LinkToken.RequestOptions`
+**request:** `Merge.ticketing.PatchedTicketEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
@@ -27804,9 +21900,7 @@ await client.accounting.linkToken.create({
-## Accounting LinkedAccounts
-
-client.accounting.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+client.ticketing.tickets.viewersList(ticketId, { ...params }) -> Merge.PaginatedViewerList
-
@@ -27818,7 +21912,7 @@ await client.accounting.linkToken.create({
-
-List linked accounts for your organization.
+Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
@@ -27834,7 +21928,7 @@ List linked accounts for your organization.
-
```typescript
-await client.accounting.linkedAccounts.list();
+await client.ticketing.tickets.viewersList("ticket_id");
```
@@ -27850,7 +21944,7 @@ await client.accounting.linkedAccounts.list();
-
-**request:** `Merge.accounting.LinkedAccountsListRequest`
+**ticketId:** `string`
@@ -27858,7 +21952,15 @@ await client.accounting.linkedAccounts.list();
-
-**requestOptions:** `LinkedAccounts.RequestOptions`
+**request:** `Merge.ticketing.TicketsViewersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
@@ -27869,9 +21971,7 @@ await client.accounting.linkedAccounts.list();
-## Accounting Passthrough
-
-client.accounting.passthrough.create({ ...params }) -> Merge.RemoteResponse
+client.ticketing.tickets.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -27883,7 +21983,7 @@ await client.accounting.linkedAccounts.list();
-
-Pull data from an endpoint not currently supported by Merge.
+Returns metadata for `Ticket` PATCHs.
@@ -27899,10 +21999,7 @@ Pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.accounting.passthrough.create({
- method: "GET",
- path: "/scooters",
-});
+await client.ticketing.tickets.metaPatchRetrieve("id");
```
@@ -27918,7 +22015,7 @@ await client.accounting.passthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
+**id:** `string`
@@ -27926,7 +22023,7 @@ await client.accounting.passthrough.create({
-
-**requestOptions:** `Passthrough.RequestOptions`
+**requestOptions:** `Tickets.RequestOptions`
@@ -27937,9 +22034,7 @@ await client.accounting.passthrough.create({
-## Accounting PaymentMethods
-
-client.accounting.paymentMethods.list({ ...params }) -> Merge.PaginatedPaymentMethodList
+client.ticketing.tickets.metaPostRetrieve({ ...params }) -> Merge.MetaResponse
-
@@ -27951,7 +22046,7 @@ await client.accounting.passthrough.create({
-
-Returns a list of `PaymentMethod` objects.
+Returns metadata for `Ticket` POSTs.
@@ -27967,7 +22062,7 @@ Returns a list of `PaymentMethod` objects.
-
```typescript
-await client.accounting.paymentMethods.list();
+await client.ticketing.tickets.metaPostRetrieve();
```
@@ -27983,7 +22078,7 @@ await client.accounting.paymentMethods.list();
-
-**request:** `Merge.accounting.PaymentMethodsListRequest`
+**request:** `Merge.ticketing.TicketsMetaPostRetrieveRequest`
@@ -27991,7 +22086,7 @@ await client.accounting.paymentMethods.list();
-
-**requestOptions:** `PaymentMethods.RequestOptions`
+**requestOptions:** `Tickets.RequestOptions`
@@ -28002,7 +22097,7 @@ await client.accounting.paymentMethods.list();
-client.accounting.paymentMethods.retrieve(id, { ...params }) -> Merge.PaymentMethod
+client.ticketing.tickets.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
-
@@ -28014,7 +22109,7 @@ await client.accounting.paymentMethods.list();
-
-Returns a `PaymentMethod` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -28030,7 +22125,7 @@ Returns a `PaymentMethod` object with the given `id`.
-
```typescript
-await client.accounting.paymentMethods.retrieve("id");
+await client.ticketing.tickets.remoteFieldClassesList();
```
@@ -28046,15 +22141,7 @@ await client.accounting.paymentMethods.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.PaymentMethodsRetrieveRequest`
+**request:** `Merge.ticketing.TicketsRemoteFieldClassesListRequest`
@@ -28062,7 +22149,7 @@ await client.accounting.paymentMethods.retrieve("id");
-
-**requestOptions:** `PaymentMethods.RequestOptions`
+**requestOptions:** `Tickets.RequestOptions`
@@ -28073,9 +22160,9 @@ await client.accounting.paymentMethods.retrieve("id");
-## Accounting PaymentTerms
+## Ticketing Users
-client.accounting.paymentTerms.list({ ...params }) -> Merge.PaginatedPaymentTermList
+client.ticketing.users.list({ ...params }) -> Merge.PaginatedUserList
-
@@ -28087,7 +22174,7 @@ await client.accounting.paymentMethods.retrieve("id");
-
-Returns a list of `PaymentTerm` objects.
+Returns a list of `User` objects.
@@ -28103,7 +22190,7 @@ Returns a list of `PaymentTerm` objects.
-
```typescript
-await client.accounting.paymentTerms.list();
+await client.ticketing.users.list();
```
@@ -28119,7 +22206,7 @@ await client.accounting.paymentTerms.list();
-
-**request:** `Merge.accounting.PaymentTermsListRequest`
+**request:** `Merge.ticketing.UsersListRequest`
@@ -28127,7 +22214,7 @@ await client.accounting.paymentTerms.list();
-
-**requestOptions:** `PaymentTerms.RequestOptions`
+**requestOptions:** `Users.RequestOptions`
@@ -28138,7 +22225,7 @@ await client.accounting.paymentTerms.list();
-client.accounting.paymentTerms.retrieve(id, { ...params }) -> Merge.PaymentTerm
+client.ticketing.users.retrieve(id, { ...params }) -> Merge.User
-
@@ -28150,7 +22237,7 @@ await client.accounting.paymentTerms.list();
-
-Returns a `PaymentTerm` object with the given `id`.
+Returns a `User` object with the given `id`.
@@ -28166,7 +22253,7 @@ Returns a `PaymentTerm` object with the given `id`.
-
```typescript
-await client.accounting.paymentTerms.retrieve("id");
+await client.ticketing.users.retrieve("id");
```
@@ -28190,7 +22277,7 @@ await client.accounting.paymentTerms.retrieve("id");
-
-**request:** `Merge.accounting.PaymentTermsRetrieveRequest`
+**request:** `Merge.ticketing.UsersRetrieveRequest`
@@ -28198,7 +22285,7 @@ await client.accounting.paymentTerms.retrieve("id");
-
-**requestOptions:** `PaymentTerms.RequestOptions`
+**requestOptions:** `Users.RequestOptions`
@@ -28209,9 +22296,9 @@ await client.accounting.paymentTerms.retrieve("id");
-## Accounting Payments
+## Ticketing WebhookReceivers
-client.accounting.payments.list({ ...params }) -> Merge.PaginatedPaymentList
+client.ticketing.webhookReceivers.list() -> Merge.WebhookReceiver[]
-
@@ -28223,7 +22310,7 @@ await client.accounting.paymentTerms.retrieve("id");
-
-Returns a list of `Payment` objects.
+Returns a list of `WebhookReceiver` objects.
@@ -28239,7 +22326,7 @@ Returns a list of `Payment` objects.
-
```typescript
-await client.accounting.payments.list();
+await client.ticketing.webhookReceivers.list();
```
@@ -28255,15 +22342,7 @@ await client.accounting.payments.list();
-
-**request:** `Merge.accounting.PaymentsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Payments.RequestOptions`
+**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -28274,7 +22353,7 @@ await client.accounting.payments.list();
-client.accounting.payments.create({ ...params }) -> Merge.PaymentResponse
+client.ticketing.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
-
@@ -28286,7 +22365,7 @@ await client.accounting.payments.list();
-
-Creates a `Payment` object with the given values.
+Creates a `WebhookReceiver` object with the given values.
@@ -28302,8 +22381,9 @@ Creates a `Payment` object with the given values.
-
```typescript
-await client.accounting.payments.create({
- model: {},
+await client.ticketing.webhookReceivers.create({
+ event: "event",
+ isActive: true,
});
```
@@ -28320,7 +22400,7 @@ await client.accounting.payments.create({
-
-**request:** `Merge.accounting.PaymentEndpointRequest`
+**request:** `Merge.ticketing.WebhookReceiverRequest`
@@ -28328,7 +22408,7 @@ await client.accounting.payments.create({
-
-**requestOptions:** `Payments.RequestOptions`
+**requestOptions:** `WebhookReceivers.RequestOptions`
@@ -28339,7 +22419,9 @@ await client.accounting.payments.create({
-client.accounting.payments.retrieve(id, { ...params }) -> Merge.Payment
+## Accounting AccountDetails
+
+client.accounting.accountDetails.retrieve() -> Merge.AccountDetails
-
@@ -28351,7 +22433,7 @@ await client.accounting.payments.create({
-
-Returns a `Payment` object with the given `id`.
+Get details for a linked account.
@@ -28367,7 +22449,7 @@ Returns a `Payment` object with the given `id`.
-
```typescript
-await client.accounting.payments.retrieve("id");
+await client.accounting.accountDetails.retrieve();
```
@@ -28383,23 +22465,7 @@ await client.accounting.payments.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.PaymentsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Payments.RequestOptions`
+**requestOptions:** `AccountDetails.RequestOptions`
@@ -28410,7 +22476,9 @@ await client.accounting.payments.retrieve("id");
-client.accounting.payments.partialUpdate(id, { ...params }) -> Merge.PaymentResponse
+## Accounting AccountToken
+
+client.accounting.accountToken.retrieve(publicToken) -> Merge.AccountToken
-
@@ -28422,7 +22490,7 @@ await client.accounting.payments.retrieve("id");
-
-Updates a `Payment` object with the given `id`.
+Returns the account token for the end user with the provided public token.
@@ -28438,9 +22506,7 @@ Updates a `Payment` object with the given `id`.
-
```typescript
-await client.accounting.payments.partialUpdate("id", {
- model: {},
-});
+await client.accounting.accountToken.retrieve("public_token");
```
@@ -28456,15 +22522,7 @@ await client.accounting.payments.partialUpdate("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.PatchedPaymentEndpointRequest`
+**publicToken:** `string`
@@ -28472,7 +22530,7 @@ await client.accounting.payments.partialUpdate("id", {
-
-**requestOptions:** `Payments.RequestOptions`
+**requestOptions:** `AccountToken.RequestOptions`
@@ -28483,7 +22541,9 @@ await client.accounting.payments.partialUpdate("id", {
-client.accounting.payments.lineItemsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+## Accounting AccountingPeriods
+
+client.accounting.accountingPeriods.list({ ...params }) -> Merge.PaginatedAccountingPeriodList
-
@@ -28495,7 +22555,7 @@ await client.accounting.payments.partialUpdate("id", {
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `AccountingPeriod` objects.
@@ -28511,7 +22571,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.payments.lineItemsRemoteFieldClassesList();
+await client.accounting.accountingPeriods.list();
```
@@ -28527,7 +22587,7 @@ await client.accounting.payments.lineItemsRemoteFieldClassesList();
-
-**request:** `Merge.accounting.PaymentsLineItemsRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.AccountingPeriodsListRequest`
@@ -28535,7 +22595,7 @@ await client.accounting.payments.lineItemsRemoteFieldClassesList();
-
-**requestOptions:** `Payments.RequestOptions`
+**requestOptions:** `AccountingPeriods.RequestOptions`
@@ -28546,7 +22606,7 @@ await client.accounting.payments.lineItemsRemoteFieldClassesList();
-client.accounting.payments.metaPatchRetrieve(id) -> Merge.MetaResponse
+client.accounting.accountingPeriods.retrieve(id, { ...params }) -> Merge.AccountingPeriod
-
@@ -28558,7 +22618,7 @@ await client.accounting.payments.lineItemsRemoteFieldClassesList();
-
-Returns metadata for `Payment` PATCHs.
+Returns an `AccountingPeriod` object with the given `id`.
@@ -28574,7 +22634,7 @@ Returns metadata for `Payment` PATCHs.
-
```typescript
-await client.accounting.payments.metaPatchRetrieve("id");
+await client.accounting.accountingPeriods.retrieve("id");
```
@@ -28598,7 +22658,15 @@ await client.accounting.payments.metaPatchRetrieve("id");
-
-**requestOptions:** `Payments.RequestOptions`
+**request:** `Merge.accounting.AccountingPeriodsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountingPeriods.RequestOptions`
@@ -28609,7 +22677,9 @@ await client.accounting.payments.metaPatchRetrieve("id");
-client.accounting.payments.metaPostRetrieve() -> Merge.MetaResponse
+## Accounting Accounts
+
+client.accounting.accounts.list({ ...params }) -> Merge.PaginatedAccountList
-
@@ -28621,7 +22691,7 @@ await client.accounting.payments.metaPatchRetrieve("id");
-
-Returns metadata for `Payment` POSTs.
+Returns a list of `Account` objects.
@@ -28637,7 +22707,7 @@ Returns metadata for `Payment` POSTs.
-
```typescript
-await client.accounting.payments.metaPostRetrieve();
+await client.accounting.accounts.list();
```
@@ -28653,7 +22723,15 @@ await client.accounting.payments.metaPostRetrieve();
-
-**requestOptions:** `Payments.RequestOptions`
+**request:** `Merge.accounting.AccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
@@ -28664,7 +22742,7 @@ await client.accounting.payments.metaPostRetrieve();
-client.accounting.payments.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.accounting.accounts.create({ ...params }) -> Merge.AccountResponse
-
@@ -28676,7 +22754,7 @@ await client.accounting.payments.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Creates an `Account` object with the given values.
@@ -28692,7 +22770,9 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.payments.remoteFieldClassesList();
+await client.accounting.accounts.create({
+ model: {},
+});
```
@@ -28708,7 +22788,7 @@ await client.accounting.payments.remoteFieldClassesList();
-
-**request:** `Merge.accounting.PaymentsRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.AccountEndpointRequest`
@@ -28716,7 +22796,7 @@ await client.accounting.payments.remoteFieldClassesList();
-
-**requestOptions:** `Payments.RequestOptions`
+**requestOptions:** `Accounts.RequestOptions`
@@ -28727,9 +22807,7 @@ await client.accounting.payments.remoteFieldClassesList();
-## Accounting PhoneNumbers
-
-client.accounting.phoneNumbers.retrieve(id, { ...params }) -> Merge.AccountingPhoneNumber
+client.accounting.accounts.retrieve(id, { ...params }) -> Merge.Account
-
@@ -28741,7 +22819,7 @@ await client.accounting.payments.remoteFieldClassesList();
-
-Returns an `AccountingPhoneNumber` object with the given `id`.
+Returns an `Account` object with the given `id`.
@@ -28757,7 +22835,7 @@ Returns an `AccountingPhoneNumber` object with the given `id`.
-
```typescript
-await client.accounting.phoneNumbers.retrieve("id");
+await client.accounting.accounts.retrieve("id");
```
@@ -28781,7 +22859,7 @@ await client.accounting.phoneNumbers.retrieve("id");
-
-**request:** `Merge.accounting.PhoneNumbersRetrieveRequest`
+**request:** `Merge.accounting.AccountsRetrieveRequest`
@@ -28789,7 +22867,7 @@ await client.accounting.phoneNumbers.retrieve("id");
-
-**requestOptions:** `PhoneNumbers.RequestOptions`
+**requestOptions:** `Accounts.RequestOptions`
@@ -28800,9 +22878,7 @@ await client.accounting.phoneNumbers.retrieve("id");
-## Accounting Projects
-
-client.accounting.projects.list({ ...params }) -> Merge.PaginatedProjectList
+client.accounting.accounts.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -28814,7 +22890,7 @@ await client.accounting.phoneNumbers.retrieve("id");
-
-Returns a list of `Project` objects.
+Returns metadata for `Account` POSTs.
@@ -28830,7 +22906,7 @@ Returns a list of `Project` objects.
-
```typescript
-await client.accounting.projects.list();
+await client.accounting.accounts.metaPostRetrieve();
```
@@ -28846,15 +22922,7 @@ await client.accounting.projects.list();
-
-**request:** `Merge.accounting.ProjectsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Projects.RequestOptions`
+**requestOptions:** `Accounts.RequestOptions`
@@ -28865,7 +22933,9 @@ await client.accounting.projects.list();
-client.accounting.projects.retrieve(id, { ...params }) -> Merge.Project
+## Accounting Addresses
+
+client.accounting.addresses.retrieve(id, { ...params }) -> Merge.Address
-
@@ -28877,7 +22947,7 @@ await client.accounting.projects.list();
-
-Returns a `Project` object with the given `id`.
+Returns an `Address` object with the given `id`.
@@ -28893,7 +22963,7 @@ Returns a `Project` object with the given `id`.
-
```typescript
-await client.accounting.projects.retrieve("id");
+await client.accounting.addresses.retrieve("id");
```
@@ -28917,7 +22987,7 @@ await client.accounting.projects.retrieve("id");
-
-**request:** `Merge.accounting.ProjectsRetrieveRequest`
+**request:** `Merge.accounting.AddressesRetrieveRequest`
@@ -28925,7 +22995,7 @@ await client.accounting.projects.retrieve("id");
-
-**requestOptions:** `Projects.RequestOptions`
+**requestOptions:** `Addresses.RequestOptions`
@@ -28936,9 +23006,9 @@ await client.accounting.projects.retrieve("id");
-## Accounting PurchaseOrders
+## Accounting AsyncPassthrough
-client.accounting.purchaseOrders.list({ ...params }) -> Merge.PaginatedPurchaseOrderList
+client.accounting.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
-
@@ -28950,7 +23020,7 @@ await client.accounting.projects.retrieve("id");
-
-Returns a list of `PurchaseOrder` objects.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -28966,7 +23036,10 @@ Returns a list of `PurchaseOrder` objects.
-
```typescript
-await client.accounting.purchaseOrders.list();
+await client.accounting.asyncPassthrough.create({
+ method: "GET",
+ path: "/scooters",
+});
```
@@ -28982,7 +23055,7 @@ await client.accounting.purchaseOrders.list();
-
-**request:** `Merge.accounting.PurchaseOrdersListRequest`
+**request:** `Merge.DataPassthroughRequest`
@@ -28990,7 +23063,7 @@ await client.accounting.purchaseOrders.list();
-
-**requestOptions:** `PurchaseOrders.RequestOptions`
+**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -29001,7 +23074,7 @@ await client.accounting.purchaseOrders.list();
-client.accounting.purchaseOrders.create({ ...params }) -> Merge.PurchaseOrderResponse
+client.accounting.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
-
@@ -29013,7 +23086,7 @@ await client.accounting.purchaseOrders.list();
-
-Creates a `PurchaseOrder` object with the given values.
+Retrieves data from earlier async-passthrough POST request
@@ -29029,9 +23102,7 @@ Creates a `PurchaseOrder` object with the given values.
-
```typescript
-await client.accounting.purchaseOrders.create({
- model: {},
-});
+await client.accounting.asyncPassthrough.retrieve("async_passthrough_receipt_id");
```
@@ -29047,7 +23118,7 @@ await client.accounting.purchaseOrders.create({
-
-**request:** `Merge.accounting.PurchaseOrderEndpointRequest`
+**asyncPassthroughReceiptId:** `string`
@@ -29055,7 +23126,7 @@ await client.accounting.purchaseOrders.create({
-
-**requestOptions:** `PurchaseOrders.RequestOptions`
+**requestOptions:** `AsyncPassthrough.RequestOptions`
@@ -29066,7 +23137,9 @@ await client.accounting.purchaseOrders.create({
-client.accounting.purchaseOrders.retrieve(id, { ...params }) -> Merge.PurchaseOrder
+## Accounting AsyncTasks
+
+client.accounting.asyncTasks.retrieve(id) -> Merge.AsyncPostTask
-
@@ -29078,7 +23151,7 @@ await client.accounting.purchaseOrders.create({
-
-Returns a `PurchaseOrder` object with the given `id`.
+Returns an `AsyncPostTask` object with the given `id`.
@@ -29094,7 +23167,7 @@ Returns a `PurchaseOrder` object with the given `id`.
-
```typescript
-await client.accounting.purchaseOrders.retrieve("id");
+await client.accounting.asyncTasks.retrieve("id");
```
@@ -29118,15 +23191,7 @@ await client.accounting.purchaseOrders.retrieve("id");
-
-**request:** `Merge.accounting.PurchaseOrdersRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `PurchaseOrders.RequestOptions`
+**requestOptions:** `AsyncTasks.RequestOptions`
@@ -29137,7 +23202,9 @@ await client.accounting.purchaseOrders.retrieve("id");
-client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+## Accounting Attachments
+
+client.accounting.attachments.list({ ...params }) -> Merge.PaginatedAccountingAttachmentList
-
@@ -29149,7 +23216,7 @@ await client.accounting.purchaseOrders.retrieve("id");
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `AccountingAttachment` objects.
@@ -29165,7 +23232,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList();
+await client.accounting.attachments.list();
```
@@ -29181,7 +23248,7 @@ await client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList();
-
-**request:** `Merge.accounting.PurchaseOrdersLineItemsRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.AttachmentsListRequest`
@@ -29189,7 +23256,7 @@ await client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList();
-
-**requestOptions:** `PurchaseOrders.RequestOptions`
+**requestOptions:** `Attachments.RequestOptions`
@@ -29200,7 +23267,7 @@ await client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList();
-client.accounting.purchaseOrders.metaPostRetrieve() -> Merge.MetaResponse
+client.accounting.attachments.create({ ...params }) -> Merge.AccountingAttachmentResponse
-
@@ -29212,7 +23279,7 @@ await client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList();
-
-Returns metadata for `PurchaseOrder` POSTs.
+Creates an `AccountingAttachment` object with the given values.
@@ -29228,7 +23295,9 @@ Returns metadata for `PurchaseOrder` POSTs.
-
```typescript
-await client.accounting.purchaseOrders.metaPostRetrieve();
+await client.accounting.attachments.create({
+ model: {},
+});
```
@@ -29244,7 +23313,15 @@ await client.accounting.purchaseOrders.metaPostRetrieve();
-
-**requestOptions:** `PurchaseOrders.RequestOptions`
+**request:** `Merge.accounting.AccountingAttachmentEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
@@ -29255,7 +23332,7 @@ await client.accounting.purchaseOrders.metaPostRetrieve();
-client.accounting.purchaseOrders.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.accounting.attachments.retrieve(id, { ...params }) -> Merge.AccountingAttachment
-
@@ -29267,7 +23344,7 @@ await client.accounting.purchaseOrders.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Returns an `AccountingAttachment` object with the given `id`.
@@ -29283,7 +23360,7 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.accounting.purchaseOrders.remoteFieldClassesList();
+await client.accounting.attachments.retrieve("id");
```
@@ -29299,7 +23376,15 @@ await client.accounting.purchaseOrders.remoteFieldClassesList();
-
-**request:** `Merge.accounting.PurchaseOrdersRemoteFieldClassesListRequest`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.AttachmentsRetrieveRequest`
@@ -29307,7 +23392,7 @@ await client.accounting.purchaseOrders.remoteFieldClassesList();
-
-**requestOptions:** `PurchaseOrders.RequestOptions`
+**requestOptions:** `Attachments.RequestOptions`
@@ -29318,9 +23403,7 @@ await client.accounting.purchaseOrders.remoteFieldClassesList();
-## Accounting RegenerateKey
-
-client.accounting.regenerateKey.create({ ...params }) -> Merge.RemoteKey
+client.accounting.attachments.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -29332,7 +23415,7 @@ await client.accounting.purchaseOrders.remoteFieldClassesList();
-
-Exchange remote keys.
+Returns metadata for `AccountingAttachment` POSTs.
@@ -29348,9 +23431,7 @@ Exchange remote keys.
-
```typescript
-await client.accounting.regenerateKey.create({
- name: "Remote Deployment Key 1",
-});
+await client.accounting.attachments.metaPostRetrieve();
```
@@ -29366,15 +23447,7 @@ await client.accounting.regenerateKey.create({
-
-**request:** `Merge.accounting.RemoteKeyForRegenerationRequest`
-
-
-
-
-
--
-
-**requestOptions:** `RegenerateKey.RequestOptions`
+**requestOptions:** `Attachments.RequestOptions`
@@ -29385,9 +23458,9 @@ await client.accounting.regenerateKey.create({
-## Accounting SyncStatus
+## Accounting AuditTrail
-client.accounting.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+client.accounting.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
-
@@ -29399,7 +23472,7 @@ await client.accounting.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).
+Gets a list of audit trail events.
@@ -29415,7 +23488,7 @@ Get sync status for the current sync and the most recently finished sync. `last_
-
```typescript
-await client.accounting.syncStatus.list();
+await client.accounting.auditTrail.list();
```
@@ -29431,7 +23504,7 @@ await client.accounting.syncStatus.list();
-
-**request:** `Merge.accounting.SyncStatusListRequest`
+**request:** `Merge.accounting.AuditTrailListRequest`
@@ -29439,7 +23512,7 @@ await client.accounting.syncStatus.list();
-
-**requestOptions:** `SyncStatus.RequestOptions`
+**requestOptions:** `AuditTrail.RequestOptions`
@@ -29450,9 +23523,9 @@ await client.accounting.syncStatus.list();
-## Accounting ForceResync
+## Accounting AvailableActions
-client.accounting.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+client.accounting.availableActions.retrieve() -> Merge.AvailableActions
-
@@ -29464,7 +23537,7 @@ await client.accounting.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 models and actions available for an account.
@@ -29480,7 +23553,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
-
```typescript
-await client.accounting.forceResync.syncStatusResyncCreate();
+await client.accounting.availableActions.retrieve();
```
@@ -29496,7 +23569,7 @@ await client.accounting.forceResync.syncStatusResyncCreate();
-
-**requestOptions:** `ForceResync.RequestOptions`
+**requestOptions:** `AvailableActions.RequestOptions`
@@ -29507,9 +23580,9 @@ await client.accounting.forceResync.syncStatusResyncCreate();
-## Accounting TaxRates
+## Accounting BalanceSheets
-client.accounting.taxRates.list({ ...params }) -> Merge.PaginatedTaxRateList
+client.accounting.balanceSheets.list({ ...params }) -> Merge.PaginatedBalanceSheetList
-
@@ -29521,7 +23594,7 @@ await client.accounting.forceResync.syncStatusResyncCreate();
-
-Returns a list of `TaxRate` objects.
+Returns a list of `BalanceSheet` objects.
@@ -29537,7 +23610,7 @@ Returns a list of `TaxRate` objects.
-
```typescript
-await client.accounting.taxRates.list();
+await client.accounting.balanceSheets.list();
```
@@ -29553,7 +23626,7 @@ await client.accounting.taxRates.list();
-
-**request:** `Merge.accounting.TaxRatesListRequest`
+**request:** `Merge.accounting.BalanceSheetsListRequest`
@@ -29561,7 +23634,7 @@ await client.accounting.taxRates.list();
-
-**requestOptions:** `TaxRates.RequestOptions`
+**requestOptions:** `BalanceSheets.RequestOptions`
@@ -29572,7 +23645,7 @@ await client.accounting.taxRates.list();
-client.accounting.taxRates.retrieve(id, { ...params }) -> Merge.TaxRate
+client.accounting.balanceSheets.retrieve(id, { ...params }) -> Merge.BalanceSheet
-
@@ -29584,7 +23657,7 @@ await client.accounting.taxRates.list();
-
-Returns a `TaxRate` object with the given `id`.
+Returns a `BalanceSheet` object with the given `id`.
@@ -29600,7 +23673,7 @@ Returns a `TaxRate` object with the given `id`.
-
```typescript
-await client.accounting.taxRates.retrieve("id");
+await client.accounting.balanceSheets.retrieve("id");
```
@@ -29624,7 +23697,7 @@ await client.accounting.taxRates.retrieve("id");
-
-**request:** `Merge.accounting.TaxRatesRetrieveRequest`
+**request:** `Merge.accounting.BalanceSheetsRetrieveRequest`
@@ -29632,7 +23705,7 @@ await client.accounting.taxRates.retrieve("id");
-
-**requestOptions:** `TaxRates.RequestOptions`
+**requestOptions:** `BalanceSheets.RequestOptions`
@@ -29643,9 +23716,9 @@ await client.accounting.taxRates.retrieve("id");
-## Accounting TrackingCategories
+## Accounting BankFeedAccounts
-client.accounting.trackingCategories.list({ ...params }) -> Merge.PaginatedTrackingCategoryList
+client.accounting.bankFeedAccounts.list({ ...params }) -> Merge.PaginatedBankFeedAccountList
-
@@ -29657,7 +23730,7 @@ await client.accounting.taxRates.retrieve("id");
-
-Returns a list of `TrackingCategory` objects.
+Returns a list of `BankFeedAccount` objects.
@@ -29673,7 +23746,7 @@ Returns a list of `TrackingCategory` objects.
-
```typescript
-await client.accounting.trackingCategories.list();
+await client.accounting.bankFeedAccounts.list();
```
@@ -29689,7 +23762,7 @@ await client.accounting.trackingCategories.list();
-
-**request:** `Merge.accounting.TrackingCategoriesListRequest`
+**request:** `Merge.accounting.BankFeedAccountsListRequest`
@@ -29697,7 +23770,7 @@ await client.accounting.trackingCategories.list();
-
-**requestOptions:** `TrackingCategories.RequestOptions`
+**requestOptions:** `BankFeedAccounts.RequestOptions`
@@ -29708,7 +23781,7 @@ await client.accounting.trackingCategories.list();
-client.accounting.trackingCategories.retrieve(id, { ...params }) -> Merge.TrackingCategory
+client.accounting.bankFeedAccounts.create({ ...params }) -> Merge.BankFeedAccountResponse
-
@@ -29720,7 +23793,7 @@ await client.accounting.trackingCategories.list();
-
-Returns a `TrackingCategory` object with the given `id`.
+Creates a `BankFeedAccount` object with the given values.
@@ -29736,7 +23809,9 @@ Returns a `TrackingCategory` object with the given `id`.
-
```typescript
-await client.accounting.trackingCategories.retrieve("id");
+await client.accounting.bankFeedAccounts.create({
+ model: {},
+});
```
@@ -29752,15 +23827,7 @@ await client.accounting.trackingCategories.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.TrackingCategoriesRetrieveRequest`
+**request:** `Merge.accounting.BankFeedAccountEndpointRequest`
@@ -29768,7 +23835,7 @@ await client.accounting.trackingCategories.retrieve("id");
-
-**requestOptions:** `TrackingCategories.RequestOptions`
+**requestOptions:** `BankFeedAccounts.RequestOptions`
@@ -29779,9 +23846,7 @@ await client.accounting.trackingCategories.retrieve("id");
-## Accounting Transactions
-
-client.accounting.transactions.list({ ...params }) -> Merge.PaginatedTransactionList
+client.accounting.bankFeedAccounts.retrieve(id, { ...params }) -> Merge.BankFeedAccount
-
@@ -29793,7 +23858,7 @@ await client.accounting.trackingCategories.retrieve("id");
-
-Returns a list of `Transaction` objects.
+Returns a `BankFeedAccount` object with the given `id`.
@@ -29809,7 +23874,7 @@ Returns a list of `Transaction` objects.
-
```typescript
-await client.accounting.transactions.list();
+await client.accounting.bankFeedAccounts.retrieve("id");
```
@@ -29825,7 +23890,15 @@ await client.accounting.transactions.list();
-
-**request:** `Merge.accounting.TransactionsListRequest`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.BankFeedAccountsRetrieveRequest`
@@ -29833,7 +23906,7 @@ await client.accounting.transactions.list();
-
-**requestOptions:** `Transactions.RequestOptions`
+**requestOptions:** `BankFeedAccounts.RequestOptions`
@@ -29844,7 +23917,7 @@ await client.accounting.transactions.list();
-client.accounting.transactions.retrieve(id, { ...params }) -> Merge.Transaction
+client.accounting.bankFeedAccounts.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -29856,7 +23929,7 @@ await client.accounting.transactions.list();
-
-Returns a `Transaction` object with the given `id`.
+Returns metadata for `BankFeedAccount` POSTs.
@@ -29872,7 +23945,7 @@ Returns a `Transaction` object with the given `id`.
-
```typescript
-await client.accounting.transactions.retrieve("id");
+await client.accounting.bankFeedAccounts.metaPostRetrieve();
```
@@ -29888,23 +23961,7 @@ await client.accounting.transactions.retrieve("id");
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.accounting.TransactionsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `Transactions.RequestOptions`
+**requestOptions:** `BankFeedAccounts.RequestOptions`
@@ -29915,9 +23972,9 @@ await client.accounting.transactions.retrieve("id");
-## Accounting VendorCredits
+## Accounting BankFeedTransactions
-client.accounting.vendorCredits.list({ ...params }) -> Merge.PaginatedVendorCreditList
+client.accounting.bankFeedTransactions.list({ ...params }) -> Merge.PaginatedBankFeedTransactionList
-
@@ -29929,7 +23986,7 @@ await client.accounting.transactions.retrieve("id");