# Reference ## Ats AccountDetails
client.ats.accountDetails.retrieve() -> Merge.AccountDetails
#### 📝 Description
Get details for a linked account.
#### 🔌 Usage
```typescript await client.ats.accountDetails.retrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountDetailsClient.RequestOptions`
## Ats AccountToken
client.ats.accountToken.retrieve(public_token) -> Merge.AccountToken
#### 📝 Description
Returns the account token for the end user with the provided public token.
#### 🔌 Usage
```typescript await client.ats.accountToken.retrieve("public_token"); ```
#### ⚙️ Parameters
**public_token:** `string`
**requestOptions:** `AccountTokenClient.RequestOptions`
client.ats.accountToken.regenerateCreate() -> Merge.RegenerateAccountToken
#### 📝 Description
Exchange Linked Account account tokens.
#### 🔌 Usage
```typescript await client.ats.accountToken.regenerateCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountTokenClient.RequestOptions`
## Ats Activities
client.ats.activities.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Activity` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.activities.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "activity_type", remoteId: "remote_id", showEnumOrigins: "activity_type", userId: "user_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.activities.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "activity_type", remoteId: "remote_id", showEnumOrigins: "activity_type", userId: "user_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.ActivitiesListRequest`
**requestOptions:** `ActivitiesClient.RequestOptions`
client.ats.activities.create({ ...params }) -> Merge.ActivityResponse
#### 📝 Description
Creates an `Activity` object with the given values.
#### 🔌 Usage
```typescript await client.ats.activities.create({ isDebugMode: true, runAsync: true, model: {}, remoteUserId: "remote_user_id" }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.ActivityEndpointRequest`
**requestOptions:** `ActivitiesClient.RequestOptions`
client.ats.activities.retrieve(id, { ...params }) -> Merge.Activity
#### 📝 Description
Returns an `Activity` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.activities.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "activity_type", showEnumOrigins: "activity_type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.ActivitiesRetrieveRequest`
**requestOptions:** `ActivitiesClient.RequestOptions`
client.ats.activities.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Activity` POSTs.
#### 🔌 Usage
```typescript await client.ats.activities.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ActivitiesClient.RequestOptions`
## Ats Applications
client.ats.applications.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Application` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.applications.list({ candidateId: "candidate_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), creditedToId: "credited_to_id", currentStageId: "current_stage_id", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, jobId: "job_id", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, rejectReasonId: "reject_reason_id", remoteId: "remote_id", source: "source" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.applications.list({ candidateId: "candidate_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), creditedToId: "credited_to_id", currentStageId: "current_stage_id", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, jobId: "job_id", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, rejectReasonId: "reject_reason_id", remoteId: "remote_id", source: "source" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.ApplicationsListRequest`
**requestOptions:** `ApplicationsClient.RequestOptions`
client.ats.applications.create({ ...params }) -> Merge.ApplicationResponse
#### 📝 Description
Creates an `Application` object with the given values. For certain integrations, but not all, our API detects duplicate candidates and will associate applications with existing records in the third-party. New candidates are created and automatically linked to the application. See our [Help Center article](https://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024) for detailed support per integration.
#### 🔌 Usage
```typescript await client.ats.applications.create({ isDebugMode: true, runAsync: true, model: {}, remoteUserId: "remote_user_id" }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.ApplicationEndpointRequest`
**requestOptions:** `ApplicationsClient.RequestOptions`
client.ats.applications.retrieve(id, { ...params }) -> Merge.Application
#### 📝 Description
Returns an `Application` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.applications.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.ApplicationsRetrieveRequest`
**requestOptions:** `ApplicationsClient.RequestOptions`
client.ats.applications.changeStageCreate(id, { ...params }) -> Merge.ApplicationResponse
#### 📝 Description
Updates the `current_stage` field of an `Application` object
#### 🔌 Usage
```typescript await client.ats.applications.changeStageCreate("id", { isDebugMode: true, runAsync: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.UpdateApplicationStageRequest`
**requestOptions:** `ApplicationsClient.RequestOptions`
client.ats.applications.metaPostRetrieve({ ...params }) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Application` POSTs.
#### 🔌 Usage
```typescript await client.ats.applications.metaPostRetrieve({ applicationRemoteTemplateId: "application_remote_template_id" }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.ApplicationsMetaPostRetrieveRequest`
**requestOptions:** `ApplicationsClient.RequestOptions`
## Ats AsyncPassthrough
client.ats.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
#### 📝 Description
Asynchronously pull data from an endpoint not currently supported by Merge.
#### 🔌 Usage
```typescript await client.ats.asyncPassthrough.create({ method: "GET", path: "/scooters" }); ```
#### ⚙️ Parameters
**request:** `Merge.DataPassthroughRequest`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
client.ats.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
#### 📝 Description
Retrieves data from earlier async-passthrough POST request
#### 🔌 Usage
```typescript await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
#### ⚙️ Parameters
**async_passthrough_receipt_id:** `string`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
## Ats Attachments
client.ats.attachments.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Attachment` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.attachments.list({ candidateId: "candidate_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "attachment_type", remoteId: "remote_id", showEnumOrigins: "attachment_type" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.attachments.list({ candidateId: "candidate_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "attachment_type", remoteId: "remote_id", showEnumOrigins: "attachment_type" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.AttachmentsListRequest`
**requestOptions:** `AttachmentsClient.RequestOptions`
client.ats.attachments.create({ ...params }) -> Merge.AttachmentResponse
#### 📝 Description
Creates an `Attachment` object with the given values.
#### 🔌 Usage
```typescript await client.ats.attachments.create({ isDebugMode: true, runAsync: true, model: {}, remoteUserId: "remote_user_id" }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.AttachmentEndpointRequest`
**requestOptions:** `AttachmentsClient.RequestOptions`
client.ats.attachments.retrieve(id, { ...params }) -> Merge.Attachment
#### 📝 Description
Returns an `Attachment` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.attachments.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "attachment_type", showEnumOrigins: "attachment_type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.AttachmentsRetrieveRequest`
**requestOptions:** `AttachmentsClient.RequestOptions`
client.ats.attachments.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Attachment` POSTs.
#### 🔌 Usage
```typescript await client.ats.attachments.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AttachmentsClient.RequestOptions`
## Ats AuditTrail
client.ats.auditTrail.list({ ...params }) -> core.Page
#### 📝 Description
Gets a list of audit trail events.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.AuditTrailListRequest`
**requestOptions:** `AuditTrailClient.RequestOptions`
## Ats AvailableActions
client.ats.availableActions.retrieve() -> Merge.AvailableActions
#### 📝 Description
Returns a list of models and actions available for an account.
#### 🔌 Usage
```typescript await client.ats.availableActions.retrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AvailableActionsClient.RequestOptions`
## Ats Candidates
client.ats.candidates.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Candidate` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.candidates.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddresses: "email_addresses", firstName: "first_name", includeDeletedData: true, includeRemoteData: true, includeShellData: true, lastName: "last_name", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", tags: "tags" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.candidates.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddresses: "email_addresses", firstName: "first_name", includeDeletedData: true, includeRemoteData: true, includeShellData: true, lastName: "last_name", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", tags: "tags" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.CandidatesListRequest`
**requestOptions:** `CandidatesClient.RequestOptions`
client.ats.candidates.create({ ...params }) -> Merge.CandidateResponse
#### 📝 Description
Creates a `Candidate` object with the given values.
#### 🔌 Usage
```typescript await client.ats.candidates.create({ isDebugMode: true, runAsync: true, model: {}, remoteUserId: "remote_user_id" }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.CandidateEndpointRequest`
**requestOptions:** `CandidatesClient.RequestOptions`
client.ats.candidates.retrieve(id, { ...params }) -> Merge.Candidate
#### 📝 Description
Returns a `Candidate` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.candidates.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.CandidatesRetrieveRequest`
**requestOptions:** `CandidatesClient.RequestOptions`
client.ats.candidates.partialUpdate(id, { ...params }) -> Merge.CandidateResponse
#### 📝 Description
Updates a `Candidate` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.candidates.partialUpdate("id", { isDebugMode: true, runAsync: true, model: {}, remoteUserId: "remote_user_id" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.PatchedCandidateEndpointRequest`
**requestOptions:** `CandidatesClient.RequestOptions`
client.ats.candidates.ignoreCreate(model_id, { ...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.ats.candidates.ignoreCreate("model_id", { reason: "GENERAL_CUSTOMER_REQUEST" }); ```
#### ⚙️ Parameters
**model_id:** `string`
**request:** `Merge.IgnoreCommonModelRequest`
**requestOptions:** `CandidatesClient.RequestOptions`
client.ats.candidates.metaPatchRetrieve(id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Candidate` PATCHs.
#### 🔌 Usage
```typescript await client.ats.candidates.metaPatchRetrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `CandidatesClient.RequestOptions`
client.ats.candidates.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Candidate` POSTs.
#### 🔌 Usage
```typescript await client.ats.candidates.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `CandidatesClient.RequestOptions`
## Ats Scopes
client.ats.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.ats.scopes.defaultScopesRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ScopesClient.RequestOptions`
client.ats.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.ats.scopes.linkedAccountScopesRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ScopesClient.RequestOptions`
client.ats.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.ats.scopes.linkedAccountScopesCreate({ commonModels: [{ modelName: "Employee", modelPermissions: { "READ": { isEnabled: true }, "WRITE": { isEnabled: false } }, fieldPermissions: { enabledFields: ["avatar", "home_location"], disabledFields: ["work_location"] } }, { modelName: "Benefit", modelPermissions: { "WRITE": { isEnabled: false } } }] }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.LinkedAccountCommonModelScopeDeserializerRequest`
**requestOptions:** `ScopesClient.RequestOptions`
## Ats DeleteAccount
client.ats.deleteAccount.delete() -> void
#### 📝 Description
Delete a linked account.
#### 🔌 Usage
```typescript await client.ats.deleteAccount.delete(); ```
#### ⚙️ Parameters
**requestOptions:** `DeleteAccountClient.RequestOptions`
## Ats Departments
client.ats.departments.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Department` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.departments.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.departments.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.DepartmentsListRequest`
**requestOptions:** `DepartmentsClient.RequestOptions`
client.ats.departments.retrieve(id, { ...params }) -> Merge.Department
#### 📝 Description
Returns a `Department` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.departments.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.DepartmentsRetrieveRequest`
**requestOptions:** `DepartmentsClient.RequestOptions`
## Ats Eeocs
client.ats.eeocs.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `EEOC` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.eeocs.list({ candidateId: "candidate_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "disability_status", remoteId: "remote_id", showEnumOrigins: "disability_status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.eeocs.list({ candidateId: "candidate_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "disability_status", remoteId: "remote_id", showEnumOrigins: "disability_status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.EeocsListRequest`
**requestOptions:** `EeocsClient.RequestOptions`
client.ats.eeocs.retrieve(id, { ...params }) -> Merge.Eeoc
#### 📝 Description
Returns an `EEOC` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.eeocs.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "disability_status", showEnumOrigins: "disability_status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.EeocsRetrieveRequest`
**requestOptions:** `EeocsClient.RequestOptions`
## Ats FieldMapping
client.ats.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.ats.fieldMapping.fieldMappingsRetrieve({ excludeRemoteFieldMetadata: true }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.FieldMappingsRetrieveRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.ats.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.ats.fieldMapping.fieldMappingsCreate({ excludeRemoteFieldMetadata: true, 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.ats.CreateFieldMappingRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.ats.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> 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.ats.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.ats.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...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.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", { remoteDataIterationCount: 1 }); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**request:** `Merge.ats.PatchedEditFieldMappingRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.ats.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.ats.fieldMapping.remoteFieldsRetrieve({ commonModels: "common_models", includeExampleValues: "include_example_values" }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.RemoteFieldsRetrieveRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.ats.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.ats.fieldMapping.targetFieldsRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `FieldMappingClient.RequestOptions`
## Ats GenerateKey
client.ats.generateKey.create({ ...params }) -> Merge.RemoteKey
#### 📝 Description
Create a remote key.
#### 🔌 Usage
```typescript await client.ats.generateKey.create({ name: "Remote Deployment Key 1" }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.GenerateRemoteKeyRequest`
**requestOptions:** `GenerateKeyClient.RequestOptions`
## Ats Interviews
client.ats.interviews.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `ScheduledInterview` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.interviews.list({ applicationId: "application_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, jobId: "job_id", jobInterviewStageId: "job_interview_stage_id", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), organizerId: "organizer_id", pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.interviews.list({ applicationId: "application_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, jobId: "job_id", jobInterviewStageId: "job_interview_stage_id", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), organizerId: "organizer_id", pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.InterviewsListRequest`
**requestOptions:** `InterviewsClient.RequestOptions`
client.ats.interviews.create({ ...params }) -> Merge.ScheduledInterviewResponse
#### 📝 Description
Creates a `ScheduledInterview` object with the given values.
#### 🔌 Usage
```typescript await client.ats.interviews.create({ isDebugMode: true, runAsync: true, model: {}, remoteUserId: "remote_user_id" }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.ScheduledInterviewEndpointRequest`
**requestOptions:** `InterviewsClient.RequestOptions`
client.ats.interviews.retrieve(id, { ...params }) -> Merge.ScheduledInterview
#### 📝 Description
Returns a `ScheduledInterview` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.interviews.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.InterviewsRetrieveRequest`
**requestOptions:** `InterviewsClient.RequestOptions`
client.ats.interviews.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `ScheduledInterview` POSTs.
#### 🔌 Usage
```typescript await client.ats.interviews.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `InterviewsClient.RequestOptions`
## Ats Issues
client.ats.issues.list({ ...params }) -> core.Page
#### 📝 Description
Gets all issues for Organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.IssuesListRequest`
**requestOptions:** `IssuesClient.RequestOptions`
client.ats.issues.retrieve(id) -> Merge.Issue
#### 📝 Description
Get a specific issue.
#### 🔌 Usage
```typescript await client.ats.issues.retrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `IssuesClient.RequestOptions`
## Ats JobInterviewStages
client.ats.jobInterviewStages.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `JobInterviewStage` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.jobInterviewStages.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, jobId: "job_id", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.jobInterviewStages.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, jobId: "job_id", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.JobInterviewStagesListRequest`
**requestOptions:** `JobInterviewStagesClient.RequestOptions`
client.ats.jobInterviewStages.retrieve(id, { ...params }) -> Merge.JobInterviewStage
#### 📝 Description
Returns a `JobInterviewStage` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.jobInterviewStages.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.JobInterviewStagesRetrieveRequest`
**requestOptions:** `JobInterviewStagesClient.RequestOptions`
## Ats JobPostings
client.ats.jobPostings.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `JobPosting` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.jobPostings.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", status: "CLOSED" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.jobPostings.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", status: "CLOSED" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.JobPostingsListRequest`
**requestOptions:** `JobPostingsClient.RequestOptions`
client.ats.jobPostings.retrieve(id, { ...params }) -> Merge.JobPosting
#### 📝 Description
Returns a `JobPosting` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.jobPostings.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.JobPostingsRetrieveRequest`
**requestOptions:** `JobPostingsClient.RequestOptions`
## Ats Jobs
client.ats.jobs.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Job` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.jobs.list({ code: "code", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), offices: "offices", pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", status: "ARCHIVED" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.jobs.list({ code: "code", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), offices: "offices", pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", status: "ARCHIVED" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.JobsListRequest`
**requestOptions:** `JobsClient.RequestOptions`
client.ats.jobs.retrieve(id, { ...params }) -> Merge.Job
#### 📝 Description
Returns a `Job` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.jobs.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.JobsRetrieveRequest`
**requestOptions:** `JobsClient.RequestOptions`
client.ats.jobs.screeningQuestionsList(job_id, { ...params }) -> core.Page
#### 📝 Description
Returns a list of `ScreeningQuestion` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.jobs.screeningQuestionsList("job_id", { cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.jobs.screeningQuestionsList("job_id", { cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**job_id:** `string`
**request:** `Merge.ats.JobsScreeningQuestionsListRequest`
**requestOptions:** `JobsClient.RequestOptions`
## Ats LinkToken
client.ats.linkToken.create({ ...params }) -> Merge.LinkToken
#### 📝 Description
Creates a link token to be used when linking a new end user. The link token expires after single use.
#### 🔌 Usage
```typescript await client.ats.linkToken.create({ endUserEmailAddress: "example@gmail.com", endUserOrganizationName: "Test Organization", endUserOriginId: "12345", categories: ["hris", "ats"] }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.EndUserDetailsRequest`
**requestOptions:** `LinkTokenClient.RequestOptions`
## Ats LinkedAccounts
client.ats.linkedAccounts.list({ ...params }) -> core.Page
#### 📝 Description
List linked accounts for your organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.LinkedAccountsListRequest`
**requestOptions:** `LinkedAccountsClient.RequestOptions`
## Ats Offers
client.ats.offers.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Offer` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.offers.list({ applicationId: "application_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), creatorId: "creator_id", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", status: "APPROVAL-SENT" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.offers.list({ applicationId: "application_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), creatorId: "creator_id", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", status: "APPROVAL-SENT" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.OffersListRequest`
**requestOptions:** `OffersClient.RequestOptions`
client.ats.offers.retrieve(id, { ...params }) -> Merge.Offer
#### 📝 Description
Returns an `Offer` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.offers.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.OffersRetrieveRequest`
**requestOptions:** `OffersClient.RequestOptions`
## Ats Offices
client.ats.offices.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Office` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.offices.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.offices.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.OfficesListRequest`
**requestOptions:** `OfficesClient.RequestOptions`
client.ats.offices.retrieve(id, { ...params }) -> Merge.Office
#### 📝 Description
Returns an `Office` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.offices.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.OfficesRetrieveRequest`
**requestOptions:** `OfficesClient.RequestOptions`
## Ats Passthrough
client.ats.passthrough.create({ ...params }) -> Merge.RemoteResponse
#### 📝 Description
Pull data from an endpoint not currently supported by Merge.
#### 🔌 Usage
```typescript await client.ats.passthrough.create({ method: "GET", path: "/scooters" }); ```
#### ⚙️ Parameters
**request:** `Merge.DataPassthroughRequest`
**requestOptions:** `PassthroughClient.RequestOptions`
## Ats RegenerateKey
client.ats.regenerateKey.create({ ...params }) -> Merge.RemoteKey
#### 📝 Description
Exchange remote keys.
#### 🔌 Usage
```typescript await client.ats.regenerateKey.create({ name: "Remote Deployment Key 1" }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.RemoteKeyForRegenerationRequest`
**requestOptions:** `RegenerateKeyClient.RequestOptions`
## Ats RejectReasons
client.ats.rejectReasons.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RejectReason` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.rejectReasons.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.rejectReasons.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.RejectReasonsListRequest`
**requestOptions:** `RejectReasonsClient.RequestOptions`
client.ats.rejectReasons.retrieve(id, { ...params }) -> Merge.RejectReason
#### 📝 Description
Returns a `RejectReason` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.rejectReasons.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.RejectReasonsRetrieveRequest`
**requestOptions:** `RejectReasonsClient.RequestOptions`
## Ats Scorecards
client.ats.scorecards.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Scorecard` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.scorecards.list({ applicationId: "application_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, interviewId: "interview_id", interviewerId: "interviewer_id", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "overall_recommendation", remoteId: "remote_id", showEnumOrigins: "overall_recommendation" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.scorecards.list({ applicationId: "application_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, interviewId: "interview_id", interviewerId: "interviewer_id", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "overall_recommendation", remoteId: "remote_id", showEnumOrigins: "overall_recommendation" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.ScorecardsListRequest`
**requestOptions:** `ScorecardsClient.RequestOptions`
client.ats.scorecards.retrieve(id, { ...params }) -> Merge.Scorecard
#### 📝 Description
Returns a `Scorecard` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.scorecards.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "overall_recommendation", showEnumOrigins: "overall_recommendation" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.ScorecardsRetrieveRequest`
**requestOptions:** `ScorecardsClient.RequestOptions`
## Ats SyncStatus
client.ats.syncStatus.list({ ...params }) -> core.Page
#### 📝 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 const pageableResponse = await client.ats.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.SyncStatusListRequest`
**requestOptions:** `SyncStatusClient.RequestOptions`
## Ats ForceResync
client.ats.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.ats.forceResync.syncStatusResyncCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `ForceResyncClient.RequestOptions`
## Ats Tags
client.ats.tags.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Tag` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.tags.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.tags.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.TagsListRequest`
**requestOptions:** `TagsClient.RequestOptions`
## Ats Users
client.ats.users.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteUser` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ats.users.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", email: "email", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "access_role", remoteId: "remote_id", showEnumOrigins: "access_role" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ats.users.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", email: "email", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "access_role", remoteId: "remote_id", showEnumOrigins: "access_role" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ats.UsersListRequest`
**requestOptions:** `UsersClient.RequestOptions`
client.ats.users.retrieve(id, { ...params }) -> Merge.RemoteUser
#### 📝 Description
Returns a `RemoteUser` object with the given `id`.
#### 🔌 Usage
```typescript await client.ats.users.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "access_role", showEnumOrigins: "access_role" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ats.UsersRetrieveRequest`
**requestOptions:** `UsersClient.RequestOptions`
## Ats WebhookReceivers
client.ats.webhookReceivers.list() -> Merge.WebhookReceiver[]
#### 📝 Description
Returns a list of `WebhookReceiver` objects.
#### 🔌 Usage
```typescript await client.ats.webhookReceivers.list(); ```
#### ⚙️ Parameters
**requestOptions:** `WebhookReceiversClient.RequestOptions`
client.ats.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
#### 📝 Description
Creates a `WebhookReceiver` object with the given values.
#### 🔌 Usage
```typescript await client.ats.webhookReceivers.create({ event: "event", isActive: true }); ```
#### ⚙️ Parameters
**request:** `Merge.ats.WebhookReceiverRequest`
**requestOptions:** `WebhookReceiversClient.RequestOptions`
## Accounting AccountDetails
client.accounting.accountDetails.retrieve() -> Merge.AccountDetails
#### 📝 Description
Get details for a linked account.
#### 🔌 Usage
```typescript await client.accounting.accountDetails.retrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountDetailsClient.RequestOptions`
## Accounting AccountToken
client.accounting.accountToken.retrieve(public_token) -> Merge.AccountToken
#### 📝 Description
Returns the account token for the end user with the provided public token.
#### 🔌 Usage
```typescript await client.accounting.accountToken.retrieve("public_token"); ```
#### ⚙️ Parameters
**public_token:** `string`
**requestOptions:** `AccountTokenClient.RequestOptions`
client.accounting.accountToken.regenerateCreate() -> Merge.RegenerateAccountToken
#### 📝 Description
Exchange Linked Account account tokens.
#### 🔌 Usage
```typescript await client.accounting.accountToken.regenerateCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountTokenClient.RequestOptions`
## Accounting AccountingPeriods
client.accounting.accountingPeriods.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `AccountingPeriod` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.accountingPeriods.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.accountingPeriods.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.AccountingPeriodsListRequest`
**requestOptions:** `AccountingPeriodsClient.RequestOptions`
client.accounting.accountingPeriods.retrieve(id, { ...params }) -> Merge.AccountingPeriod
#### 📝 Description
Returns an `AccountingPeriod` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.accountingPeriods.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.AccountingPeriodsRetrieveRequest`
**requestOptions:** `AccountingPeriodsClient.RequestOptions`
## Accounting Accounts
client.accounting.accounts.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Account` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.accounts.list({ accountType: "account_type", classification: "", companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteFields: "classification", remoteId: "remote_id", showEnumOrigins: "classification", status: "" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.accounts.list({ accountType: "account_type", classification: "", companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteFields: "classification", remoteId: "remote_id", showEnumOrigins: "classification", status: "" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.AccountsListRequest`
**requestOptions:** `AccountsClient.RequestOptions`
client.accounting.accounts.create({ ...params }) -> Merge.AccountResponse
#### 📝 Description
Creates an `Account` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.accounts.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.AccountEndpointRequest`
**requestOptions:** `AccountsClient.RequestOptions`
client.accounting.accounts.retrieve(id, { ...params }) -> Merge.Account
#### 📝 Description
Returns an `Account` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.accounts.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "classification", showEnumOrigins: "classification" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.AccountsRetrieveRequest`
**requestOptions:** `AccountsClient.RequestOptions`
client.accounting.accounts.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Account` POSTs.
#### 🔌 Usage
```typescript await client.accounting.accounts.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountsClient.RequestOptions`
## Accounting Addresses
client.accounting.addresses.retrieve(id, { ...params }) -> Merge.Address
#### 📝 Description
Returns an `Address` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.addresses.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "type", showEnumOrigins: "type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.AddressesRetrieveRequest`
**requestOptions:** `AddressesClient.RequestOptions`
## Accounting AsyncPassthrough
client.accounting.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
#### 📝 Description
Asynchronously pull data from an endpoint not currently supported by Merge.
#### 🔌 Usage
```typescript await client.accounting.asyncPassthrough.create({ method: "GET", path: "/scooters" }); ```
#### ⚙️ Parameters
**request:** `Merge.DataPassthroughRequest`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
client.accounting.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
#### 📝 Description
Retrieves data from earlier async-passthrough POST request
#### 🔌 Usage
```typescript await client.accounting.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
#### ⚙️ Parameters
**async_passthrough_receipt_id:** `string`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
## Accounting AsyncTasks
client.accounting.asyncTasks.retrieve(id) -> Merge.AsyncPostTask
#### 📝 Description
Returns an `AsyncPostTask` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.asyncTasks.retrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `AsyncTasksClient.RequestOptions`
## Accounting Attachments
client.accounting.attachments.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `AccountingAttachment` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.attachments.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.attachments.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.AttachmentsListRequest`
**requestOptions:** `AttachmentsClient.RequestOptions`
client.accounting.attachments.create({ ...params }) -> Merge.AccountingAttachmentResponse
#### 📝 Description
Creates an `AccountingAttachment` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.attachments.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.AccountingAttachmentEndpointRequest`
**requestOptions:** `AttachmentsClient.RequestOptions`
client.accounting.attachments.retrieve(id, { ...params }) -> Merge.AccountingAttachment
#### 📝 Description
Returns an `AccountingAttachment` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.attachments.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.AttachmentsRetrieveRequest`
**requestOptions:** `AttachmentsClient.RequestOptions`
client.accounting.attachments.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `AccountingAttachment` POSTs.
#### 🔌 Usage
```typescript await client.accounting.attachments.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AttachmentsClient.RequestOptions`
## Accounting AuditTrail
client.accounting.auditTrail.list({ ...params }) -> core.Page
#### 📝 Description
Gets a list of audit trail events.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.AuditTrailListRequest`
**requestOptions:** `AuditTrailClient.RequestOptions`
## Accounting AvailableActions
client.accounting.availableActions.retrieve() -> Merge.AvailableActions
#### 📝 Description
Returns a list of models and actions available for an account.
#### 🔌 Usage
```typescript await client.accounting.availableActions.retrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AvailableActionsClient.RequestOptions`
## Accounting BalanceSheets
client.accounting.balanceSheets.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `BalanceSheet` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.balanceSheets.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.balanceSheets.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.BalanceSheetsListRequest`
**requestOptions:** `BalanceSheetsClient.RequestOptions`
client.accounting.balanceSheets.retrieve(id, { ...params }) -> Merge.BalanceSheet
#### 📝 Description
Returns a `BalanceSheet` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.balanceSheets.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.BalanceSheetsRetrieveRequest`
**requestOptions:** `BalanceSheetsClient.RequestOptions`
## Accounting BankFeedAccounts
client.accounting.bankFeedAccounts.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `BankFeedAccount` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.bankFeedAccounts.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.bankFeedAccounts.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.BankFeedAccountsListRequest`
**requestOptions:** `BankFeedAccountsClient.RequestOptions`
client.accounting.bankFeedAccounts.create({ ...params }) -> Merge.BankFeedAccountResponse
#### 📝 Description
Creates a `BankFeedAccount` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.bankFeedAccounts.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.BankFeedAccountEndpointRequest`
**requestOptions:** `BankFeedAccountsClient.RequestOptions`
client.accounting.bankFeedAccounts.retrieve(id, { ...params }) -> Merge.BankFeedAccount
#### 📝 Description
Returns a `BankFeedAccount` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.bankFeedAccounts.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.BankFeedAccountsRetrieveRequest`
**requestOptions:** `BankFeedAccountsClient.RequestOptions`
client.accounting.bankFeedAccounts.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `BankFeedAccount` POSTs.
#### 🔌 Usage
```typescript await client.accounting.bankFeedAccounts.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `BankFeedAccountsClient.RequestOptions`
## Accounting BankFeedTransactions
client.accounting.bankFeedTransactions.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `BankFeedTransaction` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.bankFeedTransactions.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isProcessed: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.bankFeedTransactions.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isProcessed: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.BankFeedTransactionsListRequest`
**requestOptions:** `BankFeedTransactionsClient.RequestOptions`
client.accounting.bankFeedTransactions.create({ ...params }) -> Merge.BankFeedTransactionResponse
#### 📝 Description
Creates a `BankFeedTransaction` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.bankFeedTransactions.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.BankFeedTransactionEndpointRequest`
**requestOptions:** `BankFeedTransactionsClient.RequestOptions`
client.accounting.bankFeedTransactions.retrieve(id, { ...params }) -> Merge.BankFeedTransaction
#### 📝 Description
Returns a `BankFeedTransaction` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.bankFeedTransactions.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.BankFeedTransactionsRetrieveRequest`
**requestOptions:** `BankFeedTransactionsClient.RequestOptions`
client.accounting.bankFeedTransactions.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `BankFeedTransaction` POSTs.
#### 🔌 Usage
```typescript await client.accounting.bankFeedTransactions.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `BankFeedTransactionsClient.RequestOptions`
## Accounting CashFlowStatements
client.accounting.cashFlowStatements.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `CashFlowStatement` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.cashFlowStatements.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.cashFlowStatements.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.CashFlowStatementsListRequest`
**requestOptions:** `CashFlowStatementsClient.RequestOptions`
client.accounting.cashFlowStatements.retrieve(id, { ...params }) -> Merge.CashFlowStatement
#### 📝 Description
Returns a `CashFlowStatement` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.cashFlowStatements.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.CashFlowStatementsRetrieveRequest`
**requestOptions:** `CashFlowStatementsClient.RequestOptions`
## Accounting CompanyInfo
client.accounting.companyInfo.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `CompanyInfo` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.companyInfo.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.companyInfo.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.CompanyInfoListRequest`
**requestOptions:** `CompanyInfoClient.RequestOptions`
client.accounting.companyInfo.retrieve(id, { ...params }) -> Merge.CompanyInfo
#### 📝 Description
Returns a `CompanyInfo` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.companyInfo.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.CompanyInfoRetrieveRequest`
**requestOptions:** `CompanyInfoClient.RequestOptions`
## Accounting Contacts
client.accounting.contacts.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Contact` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.contacts.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddress: "email_address", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCustomer: "is_customer", isSupplier: "is_supplier", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", status: "" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.contacts.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddress: "email_address", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCustomer: "is_customer", isSupplier: "is_supplier", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", status: "" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ContactsListRequest`
**requestOptions:** `ContactsClient.RequestOptions`
client.accounting.contacts.create({ ...params }) -> Merge.ContactResponse
#### 📝 Description
Creates a `Contact` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.contacts.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ContactEndpointRequest`
**requestOptions:** `ContactsClient.RequestOptions`
client.accounting.contacts.retrieve(id, { ...params }) -> Merge.Contact
#### 📝 Description
Returns a `Contact` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.contacts.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.ContactsRetrieveRequest`
**requestOptions:** `ContactsClient.RequestOptions`
client.accounting.contacts.partialUpdate(id, { ...params }) -> Merge.ContactResponse
#### 📝 Description
Updates a `Contact` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.contacts.partialUpdate("id", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PatchedContactEndpointRequest`
**requestOptions:** `ContactsClient.RequestOptions`
client.accounting.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Contact` PATCHs.
#### 🔌 Usage
```typescript await client.accounting.contacts.metaPatchRetrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `ContactsClient.RequestOptions`
client.accounting.contacts.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Contact` POSTs.
#### 🔌 Usage
```typescript await client.accounting.contacts.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ContactsClient.RequestOptions`
client.accounting.contacts.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.contacts.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.contacts.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ContactsRemoteFieldClassesListRequest`
**requestOptions:** `ContactsClient.RequestOptions`
## Accounting CreditNotes
client.accounting.creditNotes.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `CreditNote` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.creditNotes.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.creditNotes.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.CreditNotesListRequest`
**requestOptions:** `CreditNotesClient.RequestOptions`
client.accounting.creditNotes.create({ ...params }) -> Merge.CreditNoteResponse
#### 📝 Description
Creates a `CreditNote` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.creditNotes.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.CreditNoteEndpointRequest`
**requestOptions:** `CreditNotesClient.RequestOptions`
client.accounting.creditNotes.retrieve(id, { ...params }) -> Merge.CreditNote
#### 📝 Description
Returns a `CreditNote` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.creditNotes.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.CreditNotesRetrieveRequest`
**requestOptions:** `CreditNotesClient.RequestOptions`
client.accounting.creditNotes.partialUpdate(id, { ...params }) -> Merge.CreditNoteResponse
#### 📝 Description
Updates a `CreditNote` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.creditNotes.partialUpdate("id", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PatchedCreditNoteEndpointRequest`
**requestOptions:** `CreditNotesClient.RequestOptions`
client.accounting.creditNotes.applicationCreate(id, { ...params }) -> Merge.CreditNoteResponse
#### 📝 Description
Creates a new CreditNoteApplyLine to apply a credit note to an invoice
#### 🔌 Usage
```typescript await client.accounting.creditNotes.applicationCreate("id", { isDebugMode: true, runAsync: true, appliedDate: new Date("2024-01-15T09:30:00.000Z"), appliedAmount: "applied_amount" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.ApplyCreditNoteRequest`
**requestOptions:** `CreditNotesClient.RequestOptions`
client.accounting.creditNotes.metaPatchRetrieve(id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `CreditNote` PATCHs.
#### 🔌 Usage
```typescript await client.accounting.creditNotes.metaPatchRetrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `CreditNotesClient.RequestOptions`
client.accounting.creditNotes.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `CreditNote` POSTs.
#### 🔌 Usage
```typescript await client.accounting.creditNotes.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `CreditNotesClient.RequestOptions`
## Accounting Scopes
client.accounting.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.accounting.scopes.defaultScopesRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ScopesClient.RequestOptions`
client.accounting.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.accounting.scopes.linkedAccountScopesRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ScopesClient.RequestOptions`
client.accounting.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.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 } } }] }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.LinkedAccountCommonModelScopeDeserializerRequest`
**requestOptions:** `ScopesClient.RequestOptions`
## Accounting DeleteAccount
client.accounting.deleteAccount.delete() -> void
#### 📝 Description
Delete a linked account.
#### 🔌 Usage
```typescript await client.accounting.deleteAccount.delete(); ```
#### ⚙️ Parameters
**requestOptions:** `DeleteAccountClient.RequestOptions`
## Accounting Employees
client.accounting.employees.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Employee` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.employees.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.employees.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.EmployeesListRequest`
**requestOptions:** `EmployeesClient.RequestOptions`
client.accounting.employees.retrieve(id, { ...params }) -> Merge.Employee
#### 📝 Description
Returns an `Employee` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.employees.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.EmployeesRetrieveRequest`
**requestOptions:** `EmployeesClient.RequestOptions`
## Accounting ExpenseReports
client.accounting.expenseReports.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `ExpenseReport` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.expenseReports.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.expenseReports.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ExpenseReportsListRequest`
**requestOptions:** `ExpenseReportsClient.RequestOptions`
client.accounting.expenseReports.create({ ...params }) -> Merge.ExpenseReportResponse
#### 📝 Description
Creates an `ExpenseReport` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.expenseReports.create({ isDebugMode: true, runAsync: true, model: { trackingCategories: ["a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d", "d4c3b2a1-9e8f-7g6h-5i4j-3k2l1m0n9o8p"] } }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ExpenseReportEndpointRequest`
**requestOptions:** `ExpenseReportsClient.RequestOptions`
client.accounting.expenseReports.linesList(expense_report_id, { ...params }) -> core.Page
#### 📝 Description
Returns a list of `ExpenseReportLine` objects that point to a `ExpenseReport` with the given id.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.expenseReports.linesList("expense_report_id", { cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.expenseReports.linesList("expense_report_id", { cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**expense_report_id:** `string`
**request:** `Merge.accounting.ExpenseReportsLinesListRequest`
**requestOptions:** `ExpenseReportsClient.RequestOptions`
client.accounting.expenseReports.retrieve(id, { ...params }) -> Merge.ExpenseReport
#### 📝 Description
Returns an `ExpenseReport` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.expenseReports.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.ExpenseReportsRetrieveRequest`
**requestOptions:** `ExpenseReportsClient.RequestOptions`
client.accounting.expenseReports.linesRemoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.expenseReports.linesRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.expenseReports.linesRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ExpenseReportsLinesRemoteFieldClassesListRequest`
**requestOptions:** `ExpenseReportsClient.RequestOptions`
client.accounting.expenseReports.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `ExpenseReport` POSTs.
#### 🔌 Usage
```typescript await client.accounting.expenseReports.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ExpenseReportsClient.RequestOptions`
client.accounting.expenseReports.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.expenseReports.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.expenseReports.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ExpenseReportsRemoteFieldClassesListRequest`
**requestOptions:** `ExpenseReportsClient.RequestOptions`
## Accounting Expenses
client.accounting.expenses.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Expense` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.expenses.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.expenses.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ExpensesListRequest`
**requestOptions:** `ExpensesClient.RequestOptions`
client.accounting.expenses.create({ ...params }) -> Merge.ExpenseResponse
#### 📝 Description
Creates an `Expense` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.expenses.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ExpenseEndpointRequest`
**requestOptions:** `ExpensesClient.RequestOptions`
client.accounting.expenses.retrieve(id, { ...params }) -> Merge.Expense
#### 📝 Description
Returns an `Expense` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.expenses.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.ExpensesRetrieveRequest`
**requestOptions:** `ExpensesClient.RequestOptions`
client.accounting.expenses.bulkCreate({ ...params }) -> Merge.AsyncBulkCreateResponse
#### 📝 Description
Creates multiple `Expense` objects with the given values.
#### 🔌 Usage
```typescript await client.accounting.expenses.bulkCreate({ batchItems: [{ itemId: "item_id", payload: {} }] }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ExpenseBulkRequest`
**requestOptions:** `ExpensesClient.RequestOptions`
client.accounting.expenses.bulkRetrieve(batch_id) -> Merge.BatchObjectsResponse
#### 📝 Description
Returns the status and results of an `Expense` bulk create batch.
#### 🔌 Usage
```typescript await client.accounting.expenses.bulkRetrieve("batch_id"); ```
#### ⚙️ Parameters
**batch_id:** `string`
**requestOptions:** `ExpensesClient.RequestOptions`
client.accounting.expenses.linesRemoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.expenses.linesRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.expenses.linesRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ExpensesLinesRemoteFieldClassesListRequest`
**requestOptions:** `ExpensesClient.RequestOptions`
client.accounting.expenses.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Expense` POSTs.
#### 🔌 Usage
```typescript await client.accounting.expenses.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ExpensesClient.RequestOptions`
client.accounting.expenses.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.expenses.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.expenses.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ExpensesRemoteFieldClassesListRequest`
**requestOptions:** `ExpensesClient.RequestOptions`
## Accounting FieldMapping
client.accounting.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.accounting.fieldMapping.fieldMappingsRetrieve({ excludeRemoteFieldMetadata: true }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.FieldMappingsRetrieveRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.accounting.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.accounting.fieldMapping.fieldMappingsCreate({ excludeRemoteFieldMetadata: true, remoteDataIterationCount: 1, 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.accounting.CreateFieldMappingRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.accounting.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> 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.accounting.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.accounting.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...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.accounting.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", { remoteDataIterationCount: 1 }); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**request:** `Merge.accounting.PatchedEditFieldMappingRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.accounting.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.accounting.fieldMapping.remoteFieldsRetrieve({ commonModels: "common_models", includeExampleValues: "include_example_values" }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.RemoteFieldsRetrieveRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.accounting.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.accounting.fieldMapping.targetFieldsRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `FieldMappingClient.RequestOptions`
## Accounting GeneralLedgerTransactions
client.accounting.generalLedgerTransactions.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `GeneralLedgerTransaction` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.generalLedgerTransactions.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, postedDateAfter: new Date("2024-01-15T09:30:00.000Z"), postedDateBefore: new Date("2024-01-15T09:30:00.000Z"), remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.generalLedgerTransactions.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, postedDateAfter: new Date("2024-01-15T09:30:00.000Z"), postedDateBefore: new Date("2024-01-15T09:30:00.000Z"), remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.GeneralLedgerTransactionsListRequest`
**requestOptions:** `GeneralLedgerTransactionsClient.RequestOptions`
client.accounting.generalLedgerTransactions.retrieve(id, { ...params }) -> Merge.GeneralLedgerTransaction
#### 📝 Description
Returns a `GeneralLedgerTransaction` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.generalLedgerTransactions.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.GeneralLedgerTransactionsRetrieveRequest`
**requestOptions:** `GeneralLedgerTransactionsClient.RequestOptions`
## Accounting GenerateKey
client.accounting.generateKey.create({ ...params }) -> Merge.RemoteKey
#### 📝 Description
Create a remote key.
#### 🔌 Usage
```typescript await client.accounting.generateKey.create({ name: "Remote Deployment Key 1" }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.GenerateRemoteKeyRequest`
**requestOptions:** `GenerateKeyClient.RequestOptions`
## Accounting IncomeStatements
client.accounting.incomeStatements.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `IncomeStatement` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.incomeStatements.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.incomeStatements.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.IncomeStatementsListRequest`
**requestOptions:** `IncomeStatementsClient.RequestOptions`
client.accounting.incomeStatements.retrieve(id, { ...params }) -> Merge.IncomeStatement
#### 📝 Description
Returns an `IncomeStatement` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.incomeStatements.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.IncomeStatementsRetrieveRequest`
**requestOptions:** `IncomeStatementsClient.RequestOptions`
## Accounting Invoices
client.accounting.invoices.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Invoice` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.invoices.list({ companyId: "company_id", contactId: "contact_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, issueDateAfter: new Date("2024-01-15T09:30:00.000Z"), issueDateBefore: new Date("2024-01-15T09:30:00.000Z"), modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), number: "number", pageSize: 1, remoteFields: "type", remoteId: "remote_id", showEnumOrigins: "type", status: "DRAFT", type: "ACCOUNTS_PAYABLE" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.invoices.list({ companyId: "company_id", contactId: "contact_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, issueDateAfter: new Date("2024-01-15T09:30:00.000Z"), issueDateBefore: new Date("2024-01-15T09:30:00.000Z"), modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), number: "number", pageSize: 1, remoteFields: "type", remoteId: "remote_id", showEnumOrigins: "type", status: "DRAFT", type: "ACCOUNTS_PAYABLE" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.InvoicesListRequest`
**requestOptions:** `InvoicesClient.RequestOptions`
client.accounting.invoices.create({ ...params }) -> Merge.InvoiceResponse
#### 📝 Description
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).
#### 🔌 Usage
```typescript await client.accounting.invoices.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.InvoiceEndpointRequest`
**requestOptions:** `InvoicesClient.RequestOptions`
client.accounting.invoices.retrieve(id, { ...params }) -> Merge.Invoice
#### 📝 Description
Returns an `Invoice` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.invoices.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true, remoteFields: "type", showEnumOrigins: "type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.InvoicesRetrieveRequest`
**requestOptions:** `InvoicesClient.RequestOptions`
client.accounting.invoices.partialUpdate(id, { ...params }) -> Merge.InvoiceResponse
#### 📝 Description
Updates an `Invoice` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.invoices.partialUpdate("id", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PatchedInvoiceEndpointRequest`
**requestOptions:** `InvoicesClient.RequestOptions`
client.accounting.invoices.bulkCreate({ ...params }) -> Merge.AsyncBulkCreateResponse
#### 📝 Description
Creates multiple `Invoice` objects with the given values.
#### 🔌 Usage
```typescript await client.accounting.invoices.bulkCreate({ batchItems: [{ itemId: "item_id", payload: {} }] }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.InvoiceBulkRequest`
**requestOptions:** `InvoicesClient.RequestOptions`
client.accounting.invoices.bulkRetrieve(batch_id) -> Merge.BatchObjectsResponse
#### 📝 Description
Returns the status and results of an `Invoice` bulk create batch.
#### 🔌 Usage
```typescript await client.accounting.invoices.bulkRetrieve("batch_id"); ```
#### ⚙️ Parameters
**batch_id:** `string`
**requestOptions:** `InvoicesClient.RequestOptions`
client.accounting.invoices.lineItemsRemoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.invoices.lineItemsRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.invoices.lineItemsRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.InvoicesLineItemsRemoteFieldClassesListRequest`
**requestOptions:** `InvoicesClient.RequestOptions`
client.accounting.invoices.metaPatchRetrieve(id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Invoice` PATCHs.
#### 🔌 Usage
```typescript await client.accounting.invoices.metaPatchRetrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `InvoicesClient.RequestOptions`
client.accounting.invoices.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Invoice` POSTs.
#### 🔌 Usage
```typescript await client.accounting.invoices.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `InvoicesClient.RequestOptions`
client.accounting.invoices.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.invoices.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.invoices.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.InvoicesRemoteFieldClassesListRequest`
**requestOptions:** `InvoicesClient.RequestOptions`
## Accounting Issues
client.accounting.issues.list({ ...params }) -> core.Page
#### 📝 Description
Gets all issues for Organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.IssuesListRequest`
**requestOptions:** `IssuesClient.RequestOptions`
client.accounting.issues.retrieve(id) -> Merge.Issue
#### 📝 Description
Get a specific issue.
#### 🔌 Usage
```typescript await client.accounting.issues.retrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `IssuesClient.RequestOptions`
## Accounting ItemFulfillments
client.accounting.itemFulfillments.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `ItemFulfillment` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.itemFulfillments.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, pageSize: 1, remoteFields: "status", showEnumOrigins: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.itemFulfillments.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, pageSize: 1, remoteFields: "status", showEnumOrigins: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ItemFulfillmentsListRequest`
**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
client.accounting.itemFulfillments.create({ ...params }) -> Merge.ItemFulfillmentResponse
#### 📝 Description
Creates an `ItemFulfillment` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.itemFulfillments.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ItemFulfillmentEndpointRequest`
**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
client.accounting.itemFulfillments.retrieve(id, { ...params }) -> Merge.ItemFulfillment
#### 📝 Description
Returns an `ItemFulfillment` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.itemFulfillments.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.ItemFulfillmentsRetrieveRequest`
**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
client.accounting.itemFulfillments.bulkCreate({ ...params }) -> Merge.AsyncBulkCreateResponse
#### 📝 Description
Creates multiple `ItemFulfillment` objects with the given values.
#### 🔌 Usage
```typescript await client.accounting.itemFulfillments.bulkCreate({ batchItems: [{ itemId: "item_id", payload: {} }] }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ItemFulfillmentBulkRequest`
**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
client.accounting.itemFulfillments.bulkRetrieve(batch_id) -> Merge.BatchObjectsResponse
#### 📝 Description
Returns the status and results of an `ItemFulfillment` bulk create batch.
#### 🔌 Usage
```typescript await client.accounting.itemFulfillments.bulkRetrieve("batch_id"); ```
#### ⚙️ Parameters
**batch_id:** `string`
**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
client.accounting.itemFulfillments.linesRemoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.itemFulfillments.linesRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.itemFulfillments.linesRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ItemFulfillmentsLinesRemoteFieldClassesListRequest`
**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
client.accounting.itemFulfillments.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `ItemFulfillment` POSTs.
#### 🔌 Usage
```typescript await client.accounting.itemFulfillments.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
client.accounting.itemFulfillments.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.itemFulfillments.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.itemFulfillments.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ItemFulfillmentsRemoteFieldClassesListRequest`
**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
## Accounting Items
client.accounting.items.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Item` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.items.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.items.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ItemsListRequest`
**requestOptions:** `ItemsClient.RequestOptions`
client.accounting.items.create({ ...params }) -> Merge.ItemResponse
#### 📝 Description
Creates an `Item` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.items.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ItemEndpointRequest`
**requestOptions:** `ItemsClient.RequestOptions`
client.accounting.items.retrieve(id, { ...params }) -> Merge.Item
#### 📝 Description
Returns an `Item` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.items.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.ItemsRetrieveRequest`
**requestOptions:** `ItemsClient.RequestOptions`
client.accounting.items.partialUpdate(id, { ...params }) -> Merge.ItemResponse
#### 📝 Description
Updates an `Item` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.items.partialUpdate("id", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PatchedItemEndpointRequest`
**requestOptions:** `ItemsClient.RequestOptions`
client.accounting.items.metaPatchRetrieve(id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Item` PATCHs.
#### 🔌 Usage
```typescript await client.accounting.items.metaPatchRetrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `ItemsClient.RequestOptions`
client.accounting.items.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Item` POSTs.
#### 🔌 Usage
```typescript await client.accounting.items.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ItemsClient.RequestOptions`
## Accounting JournalEntries
client.accounting.journalEntries.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `JournalEntry` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.journalEntries.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.journalEntries.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.JournalEntriesListRequest`
**requestOptions:** `JournalEntriesClient.RequestOptions`
client.accounting.journalEntries.create({ ...params }) -> Merge.JournalEntryResponse
#### 📝 Description
Creates a `JournalEntry` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.journalEntries.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.JournalEntryEndpointRequest`
**requestOptions:** `JournalEntriesClient.RequestOptions`
client.accounting.journalEntries.retrieve(id, { ...params }) -> Merge.JournalEntry
#### 📝 Description
Returns a `JournalEntry` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.journalEntries.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.JournalEntriesRetrieveRequest`
**requestOptions:** `JournalEntriesClient.RequestOptions`
client.accounting.journalEntries.linesRemoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.journalEntries.linesRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.journalEntries.linesRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.JournalEntriesLinesRemoteFieldClassesListRequest`
**requestOptions:** `JournalEntriesClient.RequestOptions`
client.accounting.journalEntries.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `JournalEntry` POSTs.
#### 🔌 Usage
```typescript await client.accounting.journalEntries.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `JournalEntriesClient.RequestOptions`
client.accounting.journalEntries.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.journalEntries.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.journalEntries.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.JournalEntriesRemoteFieldClassesListRequest`
**requestOptions:** `JournalEntriesClient.RequestOptions`
## Accounting LinkToken
client.accounting.linkToken.create({ ...params }) -> Merge.LinkToken
#### 📝 Description
Creates a link token to be used when linking a new end user. The link token expires after single use.
#### 🔌 Usage
```typescript await client.accounting.linkToken.create({ endUserEmailAddress: "example@gmail.com", endUserOrganizationName: "Test Organization", endUserOriginId: "12345", categories: ["hris", "ats"] }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.EndUserDetailsRequest`
**requestOptions:** `LinkTokenClient.RequestOptions`
## Accounting LinkedAccounts
client.accounting.linkedAccounts.list({ ...params }) -> core.Page
#### 📝 Description
List linked accounts for your organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.LinkedAccountsListRequest`
**requestOptions:** `LinkedAccountsClient.RequestOptions`
## Accounting Passthrough
client.accounting.passthrough.create({ ...params }) -> Merge.RemoteResponse
#### 📝 Description
Pull data from an endpoint not currently supported by Merge.
#### 🔌 Usage
```typescript await client.accounting.passthrough.create({ method: "GET", path: "/scooters" }); ```
#### ⚙️ Parameters
**request:** `Merge.DataPassthroughRequest`
**requestOptions:** `PassthroughClient.RequestOptions`
## Accounting PaymentMethods
client.accounting.paymentMethods.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `PaymentMethod` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.paymentMethods.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.paymentMethods.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.PaymentMethodsListRequest`
**requestOptions:** `PaymentMethodsClient.RequestOptions`
client.accounting.paymentMethods.retrieve(id, { ...params }) -> Merge.PaymentMethod
#### 📝 Description
Returns a `PaymentMethod` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.paymentMethods.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PaymentMethodsRetrieveRequest`
**requestOptions:** `PaymentMethodsClient.RequestOptions`
## Accounting PaymentTerms
client.accounting.paymentTerms.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `PaymentTerm` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.paymentTerms.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.paymentTerms.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.PaymentTermsListRequest`
**requestOptions:** `PaymentTermsClient.RequestOptions`
client.accounting.paymentTerms.retrieve(id, { ...params }) -> Merge.PaymentTerm
#### 📝 Description
Returns a `PaymentTerm` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.paymentTerms.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PaymentTermsRetrieveRequest`
**requestOptions:** `PaymentTermsClient.RequestOptions`
## Accounting Payments
client.accounting.payments.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Payment` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.payments.list({ accountId: "account_id", companyId: "company_id", contactId: "contact_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.payments.list({ accountId: "account_id", companyId: "company_id", contactId: "contact_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.PaymentsListRequest`
**requestOptions:** `PaymentsClient.RequestOptions`
client.accounting.payments.create({ ...params }) -> Merge.PaymentResponse
#### 📝 Description
Creates a `Payment` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.payments.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.PaymentEndpointRequest`
**requestOptions:** `PaymentsClient.RequestOptions`
client.accounting.payments.retrieve(id, { ...params }) -> Merge.Payment
#### 📝 Description
Returns a `Payment` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.payments.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PaymentsRetrieveRequest`
**requestOptions:** `PaymentsClient.RequestOptions`
client.accounting.payments.partialUpdate(id, { ...params }) -> Merge.PaymentResponse
#### 📝 Description
Updates a `Payment` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.payments.partialUpdate("id", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PatchedPaymentEndpointRequest`
**requestOptions:** `PaymentsClient.RequestOptions`
client.accounting.payments.lineItemsRemoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.payments.lineItemsRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.payments.lineItemsRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.PaymentsLineItemsRemoteFieldClassesListRequest`
**requestOptions:** `PaymentsClient.RequestOptions`
client.accounting.payments.metaPatchRetrieve(id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Payment` PATCHs.
#### 🔌 Usage
```typescript await client.accounting.payments.metaPatchRetrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `PaymentsClient.RequestOptions`
client.accounting.payments.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Payment` POSTs.
#### 🔌 Usage
```typescript await client.accounting.payments.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `PaymentsClient.RequestOptions`
client.accounting.payments.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.payments.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.payments.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.PaymentsRemoteFieldClassesListRequest`
**requestOptions:** `PaymentsClient.RequestOptions`
## Accounting PhoneNumbers
client.accounting.phoneNumbers.retrieve(id, { ...params }) -> Merge.AccountingPhoneNumber
#### 📝 Description
Returns an `AccountingPhoneNumber` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.phoneNumbers.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PhoneNumbersRetrieveRequest`
**requestOptions:** `PhoneNumbersClient.RequestOptions`
## Accounting Projects
client.accounting.projects.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Project` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.projects.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isActive: "is_active", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.projects.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isActive: "is_active", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.ProjectsListRequest`
**requestOptions:** `ProjectsClient.RequestOptions`
client.accounting.projects.retrieve(id, { ...params }) -> Merge.Project
#### 📝 Description
Returns a `Project` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.projects.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.ProjectsRetrieveRequest`
**requestOptions:** `ProjectsClient.RequestOptions`
## Accounting PurchaseOrders
client.accounting.purchaseOrders.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `PurchaseOrder` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.purchaseOrders.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, issueDateAfter: new Date("2024-01-15T09:30:00.000Z"), issueDateBefore: new Date("2024-01-15T09:30:00.000Z"), modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.purchaseOrders.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, issueDateAfter: new Date("2024-01-15T09:30:00.000Z"), issueDateBefore: new Date("2024-01-15T09:30:00.000Z"), modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.PurchaseOrdersListRequest`
**requestOptions:** `PurchaseOrdersClient.RequestOptions`
client.accounting.purchaseOrders.create({ ...params }) -> Merge.PurchaseOrderResponse
#### 📝 Description
Creates a `PurchaseOrder` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.purchaseOrders.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.PurchaseOrderEndpointRequest`
**requestOptions:** `PurchaseOrdersClient.RequestOptions`
client.accounting.purchaseOrders.retrieve(id, { ...params }) -> Merge.PurchaseOrder
#### 📝 Description
Returns a `PurchaseOrder` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.purchaseOrders.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PurchaseOrdersRetrieveRequest`
**requestOptions:** `PurchaseOrdersClient.RequestOptions`
client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.PurchaseOrdersLineItemsRemoteFieldClassesListRequest`
**requestOptions:** `PurchaseOrdersClient.RequestOptions`
client.accounting.purchaseOrders.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `PurchaseOrder` POSTs.
#### 🔌 Usage
```typescript await client.accounting.purchaseOrders.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `PurchaseOrdersClient.RequestOptions`
client.accounting.purchaseOrders.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.purchaseOrders.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.purchaseOrders.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.PurchaseOrdersRemoteFieldClassesListRequest`
**requestOptions:** `PurchaseOrdersClient.RequestOptions`
## Accounting RegenerateKey
client.accounting.regenerateKey.create({ ...params }) -> Merge.RemoteKey
#### 📝 Description
Exchange remote keys.
#### 🔌 Usage
```typescript await client.accounting.regenerateKey.create({ name: "Remote Deployment Key 1" }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.RemoteKeyForRegenerationRequest`
**requestOptions:** `RegenerateKeyClient.RequestOptions`
## Accounting SalesOrders
client.accounting.salesOrders.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `SalesOrder` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.salesOrders.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, issueDateAfter: new Date("2024-01-15T09:30:00.000Z"), issueDateBefore: new Date("2024-01-15T09:30:00.000Z"), modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.salesOrders.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, issueDateAfter: new Date("2024-01-15T09:30:00.000Z"), issueDateBefore: new Date("2024-01-15T09:30:00.000Z"), modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.SalesOrdersListRequest`
**requestOptions:** `SalesOrdersClient.RequestOptions`
client.accounting.salesOrders.create({ ...params }) -> Merge.SalesOrderResponse
#### 📝 Description
Creates a `SalesOrder` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.salesOrders.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.SalesOrderEndpointRequest`
**requestOptions:** `SalesOrdersClient.RequestOptions`
client.accounting.salesOrders.retrieve(id, { ...params }) -> Merge.SalesOrder
#### 📝 Description
Returns a `SalesOrder` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.salesOrders.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.SalesOrdersRetrieveRequest`
**requestOptions:** `SalesOrdersClient.RequestOptions`
client.accounting.salesOrders.bulkCreate({ ...params }) -> Merge.AsyncBulkCreateResponse
#### 📝 Description
Creates multiple `SalesOrder` objects with the given values.
#### 🔌 Usage
```typescript await client.accounting.salesOrders.bulkCreate({ batchItems: [{ itemId: "item_id", payload: {} }] }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.SalesOrderBulkRequest`
**requestOptions:** `SalesOrdersClient.RequestOptions`
client.accounting.salesOrders.bulkRetrieve(batch_id) -> Merge.BatchObjectsResponse
#### 📝 Description
Returns the status and results of a `SalesOrder` bulk create batch.
#### 🔌 Usage
```typescript await client.accounting.salesOrders.bulkRetrieve("batch_id"); ```
#### ⚙️ Parameters
**batch_id:** `string`
**requestOptions:** `SalesOrdersClient.RequestOptions`
client.accounting.salesOrders.linesRemoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.salesOrders.linesRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.salesOrders.linesRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.SalesOrdersLinesRemoteFieldClassesListRequest`
**requestOptions:** `SalesOrdersClient.RequestOptions`
client.accounting.salesOrders.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `SalesOrder` POSTs.
#### 🔌 Usage
```typescript await client.accounting.salesOrders.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `SalesOrdersClient.RequestOptions`
client.accounting.salesOrders.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.salesOrders.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.salesOrders.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.SalesOrdersRemoteFieldClassesListRequest`
**requestOptions:** `SalesOrdersClient.RequestOptions`
## Accounting SyncStatus
client.accounting.syncStatus.list({ ...params }) -> core.Page
#### 📝 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 const pageableResponse = await client.accounting.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.SyncStatusListRequest`
**requestOptions:** `SyncStatusClient.RequestOptions`
## Accounting ForceResync
client.accounting.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.accounting.forceResync.syncStatusResyncCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `ForceResyncClient.RequestOptions`
## Accounting TaxRates
client.accounting.taxRates.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `TaxRate` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.taxRates.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.taxRates.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.TaxRatesListRequest`
**requestOptions:** `TaxRatesClient.RequestOptions`
client.accounting.taxRates.retrieve(id, { ...params }) -> Merge.TaxRate
#### 📝 Description
Returns a `TaxRate` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.taxRates.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.TaxRatesRetrieveRequest`
**requestOptions:** `TaxRatesClient.RequestOptions`
## Accounting TrackingCategories
client.accounting.trackingCategories.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `TrackingCategory` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.trackingCategories.list({ categoryType: "", companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", status: "" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.trackingCategories.list({ categoryType: "", companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", status: "" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.TrackingCategoriesListRequest`
**requestOptions:** `TrackingCategoriesClient.RequestOptions`
client.accounting.trackingCategories.retrieve(id, { ...params }) -> Merge.TrackingCategory
#### 📝 Description
Returns a `TrackingCategory` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.trackingCategories.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.TrackingCategoriesRetrieveRequest`
**requestOptions:** `TrackingCategoriesClient.RequestOptions`
## Accounting Transactions
client.accounting.transactions.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Transaction` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.transactions.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.transactions.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.TransactionsListRequest`
**requestOptions:** `TransactionsClient.RequestOptions`
client.accounting.transactions.retrieve(id, { ...params }) -> Merge.Transaction
#### 📝 Description
Returns a `Transaction` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.transactions.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.TransactionsRetrieveRequest`
**requestOptions:** `TransactionsClient.RequestOptions`
## Accounting VendorCredits
client.accounting.vendorCredits.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `VendorCredit` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.accounting.vendorCredits.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounting.vendorCredits.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"), transactionDateBefore: new Date("2024-01-15T09:30:00.000Z") }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.accounting.VendorCreditsListRequest`
**requestOptions:** `VendorCreditsClient.RequestOptions`
client.accounting.vendorCredits.create({ ...params }) -> Merge.VendorCreditResponse
#### 📝 Description
Creates a `VendorCredit` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.vendorCredits.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.VendorCreditEndpointRequest`
**requestOptions:** `VendorCreditsClient.RequestOptions`
client.accounting.vendorCredits.retrieve(id, { ...params }) -> Merge.VendorCredit
#### 📝 Description
Returns a `VendorCredit` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.vendorCredits.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.VendorCreditsRetrieveRequest`
**requestOptions:** `VendorCreditsClient.RequestOptions`
client.accounting.vendorCredits.partialUpdate(id, { ...params }) -> Merge.VendorCreditResponse
#### 📝 Description
Updates a `VendorCredit` object with the given `id`.
#### 🔌 Usage
```typescript await client.accounting.vendorCredits.partialUpdate("id", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.PatchedVendorCreditEndpointRequest`
**requestOptions:** `VendorCreditsClient.RequestOptions`
client.accounting.vendorCredits.applicationCreate(id, { ...params }) -> Merge.VendorCreditResponse
#### 📝 Description
Creates a new VendorCreditApplyLine to apply a vendor credit to an invoice
#### 🔌 Usage
```typescript await client.accounting.vendorCredits.applicationCreate("id", { isDebugMode: true, runAsync: true, appliedDate: new Date("2024-01-15T09:30:00.000Z"), appliedAmount: "applied_amount" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.accounting.ApplyVendorCreditRequest`
**requestOptions:** `VendorCreditsClient.RequestOptions`
client.accounting.vendorCredits.metaPatchRetrieve(id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `VendorCredit` PATCHs.
#### 🔌 Usage
```typescript await client.accounting.vendorCredits.metaPatchRetrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `VendorCreditsClient.RequestOptions`
client.accounting.vendorCredits.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `VendorCredit` POSTs.
#### 🔌 Usage
```typescript await client.accounting.vendorCredits.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `VendorCreditsClient.RequestOptions`
## Accounting WebhookReceivers
client.accounting.webhookReceivers.list() -> Merge.WebhookReceiver[]
#### 📝 Description
Returns a list of `WebhookReceiver` objects.
#### 🔌 Usage
```typescript await client.accounting.webhookReceivers.list(); ```
#### ⚙️ Parameters
**requestOptions:** `WebhookReceiversClient.RequestOptions`
client.accounting.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
#### 📝 Description
Creates a `WebhookReceiver` object with the given values.
#### 🔌 Usage
```typescript await client.accounting.webhookReceivers.create({ event: "event", isActive: true }); ```
#### ⚙️ Parameters
**request:** `Merge.accounting.WebhookReceiverRequest`
**requestOptions:** `WebhookReceiversClient.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:** `AccountDetailsClient.RequestOptions`
## Crm AccountToken
client.crm.accountToken.retrieve(public_token) -> 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
**public_token:** `string`
**requestOptions:** `AccountTokenClient.RequestOptions`
client.crm.accountToken.regenerateCreate() -> Merge.RegenerateAccountToken
#### 📝 Description
Exchange Linked Account account tokens.
#### 🔌 Usage
```typescript await client.crm.accountToken.regenerateCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountTokenClient.RequestOptions`
## Crm Accounts
client.crm.accounts.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Account` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.accounts.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", ownerId: "owner_id", pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.accounts.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", ownerId: "owner_id", pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.AccountsListRequest`
**requestOptions:** `AccountsClient.RequestOptions`
client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse
#### 📝 Description
Creates an `Account` object with the given values.
#### 🔌 Usage
```typescript await client.crm.accounts.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.CrmAccountEndpointRequest`
**requestOptions:** `AccountsClient.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", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.AccountsRetrieveRequest`
**requestOptions:** `AccountsClient.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", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.PatchedCrmAccountEndpointRequest`
**requestOptions:** `AccountsClient.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:** `AccountsClient.RequestOptions`
client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `CRMAccount` POSTs.
#### 🔌 Usage
```typescript await client.crm.accounts.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountsClient.RequestOptions`
client.crm.accounts.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.accounts.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.accounts.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest`
**requestOptions:** `AccountsClient.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:** `AsyncPassthroughClient.RequestOptions`
client.crm.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
#### 📝 Description
Retrieves data from earlier async-passthrough POST request
#### 🔌 Usage
```typescript await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
#### ⚙️ Parameters
**async_passthrough_receipt_id:** `string`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
## Crm AuditTrail
client.crm.auditTrail.list({ ...params }) -> core.Page
#### 📝 Description
Gets a list of audit trail events.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.AuditTrailListRequest`
**requestOptions:** `AuditTrailClient.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:** `AvailableActionsClient.RequestOptions`
## Crm Contacts
client.crm.contacts.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Contact` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.contacts.list({ accountId: "account_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddresses: "email_addresses", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, phoneNumbers: "phone_numbers", remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.contacts.list({ accountId: "account_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddresses: "email_addresses", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, phoneNumbers: "phone_numbers", remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.ContactsListRequest`
**requestOptions:** `ContactsClient.RequestOptions`
client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse
#### 📝 Description
Creates a `Contact` object with the given values.
#### 🔌 Usage
```typescript await client.crm.contacts.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.CrmContactEndpointRequest`
**requestOptions:** `ContactsClient.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", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.ContactsRetrieveRequest`
**requestOptions:** `ContactsClient.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", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.PatchedCrmContactEndpointRequest`
**requestOptions:** `ContactsClient.RequestOptions`
client.crm.contacts.ignoreCreate(model_id, { ...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
**model_id:** `string`
**request:** `Merge.IgnoreCommonModelRequest`
**requestOptions:** `ContactsClient.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:** `ContactsClient.RequestOptions`
client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `CRMContact` POSTs.
#### 🔌 Usage
```typescript await client.crm.contacts.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ContactsClient.RequestOptions`
client.crm.contacts.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.contacts.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.contacts.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest`
**requestOptions:** `ContactsClient.RequestOptions`
## Crm CustomObjectClasses
client.crm.customObjectClasses.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `CustomObjectClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.customObjectClasses.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.customObjectClasses.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.CustomObjectClassesListRequest`
**requestOptions:** `CustomObjectClassesClient.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", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.CustomObjectClassesRetrieveRequest`
**requestOptions:** `CustomObjectClassesClient.RequestOptions`
## Crm AssociationTypes
client.crm.associationTypes.customObjectClassesAssociationTypesList(custom_object_class_id, { ...params }) -> core.Page
#### 📝 Description
Returns a list of `AssociationType` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id", { createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id", { createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**custom_object_class_id:** `string`
**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest`
**requestOptions:** `AssociationTypesClient.RequestOptions`
client.crm.associationTypes.customObjectClassesAssociationTypesCreate(custom_object_class_id, { ...params }) -> Merge.CrmAssociationTypeResponse
#### 📝 Description
Creates an `AssociationType` object with the given values.
#### 🔌 Usage
```typescript await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("custom_object_class_id", { isDebugMode: true, runAsync: true, model: { sourceObjectClass: { id: "id", originType: "CUSTOM_OBJECT" }, targetObjectClasses: [{ id: "id", originType: "CUSTOM_OBJECT" }], remoteKeyName: "remote_key_name" } }); ```
#### ⚙️ Parameters
**custom_object_class_id:** `string`
**request:** `Merge.crm.CrmAssociationTypeEndpointRequest`
**requestOptions:** `AssociationTypesClient.RequestOptions`
client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(custom_object_class_id, 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", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**custom_object_class_id:** `string`
**id:** `string`
**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest`
**requestOptions:** `AssociationTypesClient.RequestOptions`
client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(custom_object_class_id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `CRMAssociationType` POSTs.
#### 🔌 Usage
```typescript await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id"); ```
#### ⚙️ Parameters
**custom_object_class_id:** `string`
**requestOptions:** `AssociationTypesClient.RequestOptions`
## Crm CustomObjects
client.crm.customObjects.customObjectClassesCustomObjectsList(custom_object_class_id, { ...params }) -> core.Page
#### 📝 Description
Returns a list of `CustomObject` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id", { createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id", { createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**custom_object_class_id:** `string`
**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest`
**requestOptions:** `CustomObjectsClient.RequestOptions`
client.crm.customObjects.customObjectClassesCustomObjectsCreate(custom_object_class_id, { ...params }) -> Merge.CrmCustomObjectResponse
#### 📝 Description
Creates a `CustomObject` object with the given values.
#### 🔌 Usage
```typescript await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", { isDebugMode: true, runAsync: true, model: { fields: { "test_field": "hello" } } }); ```
#### ⚙️ Parameters
**custom_object_class_id:** `string`
**request:** `Merge.crm.CrmCustomObjectEndpointRequest`
**requestOptions:** `CustomObjectsClient.RequestOptions`
client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(custom_object_class_id, 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", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**custom_object_class_id:** `string`
**id:** `string`
**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest`
**requestOptions:** `CustomObjectsClient.RequestOptions`
client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(custom_object_class_id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `CRMCustomObject` POSTs.
#### 🔌 Usage
```typescript await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id"); ```
#### ⚙️ Parameters
**custom_object_class_id:** `string`
**requestOptions:** `CustomObjectsClient.RequestOptions`
client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest`
**requestOptions:** `CustomObjectsClient.RequestOptions`
## Crm Associations
client.crm.associations.customObjectClassesCustomObjectsAssociationsList(custom_object_class_id, object_id, { ...params }) -> core.Page
#### 📝 Description
Returns a list of `Association` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id", { associationTypeId: "association_type_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id", { associationTypeId: "association_type_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**custom_object_class_id:** `string`
**object_id:** `string`
**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest`
**requestOptions:** `AssociationsClient.RequestOptions`
client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(source_class_id, source_object_id, target_class_id, target_object_id, association_type_id, { ...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("source_class_id", "source_object_id", "target_class_id", "target_object_id", "association_type_id", { isDebugMode: true, runAsync: true }); ```
#### ⚙️ Parameters
**source_class_id:** `string`
**source_object_id:** `string`
**target_class_id:** `string`
**target_object_id:** `string`
**association_type_id:** `string`
**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest`
**requestOptions:** `AssociationsClient.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
**requestOptions:** `ScopesClient.RequestOptions`
client.crm.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.crm.scopes.linkedAccountScopesRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ScopesClient.RequestOptions`
client.crm.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.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 } } }] }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest`
**requestOptions:** `ScopesClient.RequestOptions`
## Crm DeleteAccount
client.crm.deleteAccount.delete() -> void
#### 📝 Description
Delete a linked account.
#### 🔌 Usage
```typescript await client.crm.deleteAccount.delete(); ```
#### ⚙️ Parameters
**requestOptions:** `DeleteAccountClient.RequestOptions`
## Crm EngagementTypes
client.crm.engagementTypes.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `EngagementType` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.engagementTypes.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.engagementTypes.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.EngagementTypesListRequest`
**requestOptions:** `EngagementTypesClient.RequestOptions`
client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType
#### 📝 Description
Returns an `EngagementType` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.engagementTypes.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.EngagementTypesRetrieveRequest`
**requestOptions:** `EngagementTypesClient.RequestOptions`
client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.engagementTypes.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.engagementTypes.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest`
**requestOptions:** `EngagementTypesClient.RequestOptions`
## Crm Engagements
client.crm.engagements.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Engagement` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.engagements.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z") }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.engagements.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z") }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.EngagementsListRequest`
**requestOptions:** `EngagementsClient.RequestOptions`
client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse
#### 📝 Description
Creates an `Engagement` object with the given values.
#### 🔌 Usage
```typescript await client.crm.engagements.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.EngagementEndpointRequest`
**requestOptions:** `EngagementsClient.RequestOptions`
client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement
#### 📝 Description
Returns an `Engagement` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.engagements.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.EngagementsRetrieveRequest`
**requestOptions:** `EngagementsClient.RequestOptions`
client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse
#### 📝 Description
Updates an `Engagement` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.engagements.partialUpdate("id", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.PatchedEngagementEndpointRequest`
**requestOptions:** `EngagementsClient.RequestOptions`
client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Engagement` PATCHs.
#### 🔌 Usage
```typescript await client.crm.engagements.metaPatchRetrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `EngagementsClient.RequestOptions`
client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Engagement` POSTs.
#### 🔌 Usage
```typescript await client.crm.engagements.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `EngagementsClient.RequestOptions`
client.crm.engagements.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.engagements.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.engagements.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest`
**requestOptions:** `EngagementsClient.RequestOptions`
## Crm FieldMapping
client.crm.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.crm.fieldMapping.fieldMappingsRetrieve({ excludeRemoteFieldMetadata: true }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.FieldMappingsRetrieveRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.crm.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.crm.fieldMapping.fieldMappingsCreate({ excludeRemoteFieldMetadata: true, remoteDataIterationCount: 1, 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.crm.CreateFieldMappingRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.crm.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> 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.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.crm.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...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.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", { remoteDataIterationCount: 1 }); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**request:** `Merge.crm.PatchedEditFieldMappingRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.crm.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.crm.fieldMapping.remoteFieldsRetrieve({ commonModels: "common_models", includeExampleValues: "include_example_values" }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.RemoteFieldsRetrieveRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.crm.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.crm.fieldMapping.targetFieldsRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `FieldMappingClient.RequestOptions`
## Crm GenerateKey
client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey
#### 📝 Description
Create a remote key.
#### 🔌 Usage
```typescript await client.crm.generateKey.create({ name: "Remote Deployment Key 1" }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.GenerateRemoteKeyRequest`
**requestOptions:** `GenerateKeyClient.RequestOptions`
## Crm Issues
client.crm.issues.list({ ...params }) -> core.Page
#### 📝 Description
Gets all issues for Organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.IssuesListRequest`
**requestOptions:** `IssuesClient.RequestOptions`
client.crm.issues.retrieve(id) -> Merge.Issue
#### 📝 Description
Get a specific issue.
#### 🔌 Usage
```typescript await client.crm.issues.retrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `IssuesClient.RequestOptions`
## Crm Leads
client.crm.leads.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Lead` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.leads.list({ convertedAccountId: "converted_account_id", convertedContactId: "converted_contact_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddresses: "email_addresses", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), ownerId: "owner_id", pageSize: 1, phoneNumbers: "phone_numbers", remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.leads.list({ convertedAccountId: "converted_account_id", convertedContactId: "converted_contact_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddresses: "email_addresses", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), ownerId: "owner_id", pageSize: 1, phoneNumbers: "phone_numbers", remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.LeadsListRequest`
**requestOptions:** `LeadsClient.RequestOptions`
client.crm.leads.create({ ...params }) -> Merge.LeadResponse
#### 📝 Description
Creates a `Lead` object with the given values.
#### 🔌 Usage
```typescript await client.crm.leads.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.LeadEndpointRequest`
**requestOptions:** `LeadsClient.RequestOptions`
client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead
#### 📝 Description
Returns a `Lead` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.leads.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.LeadsRetrieveRequest`
**requestOptions:** `LeadsClient.RequestOptions`
client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Lead` POSTs.
#### 🔌 Usage
```typescript await client.crm.leads.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `LeadsClient.RequestOptions`
client.crm.leads.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.leads.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.leads.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest`
**requestOptions:** `LeadsClient.RequestOptions`
## Crm LinkToken
client.crm.linkToken.create({ ...params }) -> Merge.LinkToken
#### 📝 Description
Creates a link token to be used when linking a new end user. The link token expires after single use.
#### 🔌 Usage
```typescript await client.crm.linkToken.create({ endUserEmailAddress: "example@gmail.com", endUserOrganizationName: "Test Organization", endUserOriginId: "12345", categories: ["hris", "ats"] }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.EndUserDetailsRequest`
**requestOptions:** `LinkTokenClient.RequestOptions`
## Crm LinkedAccounts
client.crm.linkedAccounts.list({ ...params }) -> core.Page
#### 📝 Description
List linked accounts for your organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.LinkedAccountsListRequest`
**requestOptions:** `LinkedAccountsClient.RequestOptions`
## Crm Notes
client.crm.notes.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Note` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.notes.list({ accountId: "account_id", contactId: "contact_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), opportunityId: "opportunity_id", ownerId: "owner_id", pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.notes.list({ accountId: "account_id", contactId: "contact_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), opportunityId: "opportunity_id", ownerId: "owner_id", pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.NotesListRequest`
**requestOptions:** `NotesClient.RequestOptions`
client.crm.notes.create({ ...params }) -> Merge.NoteResponse
#### 📝 Description
Creates a `Note` object with the given values.
#### 🔌 Usage
```typescript await client.crm.notes.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.NoteEndpointRequest`
**requestOptions:** `NotesClient.RequestOptions`
client.crm.notes.retrieve(id, { ...params }) -> Merge.Note
#### 📝 Description
Returns a `Note` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.notes.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.NotesRetrieveRequest`
**requestOptions:** `NotesClient.RequestOptions`
client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Note` POSTs.
#### 🔌 Usage
```typescript await client.crm.notes.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `NotesClient.RequestOptions`
client.crm.notes.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.notes.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.notes.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.NotesRemoteFieldClassesListRequest`
**requestOptions:** `NotesClient.RequestOptions`
## Crm Opportunities
client.crm.opportunities.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Opportunity` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.opportunities.list({ accountId: "account_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), ownerId: "owner_id", pageSize: 1, remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", stageId: "stage_id", status: "LOST" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.opportunities.list({ accountId: "account_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), ownerId: "owner_id", pageSize: 1, remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteFields: "status", remoteId: "remote_id", showEnumOrigins: "status", stageId: "stage_id", status: "LOST" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.OpportunitiesListRequest`
**requestOptions:** `OpportunitiesClient.RequestOptions`
client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse
#### 📝 Description
Creates an `Opportunity` object with the given values.
#### 🔌 Usage
```typescript await client.crm.opportunities.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.OpportunityEndpointRequest`
**requestOptions:** `OpportunitiesClient.RequestOptions`
client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity
#### 📝 Description
Returns an `Opportunity` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.opportunities.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true, remoteFields: "status", showEnumOrigins: "status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.OpportunitiesRetrieveRequest`
**requestOptions:** `OpportunitiesClient.RequestOptions`
client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse
#### 📝 Description
Updates an `Opportunity` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.opportunities.partialUpdate("id", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.PatchedOpportunityEndpointRequest`
**requestOptions:** `OpportunitiesClient.RequestOptions`
client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Opportunity` PATCHs.
#### 🔌 Usage
```typescript await client.crm.opportunities.metaPatchRetrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `OpportunitiesClient.RequestOptions`
client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Opportunity` POSTs.
#### 🔌 Usage
```typescript await client.crm.opportunities.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `OpportunitiesClient.RequestOptions`
client.crm.opportunities.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.opportunities.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.opportunities.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest`
**requestOptions:** `OpportunitiesClient.RequestOptions`
## Crm Passthrough
client.crm.passthrough.create({ ...params }) -> Merge.RemoteResponse
#### 📝 Description
Pull data from an endpoint not currently supported by Merge.
#### 🔌 Usage
```typescript await client.crm.passthrough.create({ method: "GET", path: "/scooters" }); ```
#### ⚙️ Parameters
**request:** `Merge.DataPassthroughRequest`
**requestOptions:** `PassthroughClient.RequestOptions`
## Crm RegenerateKey
client.crm.regenerateKey.create({ ...params }) -> Merge.RemoteKey
#### 📝 Description
Exchange remote keys.
#### 🔌 Usage
```typescript await client.crm.regenerateKey.create({ name: "Remote Deployment Key 1" }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.RemoteKeyForRegenerationRequest`
**requestOptions:** `RegenerateKeyClient.RequestOptions`
## Crm Stages
client.crm.stages.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Stage` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.stages.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.stages.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.StagesListRequest`
**requestOptions:** `StagesClient.RequestOptions`
client.crm.stages.retrieve(id, { ...params }) -> Merge.Stage
#### 📝 Description
Returns a `Stage` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.stages.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.StagesRetrieveRequest`
**requestOptions:** `StagesClient.RequestOptions`
client.crm.stages.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.stages.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.stages.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.StagesRemoteFieldClassesListRequest`
**requestOptions:** `StagesClient.RequestOptions`
## Crm SyncStatus
client.crm.syncStatus.list({ ...params }) -> core.Page
#### 📝 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 const pageableResponse = await client.crm.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.SyncStatusListRequest`
**requestOptions:** `SyncStatusClient.RequestOptions`
## Crm ForceResync
client.crm.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.crm.forceResync.syncStatusResyncCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `ForceResyncClient.RequestOptions`
## Crm Tasks
client.crm.tasks.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Task` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.tasks.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.tasks.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.TasksListRequest`
**requestOptions:** `TasksClient.RequestOptions`
client.crm.tasks.create({ ...params }) -> Merge.TaskResponse
#### 📝 Description
Creates a `Task` object with the given values.
#### 🔌 Usage
```typescript await client.crm.tasks.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.TaskEndpointRequest`
**requestOptions:** `TasksClient.RequestOptions`
client.crm.tasks.retrieve(id, { ...params }) -> Merge.Task
#### 📝 Description
Returns a `Task` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.tasks.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.TasksRetrieveRequest`
**requestOptions:** `TasksClient.RequestOptions`
client.crm.tasks.partialUpdate(id, { ...params }) -> Merge.TaskResponse
#### 📝 Description
Updates a `Task` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.tasks.partialUpdate("id", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.PatchedTaskEndpointRequest`
**requestOptions:** `TasksClient.RequestOptions`
client.crm.tasks.metaPatchRetrieve(id) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Task` PATCHs.
#### 🔌 Usage
```typescript await client.crm.tasks.metaPatchRetrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `TasksClient.RequestOptions`
client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Task` POSTs.
#### 🔌 Usage
```typescript await client.crm.tasks.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `TasksClient.RequestOptions`
client.crm.tasks.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.tasks.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.tasks.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.TasksRemoteFieldClassesListRequest`
**requestOptions:** `TasksClient.RequestOptions`
## Crm Users
client.crm.users.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `User` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.users.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", email: "email", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.users.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", email: "email", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.UsersListRequest`
**requestOptions:** `UsersClient.RequestOptions`
client.crm.users.retrieve(id, { ...params }) -> Merge.User
#### 📝 Description
Returns a `User` object with the given `id`.
#### 🔌 Usage
```typescript await client.crm.users.retrieve("id", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.crm.UsersRetrieveRequest`
**requestOptions:** `UsersClient.RequestOptions`
client.crm.users.ignoreCreate(model_id, { ...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.users.ignoreCreate("model_id", { reason: "GENERAL_CUSTOMER_REQUEST" }); ```
#### ⚙️ Parameters
**model_id:** `string`
**request:** `Merge.IgnoreCommonModelRequest`
**requestOptions:** `UsersClient.RequestOptions`
client.crm.users.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.crm.users.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.crm.users.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.crm.UsersRemoteFieldClassesListRequest`
**requestOptions:** `UsersClient.RequestOptions`
## Crm WebhookReceivers
client.crm.webhookReceivers.list() -> Merge.WebhookReceiver[]
#### 📝 Description
Returns a list of `WebhookReceiver` objects.
#### 🔌 Usage
```typescript await client.crm.webhookReceivers.list(); ```
#### ⚙️ Parameters
**requestOptions:** `WebhookReceiversClient.RequestOptions`
client.crm.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
#### 📝 Description
Creates a `WebhookReceiver` object with the given values.
#### 🔌 Usage
```typescript await client.crm.webhookReceivers.create({ event: "event", isActive: true }); ```
#### ⚙️ Parameters
**request:** `Merge.crm.WebhookReceiverRequest`
**requestOptions:** `WebhookReceiversClient.RequestOptions`
## Hris AccountDetails
client.hris.accountDetails.retrieve() -> Merge.AccountDetails
#### 📝 Description
Get details for a linked account.
#### 🔌 Usage
```typescript await client.hris.accountDetails.retrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountDetailsClient.RequestOptions`
## Hris AccountToken
client.hris.accountToken.retrieve(public_token) -> Merge.AccountToken
#### 📝 Description
Returns the account token for the end user with the provided public token.
#### 🔌 Usage
```typescript await client.hris.accountToken.retrieve("public_token"); ```
#### ⚙️ Parameters
**public_token:** `string`
**requestOptions:** `AccountTokenClient.RequestOptions`
client.hris.accountToken.regenerateCreate() -> Merge.RegenerateAccountToken
#### 📝 Description
Exchange Linked Account account tokens.
#### 🔌 Usage
```typescript await client.hris.accountToken.regenerateCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountTokenClient.RequestOptions`
## Hris AsyncPassthrough
client.hris.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
#### 📝 Description
Asynchronously pull data from an endpoint not currently supported by Merge.
#### 🔌 Usage
```typescript await client.hris.asyncPassthrough.create({ method: "GET", path: "/scooters" }); ```
#### ⚙️ Parameters
**request:** `Merge.DataPassthroughRequest`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
client.hris.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
#### 📝 Description
Retrieves data from earlier async-passthrough POST request
#### 🔌 Usage
```typescript await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
#### ⚙️ Parameters
**async_passthrough_receipt_id:** `string`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
## Hris AuditTrail
client.hris.auditTrail.list({ ...params }) -> core.Page
#### 📝 Description
Gets a list of audit trail events.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.AuditTrailListRequest`
**requestOptions:** `AuditTrailClient.RequestOptions`
## Hris AvailableActions
client.hris.availableActions.retrieve() -> Merge.AvailableActions
#### 📝 Description
Returns a list of models and actions available for an account.
#### 🔌 Usage
```typescript await client.hris.availableActions.retrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AvailableActionsClient.RequestOptions`
## Hris BankInfo
client.hris.bankInfo.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `BankInfo` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.bankInfo.list({ accountType: "CHECKING", bankName: "bank_name", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), orderBy: "-remote_created_at", pageSize: 1, remoteFields: "account_type", remoteId: "remote_id", showEnumOrigins: "account_type" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.bankInfo.list({ accountType: "CHECKING", bankName: "bank_name", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), orderBy: "-remote_created_at", pageSize: 1, remoteFields: "account_type", remoteId: "remote_id", showEnumOrigins: "account_type" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.BankInfoListRequest`
**requestOptions:** `BankInfoClient.RequestOptions`
client.hris.bankInfo.retrieve(id, { ...params }) -> Merge.BankInfo
#### 📝 Description
Returns a `BankInfo` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.bankInfo.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "account_type", showEnumOrigins: "account_type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.BankInfoRetrieveRequest`
**requestOptions:** `BankInfoClient.RequestOptions`
## Hris Benefits
client.hris.benefits.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Benefit` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.benefits.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.benefits.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.BenefitsListRequest`
**requestOptions:** `BenefitsClient.RequestOptions`
client.hris.benefits.retrieve(id, { ...params }) -> Merge.Benefit
#### 📝 Description
Returns a `Benefit` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.benefits.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.BenefitsRetrieveRequest`
**requestOptions:** `BenefitsClient.RequestOptions`
## Hris Companies
client.hris.companies.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Company` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.companies.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.companies.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.CompaniesListRequest`
**requestOptions:** `CompaniesClient.RequestOptions`
client.hris.companies.retrieve(id, { ...params }) -> Merge.Company
#### 📝 Description
Returns a `Company` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.companies.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.CompaniesRetrieveRequest`
**requestOptions:** `CompaniesClient.RequestOptions`
## Hris Scopes
client.hris.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.hris.scopes.defaultScopesRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ScopesClient.RequestOptions`
client.hris.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.hris.scopes.linkedAccountScopesRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ScopesClient.RequestOptions`
client.hris.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.hris.scopes.linkedAccountScopesCreate({ commonModels: [{ modelName: "Employee", modelPermissions: { "READ": { isEnabled: true }, "WRITE": { isEnabled: false } }, fieldPermissions: { enabledFields: ["avatar", "home_location"], disabledFields: ["work_location"] } }, { modelName: "Benefit", modelPermissions: { "WRITE": { isEnabled: false } } }] }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.LinkedAccountCommonModelScopeDeserializerRequest`
**requestOptions:** `ScopesClient.RequestOptions`
## Hris DeleteAccount
client.hris.deleteAccount.delete() -> void
#### 📝 Description
Delete a linked account.
#### 🔌 Usage
```typescript await client.hris.deleteAccount.delete(); ```
#### ⚙️ Parameters
**requestOptions:** `DeleteAccountClient.RequestOptions`
## Hris Dependents
client.hris.dependents.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Dependent` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.dependents.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", includeDeletedData: true, includeRemoteData: true, includeSensitiveFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.dependents.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", includeDeletedData: true, includeRemoteData: true, includeSensitiveFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.DependentsListRequest`
**requestOptions:** `DependentsClient.RequestOptions`
client.hris.dependents.retrieve(id, { ...params }) -> Merge.Dependent
#### 📝 Description
Returns a `Dependent` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.dependents.retrieve("id", { includeRemoteData: true, includeSensitiveFields: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.DependentsRetrieveRequest`
**requestOptions:** `DependentsClient.RequestOptions`
## Hris EmployeePayrollRuns
client.hris.employeePayrollRuns.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `EmployeePayrollRun` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.employeePayrollRuns.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", endedAfter: new Date("2024-01-15T09:30:00.000Z"), endedBefore: new Date("2024-01-15T09:30:00.000Z"), includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, payrollRunId: "payroll_run_id", remoteId: "remote_id", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z") }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.employeePayrollRuns.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", endedAfter: new Date("2024-01-15T09:30:00.000Z"), endedBefore: new Date("2024-01-15T09:30:00.000Z"), includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, payrollRunId: "payroll_run_id", remoteId: "remote_id", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z") }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.EmployeePayrollRunsListRequest`
**requestOptions:** `EmployeePayrollRunsClient.RequestOptions`
client.hris.employeePayrollRuns.retrieve(id, { ...params }) -> Merge.EmployeePayrollRun
#### 📝 Description
Returns an `EmployeePayrollRun` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.employeePayrollRuns.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.EmployeePayrollRunsRetrieveRequest`
**requestOptions:** `EmployeePayrollRunsClient.RequestOptions`
## Hris Employees
client.hris.employees.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Employee` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.employees.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", displayFullName: "display_full_name", employeeNumber: "employee_number", employmentStatus: "ACTIVE", employmentType: "employment_type", firstName: "first_name", groups: "groups", homeLocationId: "home_location_id", includeDeletedData: true, includeRemoteData: true, includeSensitiveFields: true, includeShellData: true, jobTitle: "job_title", lastName: "last_name", managerId: "manager_id", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, payGroupId: "pay_group_id", personalEmail: "personal_email", remoteFields: "employment_status", remoteId: "remote_id", showEnumOrigins: "employment_status", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z"), teamId: "team_id", terminatedAfter: new Date("2024-01-15T09:30:00.000Z"), terminatedBefore: new Date("2024-01-15T09:30:00.000Z"), workEmail: "work_email", workLocationId: "work_location_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.employees.list({ companyId: "company_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", displayFullName: "display_full_name", employeeNumber: "employee_number", employmentStatus: "ACTIVE", employmentType: "employment_type", firstName: "first_name", groups: "groups", homeLocationId: "home_location_id", includeDeletedData: true, includeRemoteData: true, includeSensitiveFields: true, includeShellData: true, jobTitle: "job_title", lastName: "last_name", managerId: "manager_id", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, payGroupId: "pay_group_id", personalEmail: "personal_email", remoteFields: "employment_status", remoteId: "remote_id", showEnumOrigins: "employment_status", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z"), teamId: "team_id", terminatedAfter: new Date("2024-01-15T09:30:00.000Z"), terminatedBefore: new Date("2024-01-15T09:30:00.000Z"), workEmail: "work_email", workLocationId: "work_location_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.EmployeesListRequest`
**requestOptions:** `EmployeesClient.RequestOptions`
client.hris.employees.create({ ...params }) -> Merge.EmployeeResponse
#### 📝 Description
Creates an `Employee` object with the given values.
#### 🔌 Usage
```typescript await client.hris.employees.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.EmployeeEndpointRequest`
**requestOptions:** `EmployeesClient.RequestOptions`
client.hris.employees.retrieve(id, { ...params }) -> Merge.Employee
#### 📝 Description
Returns an `Employee` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.employees.retrieve("id", { includeRemoteData: true, includeSensitiveFields: true, includeShellData: true, remoteFields: "employment_status", showEnumOrigins: "employment_status" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.EmployeesRetrieveRequest`
**requestOptions:** `EmployeesClient.RequestOptions`
client.hris.employees.ignoreCreate(model_id, { ...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.hris.employees.ignoreCreate("model_id", { reason: "GENERAL_CUSTOMER_REQUEST" }); ```
#### ⚙️ Parameters
**model_id:** `string`
**request:** `Merge.IgnoreCommonModelRequest`
**requestOptions:** `EmployeesClient.RequestOptions`
client.hris.employees.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Employee` POSTs.
#### 🔌 Usage
```typescript await client.hris.employees.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `EmployeesClient.RequestOptions`
## Hris EmployerBenefits
client.hris.employerBenefits.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `EmployerBenefit` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.employerBenefits.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.employerBenefits.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.EmployerBenefitsListRequest`
**requestOptions:** `EmployerBenefitsClient.RequestOptions`
client.hris.employerBenefits.retrieve(id, { ...params }) -> Merge.EmployerBenefit
#### 📝 Description
Returns an `EmployerBenefit` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.employerBenefits.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.EmployerBenefitsRetrieveRequest`
**requestOptions:** `EmployerBenefitsClient.RequestOptions`
## Hris Employments
client.hris.employments.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Employment` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.employments.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), orderBy: "-effective_date", pageSize: 1, remoteFields: "employment_type", remoteId: "remote_id", showEnumOrigins: "employment_type" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.employments.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), orderBy: "-effective_date", pageSize: 1, remoteFields: "employment_type", remoteId: "remote_id", showEnumOrigins: "employment_type" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.EmploymentsListRequest`
**requestOptions:** `EmploymentsClient.RequestOptions`
client.hris.employments.retrieve(id, { ...params }) -> Merge.Employment
#### 📝 Description
Returns an `Employment` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.employments.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "employment_type", showEnumOrigins: "employment_type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.EmploymentsRetrieveRequest`
**requestOptions:** `EmploymentsClient.RequestOptions`
## Hris FieldMapping
client.hris.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.hris.fieldMapping.fieldMappingsRetrieve({ excludeRemoteFieldMetadata: true }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.FieldMappingsRetrieveRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.hris.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.hris.fieldMapping.fieldMappingsCreate({ excludeRemoteFieldMetadata: true, 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.hris.CreateFieldMappingRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.hris.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> 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.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.hris.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...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.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", { remoteDataIterationCount: 1 }); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**request:** `Merge.hris.PatchedEditFieldMappingRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.hris.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.hris.fieldMapping.remoteFieldsRetrieve({ commonModels: "common_models", includeExampleValues: "include_example_values" }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.RemoteFieldsRetrieveRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.hris.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.hris.fieldMapping.targetFieldsRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `FieldMappingClient.RequestOptions`
## Hris GenerateKey
client.hris.generateKey.create({ ...params }) -> Merge.RemoteKey
#### 📝 Description
Create a remote key.
#### 🔌 Usage
```typescript await client.hris.generateKey.create({ name: "Remote Deployment Key 1" }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.GenerateRemoteKeyRequest`
**requestOptions:** `GenerateKeyClient.RequestOptions`
## Hris Groups
client.hris.groups.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Group` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.groups.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonlyUsedAsTeam: "is_commonly_used_as_team", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), names: "names", pageSize: 1, remoteFields: "type", remoteId: "remote_id", showEnumOrigins: "type", types: "types" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.groups.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonlyUsedAsTeam: "is_commonly_used_as_team", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), names: "names", pageSize: 1, remoteFields: "type", remoteId: "remote_id", showEnumOrigins: "type", types: "types" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.GroupsListRequest`
**requestOptions:** `GroupsClient.RequestOptions`
client.hris.groups.retrieve(id, { ...params }) -> Merge.Group
#### 📝 Description
Returns a `Group` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.groups.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "type", showEnumOrigins: "type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.GroupsRetrieveRequest`
**requestOptions:** `GroupsClient.RequestOptions`
client.hris.groups.typesList({ ...params }) -> Merge.GroupsTypesListResponse
#### 📝 Description
Returns a list of distinct group type values from the Groups common model.
#### 🔌 Usage
```typescript await client.hris.groups.typesList({ includeDeletedData: true, showEnumOrigins: "show_enum_origins" }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.GroupsTypesListRequest`
**requestOptions:** `GroupsClient.RequestOptions`
## Hris Issues
client.hris.issues.list({ ...params }) -> core.Page
#### 📝 Description
Gets all issues for Organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.IssuesListRequest`
**requestOptions:** `IssuesClient.RequestOptions`
client.hris.issues.retrieve(id) -> Merge.Issue
#### 📝 Description
Get a specific issue.
#### 🔌 Usage
```typescript await client.hris.issues.retrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `IssuesClient.RequestOptions`
## Hris LinkToken
client.hris.linkToken.create({ ...params }) -> Merge.LinkToken
#### 📝 Description
Creates a link token to be used when linking a new end user. The link token expires after single use.
#### 🔌 Usage
```typescript await client.hris.linkToken.create({ endUserEmailAddress: "example@gmail.com", endUserOrganizationName: "Test Organization", endUserOriginId: "12345", categories: ["hris", "ats"] }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.EndUserDetailsRequest`
**requestOptions:** `LinkTokenClient.RequestOptions`
## Hris LinkedAccounts
client.hris.linkedAccounts.list({ ...params }) -> core.Page
#### 📝 Description
List linked accounts for your organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.LinkedAccountsListRequest`
**requestOptions:** `LinkedAccountsClient.RequestOptions`
## Hris Locations
client.hris.locations.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Location` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.locations.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, locationType: "HOME", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "country", remoteId: "remote_id", showEnumOrigins: "country" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.locations.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, locationType: "HOME", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "country", remoteId: "remote_id", showEnumOrigins: "country" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.LocationsListRequest`
**requestOptions:** `LocationsClient.RequestOptions`
client.hris.locations.retrieve(id, { ...params }) -> Merge.Location
#### 📝 Description
Returns a `Location` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.locations.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "country", showEnumOrigins: "country" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.LocationsRetrieveRequest`
**requestOptions:** `LocationsClient.RequestOptions`
## Hris Passthrough
client.hris.passthrough.create({ ...params }) -> Merge.RemoteResponse
#### 📝 Description
Pull data from an endpoint not currently supported by Merge.
#### 🔌 Usage
```typescript await client.hris.passthrough.create({ method: "GET", path: "/scooters" }); ```
#### ⚙️ Parameters
**request:** `Merge.DataPassthroughRequest`
**requestOptions:** `PassthroughClient.RequestOptions`
## Hris PayGroups
client.hris.payGroups.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `PayGroup` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.payGroups.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.payGroups.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.PayGroupsListRequest`
**requestOptions:** `PayGroupsClient.RequestOptions`
client.hris.payGroups.retrieve(id, { ...params }) -> Merge.PayGroup
#### 📝 Description
Returns a `PayGroup` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.payGroups.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.PayGroupsRetrieveRequest`
**requestOptions:** `PayGroupsClient.RequestOptions`
## Hris PayrollRuns
client.hris.payrollRuns.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `PayrollRun` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.payrollRuns.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endedAfter: new Date("2024-01-15T09:30:00.000Z"), endedBefore: new Date("2024-01-15T09:30:00.000Z"), includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "run_state", remoteId: "remote_id", runType: "CORRECTION", showEnumOrigins: "run_state", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z") }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.payrollRuns.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endedAfter: new Date("2024-01-15T09:30:00.000Z"), endedBefore: new Date("2024-01-15T09:30:00.000Z"), includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "run_state", remoteId: "remote_id", runType: "CORRECTION", showEnumOrigins: "run_state", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z") }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.PayrollRunsListRequest`
**requestOptions:** `PayrollRunsClient.RequestOptions`
client.hris.payrollRuns.retrieve(id, { ...params }) -> Merge.PayrollRun
#### 📝 Description
Returns a `PayrollRun` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.payrollRuns.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "run_state", showEnumOrigins: "run_state" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.PayrollRunsRetrieveRequest`
**requestOptions:** `PayrollRunsClient.RequestOptions`
## Hris RegenerateKey
client.hris.regenerateKey.create({ ...params }) -> Merge.RemoteKey
#### 📝 Description
Exchange remote keys.
#### 🔌 Usage
```typescript await client.hris.regenerateKey.create({ name: "Remote Deployment Key 1" }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.RemoteKeyForRegenerationRequest`
**requestOptions:** `RegenerateKeyClient.RequestOptions`
## Hris SyncStatus
client.hris.syncStatus.list({ ...params }) -> core.Page
#### 📝 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 const pageableResponse = await client.hris.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.SyncStatusListRequest`
**requestOptions:** `SyncStatusClient.RequestOptions`
## Hris ForceResync
client.hris.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.hris.forceResync.syncStatusResyncCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `ForceResyncClient.RequestOptions`
## Hris Teams
client.hris.teams.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Team` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.teams.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, parentTeamId: "parent_team_id", remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.teams.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, parentTeamId: "parent_team_id", remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.TeamsListRequest`
**requestOptions:** `TeamsClient.RequestOptions`
client.hris.teams.retrieve(id, { ...params }) -> Merge.Team
#### 📝 Description
Returns a `Team` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.teams.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.TeamsRetrieveRequest`
**requestOptions:** `TeamsClient.RequestOptions`
## Hris TimeOff
client.hris.timeOff.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `TimeOff` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.timeOff.list({ approverId: "approver_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", endedAfter: new Date("2024-01-15T09:30:00.000Z"), endedBefore: new Date("2024-01-15T09:30:00.000Z"), includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "request_type", remoteId: "remote_id", requestType: "BEREAVEMENT", showEnumOrigins: "request_type", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z"), status: "APPROVED" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.timeOff.list({ approverId: "approver_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", endedAfter: new Date("2024-01-15T09:30:00.000Z"), endedBefore: new Date("2024-01-15T09:30:00.000Z"), includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteFields: "request_type", remoteId: "remote_id", requestType: "BEREAVEMENT", showEnumOrigins: "request_type", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z"), status: "APPROVED" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.TimeOffListRequest`
**requestOptions:** `TimeOffClient.RequestOptions`
client.hris.timeOff.create({ ...params }) -> Merge.TimeOffResponse
#### 📝 Description
Creates a `TimeOff` object with the given values.
#### 🔌 Usage
```typescript await client.hris.timeOff.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.TimeOffEndpointRequest`
**requestOptions:** `TimeOffClient.RequestOptions`
client.hris.timeOff.retrieve(id, { ...params }) -> Merge.TimeOff
#### 📝 Description
Returns a `TimeOff` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.timeOff.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "request_type", showEnumOrigins: "request_type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.TimeOffRetrieveRequest`
**requestOptions:** `TimeOffClient.RequestOptions`
client.hris.timeOff.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `TimeOff` POSTs.
#### 🔌 Usage
```typescript await client.hris.timeOff.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `TimeOffClient.RequestOptions`
## Hris TimeOffBalances
client.hris.timeOffBalances.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `TimeOffBalance` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.timeOffBalances.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, policyType: "BEREAVEMENT", remoteFields: "policy_type", remoteId: "remote_id", showEnumOrigins: "policy_type" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.timeOffBalances.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, policyType: "BEREAVEMENT", remoteFields: "policy_type", remoteId: "remote_id", showEnumOrigins: "policy_type" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.TimeOffBalancesListRequest`
**requestOptions:** `TimeOffBalancesClient.RequestOptions`
client.hris.timeOffBalances.retrieve(id, { ...params }) -> Merge.TimeOffBalance
#### 📝 Description
Returns a `TimeOffBalance` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.timeOffBalances.retrieve("id", { includeRemoteData: true, includeShellData: true, remoteFields: "policy_type", showEnumOrigins: "policy_type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.TimeOffBalancesRetrieveRequest`
**requestOptions:** `TimeOffBalancesClient.RequestOptions`
## Hris TimesheetEntries
client.hris.timesheetEntries.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `TimesheetEntry` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.hris.timesheetEntries.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", endedAfter: new Date("2024-01-15T09:30:00.000Z"), endedBefore: new Date("2024-01-15T09:30:00.000Z"), includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), orderBy: "-start_time", pageSize: 1, remoteId: "remote_id", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z") }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hris.timesheetEntries.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employeeId: "employee_id", endedAfter: new Date("2024-01-15T09:30:00.000Z"), endedBefore: new Date("2024-01-15T09:30:00.000Z"), includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), orderBy: "-start_time", pageSize: 1, remoteId: "remote_id", startedAfter: new Date("2024-01-15T09:30:00.000Z"), startedBefore: new Date("2024-01-15T09:30:00.000Z") }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.hris.TimesheetEntriesListRequest`
**requestOptions:** `TimesheetEntriesClient.RequestOptions`
client.hris.timesheetEntries.create({ ...params }) -> Merge.TimesheetEntryResponse
#### 📝 Description
Creates a `TimesheetEntry` object with the given values.
#### 🔌 Usage
```typescript await client.hris.timesheetEntries.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.TimesheetEntryEndpointRequest`
**requestOptions:** `TimesheetEntriesClient.RequestOptions`
client.hris.timesheetEntries.retrieve(id, { ...params }) -> Merge.TimesheetEntry
#### 📝 Description
Returns a `TimesheetEntry` object with the given `id`.
#### 🔌 Usage
```typescript await client.hris.timesheetEntries.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.hris.TimesheetEntriesRetrieveRequest`
**requestOptions:** `TimesheetEntriesClient.RequestOptions`
client.hris.timesheetEntries.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `TimesheetEntry` POSTs.
#### 🔌 Usage
```typescript await client.hris.timesheetEntries.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `TimesheetEntriesClient.RequestOptions`
## Hris WebhookReceivers
client.hris.webhookReceivers.list() -> Merge.WebhookReceiver[]
#### 📝 Description
Returns a list of `WebhookReceiver` objects.
#### 🔌 Usage
```typescript await client.hris.webhookReceivers.list(); ```
#### ⚙️ Parameters
**requestOptions:** `WebhookReceiversClient.RequestOptions`
client.hris.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
#### 📝 Description
Creates a `WebhookReceiver` object with the given values.
#### 🔌 Usage
```typescript await client.hris.webhookReceivers.create({ event: "event", isActive: true }); ```
#### ⚙️ Parameters
**request:** `Merge.hris.WebhookReceiverRequest`
**requestOptions:** `WebhookReceiversClient.RequestOptions`
## Ticketing AccountDetails
client.ticketing.accountDetails.retrieve() -> Merge.AccountDetails
#### 📝 Description
Get details for a linked account.
#### 🔌 Usage
```typescript await client.ticketing.accountDetails.retrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountDetailsClient.RequestOptions`
## Ticketing AccountToken
client.ticketing.accountToken.retrieve(public_token) -> Merge.AccountToken
#### 📝 Description
Returns the account token for the end user with the provided public token.
#### 🔌 Usage
```typescript await client.ticketing.accountToken.retrieve("public_token"); ```
#### ⚙️ Parameters
**public_token:** `string`
**requestOptions:** `AccountTokenClient.RequestOptions`
client.ticketing.accountToken.regenerateCreate() -> Merge.RegenerateAccountToken
#### 📝 Description
Exchange Linked Account account tokens.
#### 🔌 Usage
```typescript await client.ticketing.accountToken.regenerateCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountTokenClient.RequestOptions`
## Ticketing Accounts
client.ticketing.accounts.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Account` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.accounts.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.accounts.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.AccountsListRequest`
**requestOptions:** `AccountsClient.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", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.AccountsRetrieveRequest`
**requestOptions:** `AccountsClient.RequestOptions`
## Ticketing AsyncPassthrough
client.ticketing.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
#### 📝 Description
Asynchronously pull data from an endpoint not currently supported by Merge.
#### 🔌 Usage
```typescript await client.ticketing.asyncPassthrough.create({ method: "GET", path: "/scooters" }); ```
#### ⚙️ Parameters
**request:** `Merge.DataPassthroughRequest`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
client.ticketing.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
#### 📝 Description
Retrieves data from earlier async-passthrough POST request
#### 🔌 Usage
```typescript await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
#### ⚙️ Parameters
**async_passthrough_receipt_id:** `string`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
## Ticketing Attachments
client.ticketing.attachments.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Attachment` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.attachments.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteId: "remote_id", ticketId: "ticket_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.attachments.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteId: "remote_id", ticketId: "ticket_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.AttachmentsListRequest`
**requestOptions:** `AttachmentsClient.RequestOptions`
client.ticketing.attachments.create({ ...params }) -> Merge.TicketingAttachmentResponse
#### 📝 Description
Creates an `Attachment` object with the given values.
#### 🔌 Usage
```typescript await client.ticketing.attachments.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.TicketingAttachmentEndpointRequest`
**requestOptions:** `AttachmentsClient.RequestOptions`
client.ticketing.attachments.retrieve(id, { ...params }) -> Merge.Attachment
#### 📝 Description
Returns an `Attachment` object with the given `id`.
#### 🔌 Usage
```typescript await client.ticketing.attachments.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.AttachmentsRetrieveRequest`
**requestOptions:** `AttachmentsClient.RequestOptions`
client.ticketing.attachments.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `TicketingAttachment` POSTs.
#### 🔌 Usage
```typescript await client.ticketing.attachments.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AttachmentsClient.RequestOptions`
## Ticketing AuditTrail
client.ticketing.auditTrail.list({ ...params }) -> core.Page
#### 📝 Description
Gets a list of audit trail events.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.AuditTrailListRequest`
**requestOptions:** `AuditTrailClient.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:** `AvailableActionsClient.RequestOptions`
## Ticketing Collections
client.ticketing.collections.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Collection` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.collections.list({ collectionType: "", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, parentCollectionId: "parent_collection_id", remoteFields: "collection_type", remoteId: "remote_id", showEnumOrigins: "collection_type" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.collections.list({ collectionType: "", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, parentCollectionId: "parent_collection_id", remoteFields: "collection_type", remoteId: "remote_id", showEnumOrigins: "collection_type" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.CollectionsListRequest`
**requestOptions:** `CollectionsClient.RequestOptions`
client.ticketing.collections.viewersList(collection_id, { ...params }) -> core.Page
#### 📝 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 const pageableResponse = await client.ticketing.collections.viewersList("collection_id", { cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.collections.viewersList("collection_id", { cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**collection_id:** `string`
**request:** `Merge.ticketing.CollectionsViewersListRequest`
**requestOptions:** `CollectionsClient.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", { includeRemoteData: true, includeShellData: true, remoteFields: "collection_type", showEnumOrigins: "collection_type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.CollectionsRetrieveRequest`
**requestOptions:** `CollectionsClient.RequestOptions`
## Ticketing Comments
client.ticketing.comments.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Comment` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.comments.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteId: "remote_id", ticketId: "ticket_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.comments.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteId: "remote_id", ticketId: "ticket_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.CommentsListRequest`
**requestOptions:** `CommentsClient.RequestOptions`
client.ticketing.comments.create({ ...params }) -> Merge.CommentResponse
#### 📝 Description
Creates a `Comment` object with the given values.
#### 🔌 Usage
```typescript await client.ticketing.comments.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.CommentEndpointRequest`
**requestOptions:** `CommentsClient.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", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.CommentsRetrieveRequest`
**requestOptions:** `CommentsClient.RequestOptions`
client.ticketing.comments.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Comment` POSTs.
#### 🔌 Usage
```typescript await client.ticketing.comments.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `CommentsClient.RequestOptions`
## Ticketing Contacts
client.ticketing.contacts.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Contact` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.contacts.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddress: "email_address", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.contacts.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddress: "email_address", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.ContactsListRequest`
**requestOptions:** `ContactsClient.RequestOptions`
client.ticketing.contacts.create({ ...params }) -> Merge.TicketingContactResponse
#### 📝 Description
Creates a `Contact` object with the given values.
#### 🔌 Usage
```typescript await client.ticketing.contacts.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.TicketingContactEndpointRequest`
**requestOptions:** `ContactsClient.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", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.ContactsRetrieveRequest`
**requestOptions:** `ContactsClient.RequestOptions`
client.ticketing.contacts.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `TicketingContact` POSTs.
#### 🔌 Usage
```typescript await client.ticketing.contacts.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ContactsClient.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:** `ScopesClient.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:** `ScopesClient.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:** `ScopesClient.RequestOptions`
## Ticketing DeleteAccount
client.ticketing.deleteAccount.delete() -> void
#### 📝 Description
Delete a linked account.
#### 🔌 Usage
```typescript await client.ticketing.deleteAccount.delete(); ```
#### ⚙️ Parameters
**requestOptions:** `DeleteAccountClient.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({ excludeRemoteFieldMetadata: true }); ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.FieldMappingsRetrieveRequest`
**requestOptions:** `FieldMappingClient.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({ excludeRemoteFieldMetadata: true, remoteDataIterationCount: 1, 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:** `FieldMappingClient.RequestOptions`
client.ticketing.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> 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
**field_mapping_id:** `string`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.ticketing.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...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", { remoteDataIterationCount: 1 }); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**request:** `Merge.ticketing.PatchedEditFieldMappingRequest`
**requestOptions:** `FieldMappingClient.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({ commonModels: "common_models", includeExampleValues: "include_example_values" }); ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.RemoteFieldsRetrieveRequest`
**requestOptions:** `FieldMappingClient.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:** `FieldMappingClient.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:** `GenerateKeyClient.RequestOptions`
## Ticketing Issues
client.ticketing.issues.list({ ...params }) -> core.Page
#### 📝 Description
Gets all issues for Organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.IssuesListRequest`
**requestOptions:** `IssuesClient.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:** `IssuesClient.RequestOptions`
## Ticketing LinkToken
client.ticketing.linkToken.create({ ...params }) -> Merge.LinkToken
#### 📝 Description
Creates a link token to be used when linking a new end user. The link token expires after single use.
#### 🔌 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:** `LinkTokenClient.RequestOptions`
## Ticketing LinkedAccounts
client.ticketing.linkedAccounts.list({ ...params }) -> core.Page
#### 📝 Description
List linked accounts for your organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.LinkedAccountsListRequest`
**requestOptions:** `LinkedAccountsClient.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:** `PassthroughClient.RequestOptions`
## Ticketing Projects
client.ticketing.projects.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Project` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.projects.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.projects.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.ProjectsListRequest`
**requestOptions:** `ProjectsClient.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", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.ProjectsRetrieveRequest`
**requestOptions:** `ProjectsClient.RequestOptions`
client.ticketing.projects.usersList(parent_id, { ...params }) -> core.Page
#### 📝 Description
Returns a list of `User` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.projects.usersList("parent_id", { cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.projects.usersList("parent_id", { cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**parent_id:** `string`
**request:** `Merge.ticketing.ProjectsUsersListRequest`
**requestOptions:** `ProjectsClient.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:** `RegenerateKeyClient.RequestOptions`
## Ticketing Roles
client.ticketing.roles.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Role` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.roles.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.roles.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.RolesListRequest`
**requestOptions:** `RolesClient.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", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.RolesRetrieveRequest`
**requestOptions:** `RolesClient.RequestOptions`
## Ticketing SyncStatus
client.ticketing.syncStatus.list({ ...params }) -> core.Page
#### 📝 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 const pageableResponse = await client.ticketing.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.SyncStatusListRequest`
**requestOptions:** `SyncStatusClient.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:** `ForceResyncClient.RequestOptions`
## Ticketing Tags
client.ticketing.tags.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Tag` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.tags.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.tags.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.TagsListRequest`
**requestOptions:** `TagsClient.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", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.TagsRetrieveRequest`
**requestOptions:** `TagsClient.RequestOptions`
## Ticketing Teams
client.ticketing.teams.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Team` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.teams.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.teams.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.TeamsListRequest`
**requestOptions:** `TeamsClient.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", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.TeamsRetrieveRequest`
**requestOptions:** `TeamsClient.RequestOptions`
## Ticketing Tickets
client.ticketing.tickets.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Ticket` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.tickets.list({ accountId: "account_id", assigneeIds: "assignee_ids", collectionIds: "collection_ids", completedAfter: new Date("2024-01-15T09:30:00.000Z"), completedBefore: new Date("2024-01-15T09:30:00.000Z"), contactId: "contact_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), creatorId: "creator_id", creatorIds: "creator_ids", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", dueAfter: new Date("2024-01-15T09:30:00.000Z"), dueBefore: new Date("2024-01-15T09:30:00.000Z"), includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, parentTicketId: "parent_ticket_id", priority: "HIGH", remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteCreatedBefore: new Date("2024-01-15T09:30:00.000Z"), remoteFields: "priority", remoteId: "remote_id", remoteIds: "remote_ids", remoteUpdatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteUpdatedBefore: new Date("2024-01-15T09:30:00.000Z"), showEnumOrigins: "priority", status: "", tags: "tags", ticketType: "ticket_type", ticketUrl: "ticket_url" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.tickets.list({ accountId: "account_id", assigneeIds: "assignee_ids", collectionIds: "collection_ids", completedAfter: new Date("2024-01-15T09:30:00.000Z"), completedBefore: new Date("2024-01-15T09:30:00.000Z"), contactId: "contact_id", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), creatorId: "creator_id", creatorIds: "creator_ids", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", dueAfter: new Date("2024-01-15T09:30:00.000Z"), dueBefore: new Date("2024-01-15T09:30:00.000Z"), includeDeletedData: true, includeRemoteData: true, includeRemoteFields: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, parentTicketId: "parent_ticket_id", priority: "HIGH", remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteCreatedBefore: new Date("2024-01-15T09:30:00.000Z"), remoteFields: "priority", remoteId: "remote_id", remoteIds: "remote_ids", remoteUpdatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteUpdatedBefore: new Date("2024-01-15T09:30:00.000Z"), showEnumOrigins: "priority", status: "", tags: "tags", ticketType: "ticket_type", ticketUrl: "ticket_url" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.TicketsListRequest`
**requestOptions:** `TicketsClient.RequestOptions`
client.ticketing.tickets.create({ ...params }) -> Merge.TicketResponse
#### 📝 Description
Creates a `Ticket` object with the given values.
#### 🔌 Usage
```typescript await client.ticketing.tickets.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.TicketEndpointRequest`
**requestOptions:** `TicketsClient.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", { includeRemoteData: true, includeRemoteFields: true, includeShellData: true, remoteFields: "priority", showEnumOrigins: "priority" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.TicketsRetrieveRequest`
**requestOptions:** `TicketsClient.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", { isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.PatchedTicketEndpointRequest`
**requestOptions:** `TicketsClient.RequestOptions`
client.ticketing.tickets.viewersList(ticket_id, { ...params }) -> core.Page
#### 📝 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 const pageableResponse = await client.ticketing.tickets.viewersList("ticket_id", { cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.tickets.viewersList("ticket_id", { cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**ticket_id:** `string`
**request:** `Merge.ticketing.TicketsViewersListRequest`
**requestOptions:** `TicketsClient.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:** `TicketsClient.RequestOptions`
client.ticketing.tickets.metaPostRetrieve({ ...params }) -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `Ticket` POSTs.
#### 🔌 Usage
```typescript await client.ticketing.tickets.metaPostRetrieve({ collectionId: "collection_id", ticketType: "ticket_type" }); ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.TicketsMetaPostRetrieveRequest`
**requestOptions:** `TicketsClient.RequestOptions`
client.ticketing.tickets.remoteFieldClassesList({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `RemoteFieldClass` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.tickets.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ids: "ids", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.tickets.remoteFieldClassesList({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ids: "ids", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isCommonModelField: true, isCustom: true, pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.TicketsRemoteFieldClassesListRequest`
**requestOptions:** `TicketsClient.RequestOptions`
## Ticketing Users
client.ticketing.users.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `User` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.ticketing.users.list({ collections: "collections", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddress: "email_address", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", roles: "roles", team: "team", teams: "teams" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.ticketing.users.list({ collections: "collections", createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddress: "email_address", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id", roles: "roles", team: "team", teams: "teams" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.ticketing.UsersListRequest`
**requestOptions:** `UsersClient.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", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.ticketing.UsersRetrieveRequest`
**requestOptions:** `UsersClient.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:** `WebhookReceiversClient.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:** `WebhookReceiversClient.RequestOptions`
## Filestorage AccountDetails
client.filestorage.accountDetails.retrieve() -> Merge.AccountDetails
#### 📝 Description
Get details for a linked account.
#### 🔌 Usage
```typescript await client.filestorage.accountDetails.retrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountDetailsClient.RequestOptions`
## Filestorage AccountToken
client.filestorage.accountToken.retrieve(public_token) -> Merge.AccountToken
#### 📝 Description
Returns the account token for the end user with the provided public token.
#### 🔌 Usage
```typescript await client.filestorage.accountToken.retrieve("public_token"); ```
#### ⚙️ Parameters
**public_token:** `string`
**requestOptions:** `AccountTokenClient.RequestOptions`
client.filestorage.accountToken.regenerateCreate() -> Merge.RegenerateAccountToken
#### 📝 Description
Exchange Linked Account account tokens.
#### 🔌 Usage
```typescript await client.filestorage.accountToken.regenerateCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `AccountTokenClient.RequestOptions`
## Filestorage AsyncPassthrough
client.filestorage.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
#### 📝 Description
Asynchronously pull data from an endpoint not currently supported by Merge.
#### 🔌 Usage
```typescript await client.filestorage.asyncPassthrough.create({ method: "GET", path: "/scooters" }); ```
#### ⚙️ Parameters
**request:** `Merge.DataPassthroughRequest`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
client.filestorage.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
#### 📝 Description
Retrieves data from earlier async-passthrough POST request
#### 🔌 Usage
```typescript await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id"); ```
#### ⚙️ Parameters
**async_passthrough_receipt_id:** `string`
**requestOptions:** `AsyncPassthroughClient.RequestOptions`
## Filestorage AuditTrail
client.filestorage.auditTrail.list({ ...params }) -> core.Page
#### 📝 Description
Gets a list of audit trail events.
#### 🔌 Usage
```typescript const pageableResponse = await client.filestorage.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.filestorage.auditTrail.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", eventType: "event_type", pageSize: 1, startDate: "start_date", userEmail: "user_email" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.AuditTrailListRequest`
**requestOptions:** `AuditTrailClient.RequestOptions`
## Filestorage AvailableActions
client.filestorage.availableActions.retrieve() -> Merge.AvailableActions
#### 📝 Description
Returns a list of models and actions available for an account.
#### 🔌 Usage
```typescript await client.filestorage.availableActions.retrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `AvailableActionsClient.RequestOptions`
## Filestorage Scopes
client.filestorage.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.filestorage.scopes.defaultScopesRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ScopesClient.RequestOptions`
client.filestorage.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.filestorage.scopes.linkedAccountScopesRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `ScopesClient.RequestOptions`
client.filestorage.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.filestorage.scopes.linkedAccountScopesCreate({ commonModels: [{ modelName: "Employee", modelPermissions: { "READ": { isEnabled: true }, "WRITE": { isEnabled: false } }, fieldPermissions: { enabledFields: ["avatar", "home_location"], disabledFields: ["work_location"] } }, { modelName: "Benefit", modelPermissions: { "WRITE": { isEnabled: false } } }] }); ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.LinkedAccountCommonModelScopeDeserializerRequest`
**requestOptions:** `ScopesClient.RequestOptions`
## Filestorage DeleteAccount
client.filestorage.deleteAccount.delete() -> void
#### 📝 Description
Delete a linked account.
#### 🔌 Usage
```typescript await client.filestorage.deleteAccount.delete(); ```
#### ⚙️ Parameters
**requestOptions:** `DeleteAccountClient.RequestOptions`
## Filestorage Drives
client.filestorage.drives.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Drive` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.filestorage.drives.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.filestorage.drives.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.DrivesListRequest`
**requestOptions:** `DrivesClient.RequestOptions`
client.filestorage.drives.retrieve(id, { ...params }) -> Merge.Drive
#### 📝 Description
Returns a `Drive` object with the given `id`.
#### 🔌 Usage
```typescript await client.filestorage.drives.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.filestorage.DrivesRetrieveRequest`
**requestOptions:** `DrivesClient.RequestOptions`
## Filestorage FieldMapping
client.filestorage.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.filestorage.fieldMapping.fieldMappingsRetrieve({ excludeRemoteFieldMetadata: true }); ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.FieldMappingsRetrieveRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.filestorage.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.filestorage.fieldMapping.fieldMappingsCreate({ excludeRemoteFieldMetadata: true, remoteDataIterationCount: 1, 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.filestorage.CreateFieldMappingRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.filestorage.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> 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.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id"); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.filestorage.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...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.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", { remoteDataIterationCount: 1 }); ```
#### ⚙️ Parameters
**field_mapping_id:** `string`
**request:** `Merge.filestorage.PatchedEditFieldMappingRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.filestorage.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.filestorage.fieldMapping.remoteFieldsRetrieve({ commonModels: "common_models", includeExampleValues: "include_example_values" }); ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.RemoteFieldsRetrieveRequest`
**requestOptions:** `FieldMappingClient.RequestOptions`
client.filestorage.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.filestorage.fieldMapping.targetFieldsRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `FieldMappingClient.RequestOptions`
## Filestorage Files
client.filestorage.files.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `File` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.filestorage.files.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", driveId: "drive_id", folderId: "folder_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, mimeType: "mime_type", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", orderBy: "-created_at", pageSize: 1, remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteCreatedBefore: new Date("2024-01-15T09:30:00.000Z"), remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.filestorage.files.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", driveId: "drive_id", folderId: "folder_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, mimeType: "mime_type", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", orderBy: "-created_at", pageSize: 1, remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"), remoteCreatedBefore: new Date("2024-01-15T09:30:00.000Z"), remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.FilesListRequest`
**requestOptions:** `FilesClient.RequestOptions`
client.filestorage.files.create({ ...params }) -> Merge.FileStorageFileResponse
#### 📝 Description
Creates a `File` object with the given values.
#### 🔌 Usage
```typescript await client.filestorage.files.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.FileStorageFileEndpointRequest`
**requestOptions:** `FilesClient.RequestOptions`
client.filestorage.files.retrieve(id, { ...params }) -> Merge.File_
#### 📝 Description
Returns a `File` object with the given `id`.
#### 🔌 Usage
```typescript await client.filestorage.files.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.filestorage.FilesRetrieveRequest`
**requestOptions:** `FilesClient.RequestOptions`
client.filestorage.files.downloadRequestMetaRetrieve(id, { ...params }) -> Merge.DownloadRequestMeta
#### 📝 Description
Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party. For information on our download process please refer to our direct file download help center article.
#### 🔌 Usage
```typescript await client.filestorage.files.downloadRequestMetaRetrieve("id", { mimeType: "mime_type" }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.filestorage.FilesDownloadRequestMetaRetrieveRequest`
**requestOptions:** `FilesClient.RequestOptions`
client.filestorage.files.downloadRequestMetaList({ ...params }) -> core.Page
#### 📝 Description
Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
#### 🔌 Usage
```typescript const pageableResponse = await client.filestorage.files.downloadRequestMetaList({ createdAfter: "created_after", createdBefore: "created_before", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, mimeTypes: "mime_types", modifiedAfter: "modified_after", modifiedBefore: "modified_before", orderBy: "-created_at", pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.filestorage.files.downloadRequestMetaList({ createdAfter: "created_after", createdBefore: "created_before", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, mimeTypes: "mime_types", modifiedAfter: "modified_after", modifiedBefore: "modified_before", orderBy: "-created_at", pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.FilesDownloadRequestMetaListRequest`
**requestOptions:** `FilesClient.RequestOptions`
client.filestorage.files.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `FileStorageFile` POSTs.
#### 🔌 Usage
```typescript await client.filestorage.files.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `FilesClient.RequestOptions`
## Filestorage Folders
client.filestorage.folders.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Folder` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.filestorage.folders.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", driveId: "drive_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, parentFolderId: "parent_folder_id", remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.filestorage.folders.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", driveId: "drive_id", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), name: "name", pageSize: 1, parentFolderId: "parent_folder_id", remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.FoldersListRequest`
**requestOptions:** `FoldersClient.RequestOptions`
client.filestorage.folders.create({ ...params }) -> Merge.FileStorageFolderResponse
#### 📝 Description
Creates a `Folder` object with the given values.
#### 🔌 Usage
```typescript await client.filestorage.folders.create({ isDebugMode: true, runAsync: true, model: {} }); ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.FileStorageFolderEndpointRequest`
**requestOptions:** `FoldersClient.RequestOptions`
client.filestorage.folders.retrieve(id, { ...params }) -> Merge.Folder
#### 📝 Description
Returns a `Folder` object with the given `id`.
#### 🔌 Usage
```typescript await client.filestorage.folders.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.filestorage.FoldersRetrieveRequest`
**requestOptions:** `FoldersClient.RequestOptions`
client.filestorage.folders.metaPostRetrieve() -> Merge.MetaResponse
#### 📝 Description
Returns metadata for `FileStorageFolder` POSTs.
#### 🔌 Usage
```typescript await client.filestorage.folders.metaPostRetrieve(); ```
#### ⚙️ Parameters
**requestOptions:** `FoldersClient.RequestOptions`
## Filestorage GenerateKey
client.filestorage.generateKey.create({ ...params }) -> Merge.RemoteKey
#### 📝 Description
Create a remote key.
#### 🔌 Usage
```typescript await client.filestorage.generateKey.create({ name: "Remote Deployment Key 1" }); ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.GenerateRemoteKeyRequest`
**requestOptions:** `GenerateKeyClient.RequestOptions`
## Filestorage Groups
client.filestorage.groups.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `Group` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.filestorage.groups.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.filestorage.groups.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", includeDeletedData: true, includeRemoteData: true, includeShellData: true, modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.GroupsListRequest`
**requestOptions:** `GroupsClient.RequestOptions`
client.filestorage.groups.retrieve(id, { ...params }) -> Merge.Group
#### 📝 Description
Returns a `Group` object with the given `id`.
#### 🔌 Usage
```typescript await client.filestorage.groups.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.filestorage.GroupsRetrieveRequest`
**requestOptions:** `GroupsClient.RequestOptions`
## Filestorage Issues
client.filestorage.issues.list({ ...params }) -> core.Page
#### 📝 Description
Gets all issues for Organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.filestorage.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.filestorage.issues.list({ accountToken: "account_token", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endDate: "end_date", endUserOrganizationName: "end_user_organization_name", firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), includeMuted: "include_muted", integrationName: "integration_name", lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"), lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"), linkedAccountId: "linked_account_id", pageSize: 1, startDate: "start_date", status: "ONGOING" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.IssuesListRequest`
**requestOptions:** `IssuesClient.RequestOptions`
client.filestorage.issues.retrieve(id) -> Merge.Issue
#### 📝 Description
Get a specific issue.
#### 🔌 Usage
```typescript await client.filestorage.issues.retrieve("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `IssuesClient.RequestOptions`
## Filestorage LinkToken
client.filestorage.linkToken.create({ ...params }) -> Merge.LinkToken
#### 📝 Description
Creates a link token to be used when linking a new end user. The link token expires after single use.
#### 🔌 Usage
```typescript await client.filestorage.linkToken.create({ endUserEmailAddress: "example@gmail.com", endUserOrganizationName: "Test Organization", endUserOriginId: "12345", categories: ["hris", "ats"] }); ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.EndUserDetailsRequest`
**requestOptions:** `LinkTokenClient.RequestOptions`
## Filestorage LinkedAccounts
client.filestorage.linkedAccounts.list({ ...params }) -> core.Page
#### 📝 Description
List linked accounts for your organization.
#### 🔌 Usage
```typescript const pageableResponse = await client.filestorage.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.filestorage.linkedAccounts.list({ category: "accounting", cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", endUserEmailAddress: "end_user_email_address", endUserOrganizationName: "end_user_organization_name", endUserOriginId: "end_user_origin_id", endUserOriginIds: "end_user_origin_ids", id: "id", ids: "ids", includeDuplicates: true, integrationName: "integration_name", isTestAccount: "is_test_account", pageSize: 1, status: "status" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.LinkedAccountsListRequest`
**requestOptions:** `LinkedAccountsClient.RequestOptions`
## Filestorage Passthrough
client.filestorage.passthrough.create({ ...params }) -> Merge.RemoteResponse
#### 📝 Description
Pull data from an endpoint not currently supported by Merge.
#### 🔌 Usage
```typescript await client.filestorage.passthrough.create({ method: "GET", path: "/scooters" }); ```
#### ⚙️ Parameters
**request:** `Merge.DataPassthroughRequest`
**requestOptions:** `PassthroughClient.RequestOptions`
## Filestorage RegenerateKey
client.filestorage.regenerateKey.create({ ...params }) -> Merge.RemoteKey
#### 📝 Description
Exchange remote keys.
#### 🔌 Usage
```typescript await client.filestorage.regenerateKey.create({ name: "Remote Deployment Key 1" }); ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.RemoteKeyForRegenerationRequest`
**requestOptions:** `RegenerateKeyClient.RequestOptions`
## Filestorage SyncStatus
client.filestorage.syncStatus.list({ ...params }) -> core.Page
#### 📝 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 const pageableResponse = await client.filestorage.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.filestorage.syncStatus.list({ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", pageSize: 1 }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.SyncStatusListRequest`
**requestOptions:** `SyncStatusClient.RequestOptions`
## Filestorage ForceResync
client.filestorage.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.filestorage.forceResync.syncStatusResyncCreate(); ```
#### ⚙️ Parameters
**requestOptions:** `ForceResyncClient.RequestOptions`
## Filestorage Users
client.filestorage.users.list({ ...params }) -> core.Page
#### 📝 Description
Returns a list of `User` objects.
#### 🔌 Usage
```typescript const pageableResponse = await client.filestorage.users.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddress: "email_address", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isMe: "is_me", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.filestorage.users.list({ createdAfter: new Date("2024-01-15T09:30:00.000Z"), createdBefore: new Date("2024-01-15T09:30:00.000Z"), cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", emailAddress: "email_address", includeDeletedData: true, includeRemoteData: true, includeShellData: true, isMe: "is_me", modifiedAfter: new Date("2024-01-15T09:30:00.000Z"), modifiedBefore: new Date("2024-01-15T09:30:00.000Z"), pageSize: 1, remoteId: "remote_id" }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.UsersListRequest`
**requestOptions:** `UsersClient.RequestOptions`
client.filestorage.users.retrieve(id, { ...params }) -> Merge.User
#### 📝 Description
Returns a `User` object with the given `id`.
#### 🔌 Usage
```typescript await client.filestorage.users.retrieve("id", { includeRemoteData: true, includeShellData: true }); ```
#### ⚙️ Parameters
**id:** `string`
**request:** `Merge.filestorage.UsersRetrieveRequest`
**requestOptions:** `UsersClient.RequestOptions`
## Filestorage WebhookReceivers
client.filestorage.webhookReceivers.list() -> Merge.WebhookReceiver[]
#### 📝 Description
Returns a list of `WebhookReceiver` objects.
#### 🔌 Usage
```typescript await client.filestorage.webhookReceivers.list(); ```
#### ⚙️ Parameters
**requestOptions:** `WebhookReceiversClient.RequestOptions`
client.filestorage.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
#### 📝 Description
Creates a `WebhookReceiver` object with the given values.
#### 🔌 Usage
```typescript await client.filestorage.webhookReceivers.create({ event: "event", isActive: true }); ```
#### ⚙️ Parameters
**request:** `Merge.filestorage.WebhookReceiverRequest`
**requestOptions:** `WebhookReceiversClient.RequestOptions`