diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index e2b82d1de..1a55fdb1a 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -15,12 +15,10 @@ jobs:
- name: Compile
run: yarn && yarn build
-
- publish:
- needs: [ compile ]
- if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+
+ test:
runs-on: ubuntu-latest
-
+
steps:
- name: Checkout repo
uses: actions/checkout@v3
@@ -28,15 +26,32 @@ jobs:
- name: Set up node
uses: actions/setup-node@v3
+ - name: Compile
+ run: yarn && yarn test
+
+ publish:
+ needs: [ compile, test ]
+ if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repo
+ uses: actions/checkout@v3
+ - name: Set up node
+ uses: actions/setup-node@v3
- name: Install dependencies
run: yarn install
-
- name: Build
run: yarn build
- name: Publish to npm
run: |
npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
- npm publish --access public
+ if [[ ${GITHUB_REF} == *alpha* ]]; then
+ npm publish --access public --tag alpha
+ elif [[ ${GITHUB_REF} == *beta* ]]; then
+ npm publish --access public --tag beta
+ else
+ npm publish --access public
+ fi
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 1498321f7..72271e049 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,13 +1,3 @@
node_modules
.DS_Store
-/dist
-/Client.d.ts
-/Client.js
-/environments.d.ts
-/environments.js
-/index.d.ts
-/index.js
-/api
-/core
-/errors
-/serialization
\ No newline at end of file
+/dist
\ No newline at end of file
diff --git a/.npmignore b/.npmignore
index e62938dd0..6db0876c4 100644
--- a/.npmignore
+++ b/.npmignore
@@ -1,5 +1,6 @@
node_modules
src
+tests
.gitignore
.github
.fernignore
diff --git a/jest.config.js b/jest.config.js
new file mode 100644
index 000000000..35d6e65bf
--- /dev/null
+++ b/jest.config.js
@@ -0,0 +1,5 @@
+/** @type {import('jest').Config} */
+module.exports = {
+ preset: "ts-jest",
+ testEnvironment: "node",
+};
diff --git a/package.json b/package.json
index b9e4a6de2..7e00b8545 100644
--- a/package.json
+++ b/package.json
@@ -1,28 +1,43 @@
{
"name": "@mergeapi/merge-node-client",
- "version": "1.0.12",
+ "version": "1.1.0",
"private": false,
"repository": "https://github.com/merge-api/merge-node-client",
"main": "./index.js",
"types": "./index.d.ts",
"scripts": {
- "format": "prettier --write 'src/**/*.ts'",
+ "format": "prettier . --write --ignore-unknown",
"build": "tsc",
- "prepack": "cp -rv dist/. ."
+ "prepack": "cp -rv dist/. .",
+ "test": "jest"
},
"dependencies": {
"url-join": "4.0.1",
- "form-data": "4.0.0",
+ "form-data": "^4.0.0",
+ "formdata-node": "^6.0.3",
"node-fetch": "2.7.0",
"qs": "6.11.2",
+ "readable-stream": "^4.5.2",
"js-base64": "3.7.2"
},
"devDependencies": {
"@types/url-join": "4.0.1",
"@types/qs": "6.9.8",
"@types/node-fetch": "2.6.9",
+ "@types/readable-stream": "^4.0.15",
+ "webpack": "^5.94.0",
+ "ts-loader": "^9.3.1",
+ "jest": "29.7.0",
+ "@types/jest": "29.5.5",
+ "ts-jest": "29.1.1",
+ "jest-environment-jsdom": "29.7.0",
"@types/node": "17.0.33",
"prettier": "2.7.1",
"typescript": "4.6.4"
+ },
+ "browser": {
+ "fs": false,
+ "os": false,
+ "path": false
}
-}
\ No newline at end of file
+}
diff --git a/reference.md b/reference.md
new file mode 100644
index 000000000..a89fbe614
--- /dev/null
+++ b/reference.md
@@ -0,0 +1,28734 @@
+# 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:** `AccountDetails.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats AccountToken
+
+client.ats.accountToken.retrieve(publicToken) -> 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
+
+
+-
+
+
+-
+
+**publicToken:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountToken.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Activities
+
+client.ats.activities.list({ ...params }) -> Merge.PaginatedActivityList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Activity` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.activities.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.ActivitiesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Activities.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.activities.create({ ...params }) -> Merge.ActivityResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Activity` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.activities.create({
+ model: {},
+ remoteUserId: "remote_user_id",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.ActivityEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Activities.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.ActivitiesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Activities.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.activities.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Activity` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.activities.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Activities.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Applications
+
+client.ats.applications.list({ ...params }) -> Merge.PaginatedApplicationList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Application` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.applications.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.ApplicationsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Applications.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.applications.create({ ...params }) -> Merge.ApplicationResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Application` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.applications.create({
+ model: {},
+ remoteUserId: "remote_user_id",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.ApplicationEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Applications.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.ApplicationsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Applications.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.UpdateApplicationStageRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Applications.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.applications.metaPostRetrieve({ ...params }) -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Application` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.applications.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.ApplicationsMetaPostRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Applications.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:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**asyncPassthroughReceiptId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Attachments
+
+client.ats.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Attachment` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.attachments.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.AttachmentsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.attachments.create({ ...params }) -> Merge.AttachmentResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Attachment` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.attachments.create({
+ model: {},
+ remoteUserId: "remote_user_id",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.AttachmentEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.AttachmentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.attachments.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Attachment` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.attachments.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats AuditTrail
+
+client.ats.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.auditTrail.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.AuditTrailListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AuditTrail.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:** `AvailableActions.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Candidates
+
+client.ats.candidates.list({ ...params }) -> Merge.PaginatedCandidateList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Candidate` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.candidates.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.CandidatesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Candidates.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.candidates.create({ ...params }) -> Merge.CandidateResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Candidate` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.candidates.create({
+ model: {},
+ remoteUserId: "remote_user_id",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.CandidateEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Candidates.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.CandidatesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Candidates.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", {
+ model: {},
+ remoteUserId: "remote_user_id",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.PatchedCandidateEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Candidates.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.candidates.ignoreCreate(modelId, { ...params }) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.candidates.ignoreCreate("model_id", {
+ reason: "GENERAL_CUSTOMER_REQUEST",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**modelId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Candidates.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:** `Candidates.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.candidates.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Candidate` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.candidates.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Candidates.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:** `Scopes.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:** `Scopes.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,
+ },
+ },
+ },
+ {
+ modelName: "Benefit",
+ modelPermissions: {
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ },
+ ],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.LinkedAccountCommonModelScopeDeserializerRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Scopes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats DeleteAccount
+
+client.ats.deleteAccount.delete() -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.deleteAccount.delete();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `DeleteAccount.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Departments
+
+client.ats.departments.list({ ...params }) -> Merge.PaginatedDepartmentList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Department` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.departments.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.DepartmentsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Departments.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.DepartmentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Departments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Eeocs
+
+client.ats.eeocs.list({ ...params }) -> Merge.PaginatedEeocList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `EEOC` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.eeocs.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.EeocsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Eeocs.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.EeocsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Eeocs.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats FieldMapping
+
+client.ats.fieldMapping.fieldMappingsRetrieve() -> 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();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `FieldMapping.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({
+ 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:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.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();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.RemoteFieldsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.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:** `FieldMapping.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:** `GenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Interviews
+
+client.ats.interviews.list({ ...params }) -> Merge.PaginatedScheduledInterviewList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `ScheduledInterview` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.interviews.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.InterviewsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Interviews.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.interviews.create({ ...params }) -> Merge.ScheduledInterviewResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `ScheduledInterview` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.interviews.create({
+ model: {},
+ remoteUserId: "remote_user_id",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.ScheduledInterviewEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Interviews.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.InterviewsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Interviews.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.interviews.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `ScheduledInterview` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.interviews.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Interviews.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Issues
+
+client.ats.issues.list({ ...params }) -> Merge.PaginatedIssueList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets all issues for Organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.issues.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.IssuesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Issues.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:** `Issues.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats JobInterviewStages
+
+client.ats.jobInterviewStages.list({ ...params }) -> Merge.PaginatedJobInterviewStageList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `JobInterviewStage` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.jobInterviewStages.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.JobInterviewStagesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JobInterviewStages.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.JobInterviewStagesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JobInterviewStages.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats JobPostings
+
+client.ats.jobPostings.list({ ...params }) -> Merge.PaginatedJobPostingList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `JobPosting` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.jobPostings.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.JobPostingsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JobPostings.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.JobPostingsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JobPostings.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Jobs
+
+client.ats.jobs.list({ ...params }) -> Merge.PaginatedJobList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Job` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.jobs.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.JobsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Jobs.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.JobsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Jobs.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ats.jobs.screeningQuestionsList(jobId, { ...params }) -> Merge.PaginatedScreeningQuestionList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `ScreeningQuestion` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.jobs.screeningQuestionsList("job_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**jobId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.JobsScreeningQuestionsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Jobs.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats LinkToken
+
+client.ats.linkToken.create({ ...params }) -> Merge.LinkToken
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+
+#### 🔌 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:** `LinkToken.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats LinkedAccounts
+
+client.ats.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.linkedAccounts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.LinkedAccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LinkedAccounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Offers
+
+client.ats.offers.list({ ...params }) -> Merge.PaginatedOfferList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Offer` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.offers.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.OffersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Offers.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.OffersRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Offers.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Offices
+
+client.ats.offices.list({ ...params }) -> Merge.PaginatedOfficeList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Office` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.offices.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.OfficesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Offices.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.OfficesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Offices.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:** `Passthrough.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:** `RegenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats RejectReasons
+
+client.ats.rejectReasons.list({ ...params }) -> Merge.PaginatedRejectReasonList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RejectReason` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.rejectReasons.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.RejectReasonsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `RejectReasons.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.RejectReasonsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `RejectReasons.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Scorecards
+
+client.ats.scorecards.list({ ...params }) -> Merge.PaginatedScorecardList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Scorecard` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.scorecards.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.ScorecardsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Scorecards.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.ScorecardsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Scorecards.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats SyncStatus
+
+client.ats.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.syncStatus.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.SyncStatusListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `SyncStatus.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats ForceResync
+
+client.ats.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.forceResync.syncStatusResyncCreate();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `ForceResync.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Tags
+
+client.ats.tags.list({ ...params }) -> Merge.PaginatedTagList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Tag` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.tags.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.TagsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tags.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ats Users
+
+client.ats.users.list({ ...params }) -> Merge.PaginatedRemoteUserList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteUser` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.users.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ats.UsersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ats.UsersRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.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:** `WebhookReceivers.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:** `WebhookReceivers.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:** `AccountDetails.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage AccountToken
+
+client.filestorage.accountToken.retrieve(publicToken) -> 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
+
+
+-
+
+
+-
+
+**publicToken:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountToken.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:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.filestorage.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**asyncPassthroughReceiptId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage AuditTrail
+
+client.filestorage.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.auditTrail.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.AuditTrailListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AuditTrail.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:** `AvailableActions.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:** `Scopes.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:** `Scopes.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,
+ },
+ },
+ },
+ {
+ modelName: "Benefit",
+ modelPermissions: {
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ },
+ ],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.LinkedAccountCommonModelScopeDeserializerRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Scopes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage DeleteAccount
+
+client.filestorage.deleteAccount.delete() -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.deleteAccount.delete();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `DeleteAccount.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage Drives
+
+client.filestorage.drives.list({ ...params }) -> Merge.PaginatedDriveList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Drive` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.drives.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.DrivesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Drives.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.filestorage.DrivesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Drives.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage FieldMapping
+
+client.filestorage.fieldMapping.fieldMappingsRetrieve() -> 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();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `FieldMapping.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({
+ 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:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.filestorage.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.filestorage.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.filestorage.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.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();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.RemoteFieldsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.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:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage Files
+
+client.filestorage.files.list({ ...params }) -> Merge.PaginatedFileList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `File` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.files.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.FilesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Files.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.filestorage.files.create({ ...params }) -> Merge.FileStorageFileResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `File` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.files.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.FileStorageFileEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Files.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.filestorage.FilesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Files.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.filestorage.files.downloadRetrieve(id, { ...params }) -> stream.Readable
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the `File` content with the given `id` as a stream of bytes.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.files.downloadRetrieve("string", {
+ mimeType: "string",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.filestorage.FilesDownloadRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Files.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.filestorage.files.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `FileStorageFile` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.files.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Files.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage Folders
+
+client.filestorage.folders.list({ ...params }) -> Merge.PaginatedFolderList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Folder` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.folders.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.FoldersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Folders.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.filestorage.folders.create({ ...params }) -> Merge.FileStorageFolderResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Folder` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.folders.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.FileStorageFolderEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Folders.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.filestorage.FoldersRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Folders.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.filestorage.folders.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `FileStorageFolder` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.folders.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Folders.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:** `GenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage Groups
+
+client.filestorage.groups.list({ ...params }) -> Merge.PaginatedGroupList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Group` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.groups.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.GroupsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Groups.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.filestorage.GroupsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Groups.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage Issues
+
+client.filestorage.issues.list({ ...params }) -> Merge.PaginatedIssueList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets all issues for Organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.issues.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.IssuesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Issues.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:** `Issues.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage LinkToken
+
+client.filestorage.linkToken.create({ ...params }) -> Merge.LinkToken
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+
+#### 🔌 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:** `LinkToken.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage LinkedAccounts
+
+client.filestorage.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.linkedAccounts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.LinkedAccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LinkedAccounts.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:** `Passthrough.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:** `RegenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage SyncStatus
+
+client.filestorage.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.syncStatus.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.SyncStatusListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `SyncStatus.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage ForceResync
+
+client.filestorage.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.forceResync.syncStatusResyncCreate();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `ForceResync.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Filestorage Users
+
+client.filestorage.users.list({ ...params }) -> Merge.PaginatedUserList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.filestorage.users.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.filestorage.UsersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.filestorage.UsersRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.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:** `WebhookReceivers.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:** `WebhookReceivers.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm AccountDetails
+
+client.crm.accountDetails.retrieve() -> Merge.AccountDetails
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get details for a linked account.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.accountDetails.retrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `AccountDetails.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm AccountToken
+
+client.crm.accountToken.retrieve(publicToken) -> Merge.AccountToken
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the account token for the end user with the provided public token.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.accountToken.retrieve("public_token");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**publicToken:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountToken.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Accounts
+
+client.crm.accounts.list({ ...params }) -> Merge.PaginatedAccountList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Account` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.accounts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.AccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Account` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.accounts.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.CrmAccountEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Account` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.accounts.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.AccountsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates an `Account` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.accounts.partialUpdate("id", {
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.PatchedCrmAccountEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMAccount` PATCHs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.accounts.metaPatchRetrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMAccount` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.accounts.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.accounts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.accounts.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm AsyncPassthrough
+
+client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.asyncPassthrough.create({
+ method: "GET",
+ path: "/scooters",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.DataPassthroughRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**asyncPassthroughReceiptId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm AuditTrail
+
+client.crm.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.auditTrail.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.AuditTrailListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AuditTrail.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm AvailableActions
+
+client.crm.availableActions.retrieve() -> Merge.AvailableActions
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.availableActions.retrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `AvailableActions.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Contacts
+
+client.crm.contacts.list({ ...params }) -> Merge.PaginatedContactList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Contact` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.contacts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.ContactsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Contact` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.contacts.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.CrmContactEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Contact` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.contacts.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.ContactsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates a `Contact` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.contacts.partialUpdate("id", {
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.PatchedCrmContactEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.contacts.ignoreCreate(modelId, { ...params }) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.contacts.ignoreCreate("model_id", {
+ reason: "GENERAL_CUSTOMER_REQUEST",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**modelId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMContact` PATCHs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.contacts.metaPatchRetrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMContact` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.contacts.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.contacts.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm CustomObjectClasses
+
+client.crm.customObjectClasses.list({ ...params }) -> Merge.PaginatedCustomObjectClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `CustomObjectClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.customObjectClasses.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjectClasses.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `CustomObjectClass` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.customObjectClasses.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjectClasses.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm AssociationTypes
+
+client.crm.associationTypes.customObjectClassesAssociationTypesList(customObjectClassId, { ...params }) -> Merge.PaginatedAssociationTypeList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `AssociationType` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**customObjectClassId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AssociationTypes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.associationTypes.customObjectClassesAssociationTypesCreate(customObjectClassId, { ...params }) -> Merge.CrmAssociationTypeResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `AssociationType` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("custom_object_class_id", {
+ model: {
+ sourceObjectClass: {
+ id: "id",
+ originType: "CUSTOM_OBJECT",
+ },
+ targetObjectClasses: [
+ {
+ id: "id",
+ originType: "CUSTOM_OBJECT",
+ },
+ ],
+ remoteKeyName: "remote_key_name",
+ },
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**customObjectClassId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CrmAssociationTypeEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AssociationTypes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(customObjectClassId, id, { ...params }) -> Merge.AssociationType
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `AssociationType` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**customObjectClassId:** `string`
+
+
+
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AssociationTypes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMAssociationType` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**customObjectClassId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AssociationTypes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm CustomObjects
+
+client.crm.customObjects.customObjectClassesCustomObjectsList(customObjectClassId, { ...params }) -> Merge.PaginatedCustomObjectList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `CustomObject` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**customObjectClassId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjects.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.customObjects.customObjectClassesCustomObjectsCreate(customObjectClassId, { ...params }) -> Merge.CrmCustomObjectResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `CustomObject` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", {
+ model: {
+ fields: {
+ test_field: "hello",
+ },
+ },
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**customObjectClassId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CrmCustomObjectEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjects.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(customObjectClassId, id, { ...params }) -> Merge.CustomObject
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `CustomObject` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**customObjectClassId:** `string`
+
+
+
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjects.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(customObjectClassId) -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMCustomObject` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**customObjectClassId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjects.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjects.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Associations
+
+client.crm.associations.customObjectClassesCustomObjectsAssociationsList(customObjectClassId, objectId, { ...params }) -> Merge.PaginatedAssociationList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Association` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**customObjectClassId:** `string`
+
+
+
+
+
+-
+
+**objectId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Associations.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(associationTypeId, sourceClassId, sourceObjectId, targetClassId, targetObjectId, { ...params }) -> Merge.Association
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(
+ "association_type_id",
+ "source_class_id",
+ "source_object_id",
+ "target_class_id",
+ "target_object_id"
+);
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**associationTypeId:** `string`
+
+
+
+
+
+-
+
+**sourceClassId:** `string`
+
+
+
+
+
+-
+
+**sourceObjectId:** `string`
+
+
+
+
+
+-
+
+**targetClassId:** `string`
+
+
+
+
+
+-
+
+**targetObjectId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Associations.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Scopes
+
+client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.scopes.defaultScopesRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Scopes.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:** `Scopes.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,
+ },
+ },
+ },
+ {
+ modelName: "Benefit",
+ modelPermissions: {
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ },
+ ],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Scopes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm DeleteAccount
+
+client.crm.deleteAccount.delete() -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.deleteAccount.delete();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `DeleteAccount.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm EngagementTypes
+
+client.crm.engagementTypes.list({ ...params }) -> Merge.PaginatedEngagementTypeList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `EngagementType` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.engagementTypes.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.EngagementTypesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EngagementTypes.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.EngagementTypesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EngagementTypes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.engagementTypes.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EngagementTypes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Engagements
+
+client.crm.engagements.list({ ...params }) -> Merge.PaginatedEngagementList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Engagement` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.engagements.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.EngagementsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Engagements.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Engagement` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.engagements.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.EngagementEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Engagements.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.EngagementsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Engagements.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", {
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.PatchedEngagementEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Engagements.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:** `Engagements.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Engagement` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.engagements.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Engagements.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.engagements.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.engagements.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Engagements.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm FieldMapping
+
+client.crm.fieldMapping.fieldMappingsRetrieve() -> 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();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `FieldMapping.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({
+ 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:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.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();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.RemoteFieldsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.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:** `FieldMapping.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:** `GenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Issues
+
+client.crm.issues.list({ ...params }) -> Merge.PaginatedIssueList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets all issues for Organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.issues.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.IssuesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Issues.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:** `Issues.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Leads
+
+client.crm.leads.list({ ...params }) -> Merge.PaginatedLeadList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Lead` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.leads.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.LeadsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Leads.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.leads.create({ ...params }) -> Merge.LeadResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Lead` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.leads.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.LeadEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Leads.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.LeadsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Leads.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Lead` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.leads.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Leads.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.leads.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.leads.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Leads.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm LinkToken
+
+client.crm.linkToken.create({ ...params }) -> Merge.LinkToken
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+
+#### 🔌 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:** `LinkToken.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm LinkedAccounts
+
+client.crm.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.linkedAccounts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.LinkedAccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LinkedAccounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Notes
+
+client.crm.notes.list({ ...params }) -> Merge.PaginatedNoteList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Note` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.notes.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.NotesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Notes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.notes.create({ ...params }) -> Merge.NoteResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Note` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.notes.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.NoteEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Notes.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.NotesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Notes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Note` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.notes.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Notes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.notes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.notes.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.NotesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Notes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Opportunities
+
+client.crm.opportunities.list({ ...params }) -> Merge.PaginatedOpportunityList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Opportunity` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.opportunities.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.OpportunitiesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Opportunities.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Opportunity` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.opportunities.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.OpportunityEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Opportunities.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.OpportunitiesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Opportunities.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", {
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.PatchedOpportunityEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Opportunities.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:** `Opportunities.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Opportunity` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.opportunities.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Opportunities.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.opportunities.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Opportunities.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:** `Passthrough.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:** `RegenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Stages
+
+client.crm.stages.list({ ...params }) -> Merge.PaginatedStageList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Stage` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.stages.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.StagesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Stages.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.StagesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Stages.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.stages.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.stages.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.StagesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Stages.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm SyncStatus
+
+client.crm.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.syncStatus.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.SyncStatusListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `SyncStatus.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm ForceResync
+
+client.crm.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.forceResync.syncStatusResyncCreate();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `ForceResync.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Tasks
+
+client.crm.tasks.list({ ...params }) -> Merge.PaginatedTaskList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Task` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.tasks.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.TasksListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tasks.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.tasks.create({ ...params }) -> Merge.TaskResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Task` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.tasks.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.TaskEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tasks.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.TasksRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tasks.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", {
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.PatchedTaskEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tasks.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:** `Tasks.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Task` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.tasks.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Tasks.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.tasks.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.tasks.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.TasksRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tasks.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Crm Users
+
+client.crm.users.list({ ...params }) -> Merge.PaginatedUserList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.users.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.UsersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.UsersRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.users.ignoreCreate(modelId, { ...params }) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.users.ignoreCreate("model_id", {
+ reason: "GENERAL_CUSTOMER_REQUEST",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**modelId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.crm.users.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.users.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.crm.UsersRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.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:** `WebhookReceivers.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:** `WebhookReceivers.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:** `AccountDetails.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing AccountToken
+
+client.ticketing.accountToken.retrieve(publicToken) -> 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
+
+
+-
+
+
+-
+
+**publicToken:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountToken.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Accounts
+
+client.ticketing.accounts.list({ ...params }) -> Merge.PaginatedAccountList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Account` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.accounts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.AccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.accounts.retrieve(id, { ...params }) -> Merge.Account
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Account` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.accounts.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.AccountsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing AsyncPassthrough
+
+client.ticketing.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.asyncPassthrough.create({
+ method: "GET",
+ path: "/scooters",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.DataPassthroughRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**asyncPassthroughReceiptId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Attachments
+
+client.ticketing.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Attachment` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.attachments.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.AttachmentsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.attachments.create({ ...params }) -> Merge.TicketingAttachmentResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Attachment` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.attachments.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.TicketingAttachmentEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.AttachmentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.attachments.downloadRetrieve(id, { ...params }) -> stream.Readable
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the `File` content with the given `id` as a stream of bytes.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.attachments.downloadRetrieve("string", {
+ mimeType: "string",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.AttachmentsDownloadRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.attachments.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `TicketingAttachment` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.attachments.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing AuditTrail
+
+client.ticketing.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.auditTrail.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.AuditTrailListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AuditTrail.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing AvailableActions
+
+client.ticketing.availableActions.retrieve() -> Merge.AvailableActions
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.availableActions.retrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `AvailableActions.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Collections
+
+client.ticketing.collections.list({ ...params }) -> Merge.PaginatedCollectionList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Collection` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.collections.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.CollectionsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Collections.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.collections.retrieve(id, { ...params }) -> Merge.Collection
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Collection` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.collections.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.CollectionsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Collections.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.collections.usersList(parentId, { ...params }) -> Merge.PaginatedUserList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.collections.usersList("parent_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**parentId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.CollectionsUsersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Collections.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Comments
+
+client.ticketing.comments.list({ ...params }) -> Merge.PaginatedCommentList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Comment` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.comments.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.CommentsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.comments.create({ ...params }) -> Merge.CommentResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Comment` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.comments.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.CommentEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.comments.retrieve(id, { ...params }) -> Merge.Comment
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Comment` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.comments.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.CommentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.comments.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Comment` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.comments.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Comments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Contacts
+
+client.ticketing.contacts.list({ ...params }) -> Merge.PaginatedContactList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Contact` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.contacts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.ContactsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.contacts.create({ ...params }) -> Merge.TicketingContactResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Contact` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.contacts.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.TicketingContactEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.contacts.retrieve(id, { ...params }) -> Merge.Contact
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Contact` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.contacts.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.ContactsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.contacts.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `TicketingContact` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.contacts.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Scopes
+
+client.ticketing.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.scopes.defaultScopesRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Scopes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.scopes.linkedAccountScopesRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Scopes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.scopes.linkedAccountScopesCreate({
+ commonModels: [
+ {
+ modelName: "Employee",
+ modelPermissions: {
+ READ: {
+ isEnabled: true,
+ },
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ },
+ {
+ modelName: "Benefit",
+ modelPermissions: {
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ },
+ ],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.LinkedAccountCommonModelScopeDeserializerRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Scopes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing DeleteAccount
+
+client.ticketing.deleteAccount.delete() -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.deleteAccount.delete();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `DeleteAccount.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing FieldMapping
+
+client.ticketing.fieldMapping.fieldMappingsRetrieve() -> Merge.FieldMappingApiInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.fieldMapping.fieldMappingsRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.fieldMapping.fieldMappingsCreate({
+ targetFieldName: "example_target_field_name",
+ targetFieldDescription: "this is a example description of the target field",
+ remoteFieldTraversalPath: ["example_remote_field"],
+ remoteMethod: "GET",
+ remoteUrlPath: "/example-url-path",
+ commonModelName: "ExampleCommonModel",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.CreateFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.fieldMapping.remoteFieldsRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.RemoteFieldsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.fieldMapping.targetFieldsRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing GenerateKey
+
+client.ticketing.generateKey.create({ ...params }) -> Merge.RemoteKey
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a remote key.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.generateKey.create({
+ name: "Remote Deployment Key 1",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.GenerateRemoteKeyRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `GenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Issues
+
+client.ticketing.issues.list({ ...params }) -> Merge.PaginatedIssueList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets all issues for Organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.issues.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.IssuesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Issues.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.issues.retrieve(id) -> Merge.Issue
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a specific issue.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.issues.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Issues.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing LinkToken
+
+client.ticketing.linkToken.create({ ...params }) -> Merge.LinkToken
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.linkToken.create({
+ endUserEmailAddress: "example@gmail.com",
+ endUserOrganizationName: "Test Organization",
+ endUserOriginId: "12345",
+ categories: ["hris", "ats"],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.EndUserDetailsRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LinkToken.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing LinkedAccounts
+
+client.ticketing.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.linkedAccounts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.LinkedAccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LinkedAccounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Passthrough
+
+client.ticketing.passthrough.create({ ...params }) -> Merge.RemoteResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.passthrough.create({
+ method: "GET",
+ path: "/scooters",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.DataPassthroughRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Passthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Projects
+
+client.ticketing.projects.list({ ...params }) -> Merge.PaginatedProjectList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Project` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.projects.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.ProjectsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Projects.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.projects.retrieve(id, { ...params }) -> Merge.Project
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Project` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.projects.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.ProjectsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Projects.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.projects.usersList(parentId, { ...params }) -> Merge.PaginatedUserList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.projects.usersList("parent_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**parentId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.ProjectsUsersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Projects.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing RegenerateKey
+
+client.ticketing.regenerateKey.create({ ...params }) -> Merge.RemoteKey
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Exchange remote keys.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.regenerateKey.create({
+ name: "Remote Deployment Key 1",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.RemoteKeyForRegenerationRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `RegenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Roles
+
+client.ticketing.roles.list({ ...params }) -> Merge.PaginatedRoleList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Role` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.roles.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.RolesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Roles.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.roles.retrieve(id, { ...params }) -> Merge.Role
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Role` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.roles.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.RolesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Roles.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing SyncStatus
+
+client.ticketing.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.syncStatus.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.SyncStatusListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `SyncStatus.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing ForceResync
+
+client.ticketing.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.forceResync.syncStatusResyncCreate();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `ForceResync.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Tags
+
+client.ticketing.tags.list({ ...params }) -> Merge.PaginatedTagList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Tag` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.tags.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.TagsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tags.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.tags.retrieve(id, { ...params }) -> Merge.Tag
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Tag` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.tags.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.TagsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tags.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Teams
+
+client.ticketing.teams.list({ ...params }) -> Merge.PaginatedTeamList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Team` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.teams.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.TeamsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Teams.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.teams.retrieve(id, { ...params }) -> Merge.Team
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Team` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.teams.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.TeamsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Teams.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Tickets
+
+client.ticketing.tickets.list({ ...params }) -> Merge.PaginatedTicketList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Ticket` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.tickets.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.TicketsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.create({ ...params }) -> Merge.TicketResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Ticket` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.tickets.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.TicketEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.retrieve(id, { ...params }) -> Merge.Ticket
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Ticket` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.tickets.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.TicketsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.partialUpdate(id, { ...params }) -> Merge.TicketResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates a `Ticket` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.tickets.partialUpdate("id", {
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.PatchedTicketEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.collaboratorsList(parentId, { ...params }) -> Merge.PaginatedUserList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.tickets.collaboratorsList("parent_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**parentId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.TicketsCollaboratorsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.metaPatchRetrieve(id) -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Ticket` PATCHs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.tickets.metaPatchRetrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Ticket` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.tickets.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.tickets.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.TicketsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Tickets.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing Users
+
+client.ticketing.users.list({ ...params }) -> Merge.PaginatedUserList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.users.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.UsersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.users.retrieve(id, { ...params }) -> Merge.User
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `User` object with the given `id`.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.users.retrieve("id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.ticketing.UsersRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Users.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Ticketing WebhookReceivers
+
+client.ticketing.webhookReceivers.list() -> Merge.WebhookReceiver[]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `WebhookReceiver` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.webhookReceivers.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `WebhookReceivers.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.ticketing.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `WebhookReceiver` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ticketing.webhookReceivers.create({
+ event: "event",
+ isActive: true,
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.ticketing.WebhookReceiverRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `WebhookReceivers.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris AccountDetails
+
+client.hris.accountDetails.retrieve() -> Merge.AccountDetails
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get details for a linked account.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.accountDetails.retrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `AccountDetails.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris AccountToken
+
+client.hris.accountToken.retrieve(publicToken) -> 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
+
+
+-
+
+
+-
+
+**publicToken:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountToken.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:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.hris.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**asyncPassthroughReceiptId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris AuditTrail
+
+client.hris.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.auditTrail.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.AuditTrailListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AuditTrail.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:** `AvailableActions.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris BankInfo
+
+client.hris.bankInfo.list({ ...params }) -> Merge.PaginatedBankInfoList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `BankInfo` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.bankInfo.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.BankInfoListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `BankInfo.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.BankInfoRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `BankInfo.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris Benefits
+
+client.hris.benefits.list({ ...params }) -> Merge.PaginatedBenefitList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Benefit` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.benefits.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.BenefitsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Benefits.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.BenefitsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Benefits.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris Companies
+
+client.hris.companies.list({ ...params }) -> Merge.PaginatedCompanyList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Company` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.companies.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.CompaniesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Companies.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.CompaniesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Companies.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:** `Scopes.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:** `Scopes.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,
+ },
+ },
+ },
+ {
+ modelName: "Benefit",
+ modelPermissions: {
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ },
+ ],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.LinkedAccountCommonModelScopeDeserializerRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Scopes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris DeleteAccount
+
+client.hris.deleteAccount.delete() -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.deleteAccount.delete();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `DeleteAccount.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris Dependents
+
+client.hris.dependents.list({ ...params }) -> Merge.PaginatedDependentList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Dependent` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.dependents.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.DependentsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Dependents.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.DependentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Dependents.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris EmployeePayrollRuns
+
+client.hris.employeePayrollRuns.list({ ...params }) -> Merge.PaginatedEmployeePayrollRunList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `EmployeePayrollRun` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.employeePayrollRuns.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.EmployeePayrollRunsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EmployeePayrollRuns.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.EmployeePayrollRunsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EmployeePayrollRuns.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris Employees
+
+client.hris.employees.list({ ...params }) -> Merge.PaginatedEmployeeList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Employee` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.employees.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.EmployeesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Employees.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.hris.employees.create({ ...params }) -> Merge.EmployeeResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Employee` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.employees.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.EmployeeEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Employees.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.EmployeesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Employees.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.hris.employees.ignoreCreate(modelId, { ...params }) -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.employees.ignoreCreate("model_id", {
+ reason: "GENERAL_CUSTOMER_REQUEST",
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**modelId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Employees.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.hris.employees.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Employee` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.employees.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Employees.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris EmployerBenefits
+
+client.hris.employerBenefits.list({ ...params }) -> Merge.PaginatedEmployerBenefitList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `EmployerBenefit` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.employerBenefits.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.EmployerBenefitsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EmployerBenefits.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.EmployerBenefitsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EmployerBenefits.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris Employments
+
+client.hris.employments.list({ ...params }) -> Merge.PaginatedEmploymentList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Employment` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.employments.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.EmploymentsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Employments.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.EmploymentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Employments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris FieldMapping
+
+client.hris.fieldMapping.fieldMappingsRetrieve() -> 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();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `FieldMapping.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({
+ 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:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.hris.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.hris.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.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();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.RemoteFieldsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.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:** `FieldMapping.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:** `GenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris Groups
+
+client.hris.groups.list({ ...params }) -> Merge.PaginatedGroupList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Group` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.groups.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.GroupsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Groups.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.GroupsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Groups.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris Issues
+
+client.hris.issues.list({ ...params }) -> Merge.PaginatedIssueList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets all issues for Organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.issues.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.IssuesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Issues.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:** `Issues.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris LinkToken
+
+client.hris.linkToken.create({ ...params }) -> Merge.LinkToken
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+
+#### 🔌 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:** `LinkToken.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris LinkedAccounts
+
+client.hris.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.linkedAccounts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.LinkedAccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LinkedAccounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris Locations
+
+client.hris.locations.list({ ...params }) -> Merge.PaginatedLocationList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Location` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.locations.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.LocationsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Locations.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.LocationsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Locations.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:** `Passthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris PayGroups
+
+client.hris.payGroups.list({ ...params }) -> Merge.PaginatedPayGroupList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `PayGroup` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.payGroups.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.PayGroupsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PayGroups.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.PayGroupsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PayGroups.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris PayrollRuns
+
+client.hris.payrollRuns.list({ ...params }) -> Merge.PaginatedPayrollRunList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `PayrollRun` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.payrollRuns.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.PayrollRunsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PayrollRuns.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.PayrollRunsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PayrollRuns.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:** `RegenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris SyncStatus
+
+client.hris.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.syncStatus.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.SyncStatusListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `SyncStatus.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris ForceResync
+
+client.hris.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.forceResync.syncStatusResyncCreate();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `ForceResync.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris Teams
+
+client.hris.teams.list({ ...params }) -> Merge.PaginatedTeamList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Team` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.teams.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.TeamsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Teams.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.TeamsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Teams.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris TimeOff
+
+client.hris.timeOff.list({ ...params }) -> Merge.PaginatedTimeOffList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TimeOff` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.timeOff.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.TimeOffListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimeOff.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.hris.timeOff.create({ ...params }) -> Merge.TimeOffResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `TimeOff` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.timeOff.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.TimeOffEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimeOff.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.TimeOffRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimeOff.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.hris.timeOff.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `TimeOff` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.timeOff.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `TimeOff.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris TimeOffBalances
+
+client.hris.timeOffBalances.list({ ...params }) -> Merge.PaginatedTimeOffBalanceList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TimeOffBalance` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.timeOffBalances.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.TimeOffBalancesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimeOffBalances.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.TimeOffBalancesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimeOffBalances.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Hris TimesheetEntries
+
+client.hris.timesheetEntries.list({ ...params }) -> Merge.PaginatedTimesheetEntryList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TimesheetEntry` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.timesheetEntries.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.TimesheetEntriesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimesheetEntries.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.hris.timesheetEntries.create({ ...params }) -> Merge.TimesheetEntryResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `TimesheetEntry` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.timesheetEntries.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.hris.TimesheetEntryEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimesheetEntries.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.hris.TimesheetEntriesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TimesheetEntries.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.hris.timesheetEntries.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `TimesheetEntry` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.hris.timesheetEntries.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `TimesheetEntries.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:** `WebhookReceivers.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:** `WebhookReceivers.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:** `AccountDetails.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting AccountToken
+
+client.accounting.accountToken.retrieve(publicToken) -> 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
+
+
+-
+
+
+-
+
+**publicToken:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountToken.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting AccountingPeriods
+
+client.accounting.accountingPeriods.list({ ...params }) -> Merge.PaginatedAccountingPeriodList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `AccountingPeriod` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.accountingPeriods.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.AccountingPeriodsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountingPeriods.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.AccountingPeriodsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountingPeriods.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting Accounts
+
+client.accounting.accounts.list({ ...params }) -> Merge.PaginatedAccountList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Account` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.accounts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.AccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.accounts.create({ ...params }) -> Merge.AccountResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Account` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.accounts.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.AccountEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.AccountsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Accounts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.accounts.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Account` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.accounts.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Accounts.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.AddressesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Addresses.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:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.asyncPassthrough.retrieve(asyncPassthroughReceiptId) -> Merge.AsyncPassthroughRetrieveResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**asyncPassthroughReceiptId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AsyncPassthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting Attachments
+
+client.accounting.attachments.list({ ...params }) -> Merge.PaginatedAccountingAttachmentList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `AccountingAttachment` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.attachments.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.AttachmentsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.attachments.create({ ...params }) -> Merge.AccountingAttachmentResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `AccountingAttachment` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.attachments.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.AccountingAttachmentEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.AttachmentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.attachments.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `AccountingAttachment` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.attachments.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Attachments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting AuditTrail
+
+client.accounting.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.auditTrail.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.AuditTrailListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AuditTrail.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:** `AvailableActions.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting BalanceSheets
+
+client.accounting.balanceSheets.list({ ...params }) -> Merge.PaginatedBalanceSheetList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `BalanceSheet` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.balanceSheets.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.BalanceSheetsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `BalanceSheets.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.BalanceSheetsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `BalanceSheets.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting CashFlowStatements
+
+client.accounting.cashFlowStatements.list({ ...params }) -> Merge.PaginatedCashFlowStatementList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `CashFlowStatement` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.cashFlowStatements.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.CashFlowStatementsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CashFlowStatements.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.CashFlowStatementsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CashFlowStatements.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting CompanyInfo
+
+client.accounting.companyInfo.list({ ...params }) -> Merge.PaginatedCompanyInfoList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `CompanyInfo` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.companyInfo.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.CompanyInfoListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CompanyInfo.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.CompanyInfoRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CompanyInfo.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting Contacts
+
+client.accounting.contacts.list({ ...params }) -> Merge.PaginatedContactList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Contact` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.contacts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.ContactsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.contacts.create({ ...params }) -> Merge.ContactResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Contact` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.contacts.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.ContactEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.ContactsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.contacts.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Contact` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.contacts.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.contacts.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.ContactsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Contacts.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting CreditNotes
+
+client.accounting.creditNotes.list({ ...params }) -> Merge.PaginatedCreditNoteList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `CreditNote` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.creditNotes.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.CreditNotesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CreditNotes.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.CreditNotesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CreditNotes.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:** `Scopes.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:** `Scopes.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,
+ },
+ },
+ },
+ {
+ modelName: "Benefit",
+ modelPermissions: {
+ WRITE: {
+ isEnabled: false,
+ },
+ },
+ },
+ ],
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.LinkedAccountCommonModelScopeDeserializerRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Scopes.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting DeleteAccount
+
+client.accounting.deleteAccount.delete() -> void
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.deleteAccount.delete();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `DeleteAccount.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting Expenses
+
+client.accounting.expenses.list({ ...params }) -> Merge.PaginatedExpenseList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Expense` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.expenses.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.ExpensesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Expenses.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.expenses.create({ ...params }) -> Merge.ExpenseResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Expense` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.expenses.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.ExpenseEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Expenses.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.ExpensesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Expenses.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.expenses.linesRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.expenses.linesRemoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.ExpensesLinesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Expenses.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.expenses.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Expense` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.expenses.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Expenses.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.expenses.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.expenses.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.ExpensesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Expenses.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting FieldMapping
+
+client.accounting.fieldMapping.fieldMappingsRetrieve() -> 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();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `FieldMapping.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({
+ 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:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.fieldMapping.fieldMappingsDestroy(fieldMappingId) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.fieldMapping.fieldMappingsPartialUpdate(fieldMappingId, { ...params }) -> Merge.FieldMappingInstanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**fieldMappingId:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.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();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.RemoteFieldsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMapping.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:** `FieldMapping.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:** `GenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting IncomeStatements
+
+client.accounting.incomeStatements.list({ ...params }) -> Merge.PaginatedIncomeStatementList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `IncomeStatement` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.incomeStatements.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.IncomeStatementsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `IncomeStatements.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.IncomeStatementsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `IncomeStatements.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting Invoices
+
+client.accounting.invoices.list({ ...params }) -> Merge.PaginatedInvoiceList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Invoice` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.invoices.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.InvoicesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Invoices.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.create({ ...params }) -> Merge.InvoiceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Invoice` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.invoices.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.InvoiceEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Invoices.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.InvoicesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Invoices.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", {
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.PatchedInvoiceEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Invoices.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.lineItemsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.invoices.lineItemsRemoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.InvoicesLineItemsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Invoices.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:** `Invoices.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Invoice` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.invoices.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Invoices.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.invoices.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.InvoicesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Invoices.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting Issues
+
+client.accounting.issues.list({ ...params }) -> Merge.PaginatedIssueList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets all issues for Organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.issues.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.IssuesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Issues.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:** `Issues.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting Items
+
+client.accounting.items.list({ ...params }) -> Merge.PaginatedItemList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Item` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.items.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.ItemsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Items.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.ItemsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Items.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting JournalEntries
+
+client.accounting.journalEntries.list({ ...params }) -> Merge.PaginatedJournalEntryList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `JournalEntry` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.journalEntries.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.JournalEntriesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JournalEntries.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.journalEntries.create({ ...params }) -> Merge.JournalEntryResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `JournalEntry` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.journalEntries.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.JournalEntryEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JournalEntries.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.JournalEntriesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JournalEntries.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.journalEntries.linesRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.journalEntries.linesRemoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.JournalEntriesLinesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JournalEntries.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.journalEntries.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `JournalEntry` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.journalEntries.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `JournalEntries.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.journalEntries.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.journalEntries.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.JournalEntriesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JournalEntries.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting LinkToken
+
+client.accounting.linkToken.create({ ...params }) -> Merge.LinkToken
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+
+#### 🔌 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:** `LinkToken.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting LinkedAccounts
+
+client.accounting.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.linkedAccounts.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.LinkedAccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `LinkedAccounts.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:** `Passthrough.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting Payments
+
+client.accounting.payments.list({ ...params }) -> Merge.PaginatedPaymentList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Payment` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.payments.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.PaymentsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Payments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.payments.create({ ...params }) -> Merge.PaymentResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Payment` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.payments.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.PaymentEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Payments.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.PaymentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Payments.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", {
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.PatchedPaymentEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Payments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.payments.lineItemsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.payments.lineItemsRemoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.PaymentsLineItemsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Payments.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:** `Payments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.payments.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Payment` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.payments.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `Payments.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.payments.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.payments.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.PaymentsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Payments.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.PhoneNumbersRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PhoneNumbers.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting PurchaseOrders
+
+client.accounting.purchaseOrders.list({ ...params }) -> Merge.PaginatedPurchaseOrderList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `PurchaseOrder` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.purchaseOrders.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.PurchaseOrdersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.purchaseOrders.create({ ...params }) -> Merge.PurchaseOrderResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `PurchaseOrder` object with the given values.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.purchaseOrders.create({
+ model: {},
+});
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.PurchaseOrderEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.PurchaseOrdersRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.PurchaseOrdersLineItemsRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.purchaseOrders.metaPostRetrieve() -> Merge.MetaResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `PurchaseOrder` POSTs.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.purchaseOrders.metaPostRetrieve();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `PurchaseOrders.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.accounting.purchaseOrders.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.purchaseOrders.remoteFieldClassesList();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.PurchaseOrdersRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrders.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:** `RegenerateKey.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting SyncStatus
+
+client.accounting.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.syncStatus.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.SyncStatusListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `SyncStatus.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting ForceResync
+
+client.accounting.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.forceResync.syncStatusResyncCreate();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `ForceResync.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting TaxRates
+
+client.accounting.taxRates.list({ ...params }) -> Merge.PaginatedTaxRateList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TaxRate` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.taxRates.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.TaxRatesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TaxRates.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.TaxRatesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TaxRates.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting TrackingCategories
+
+client.accounting.trackingCategories.list({ ...params }) -> Merge.PaginatedTrackingCategoryList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TrackingCategory` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.trackingCategories.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.TrackingCategoriesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TrackingCategories.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.TrackingCategoriesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `TrackingCategories.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting Transactions
+
+client.accounting.transactions.list({ ...params }) -> Merge.PaginatedTransactionList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Transaction` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.transactions.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.TransactionsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Transactions.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.TransactionsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `Transactions.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+## Accounting VendorCredits
+
+client.accounting.vendorCredits.list({ ...params }) -> Merge.PaginatedVendorCreditList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `VendorCredit` objects.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.vendorCredits.list();
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.VendorCreditsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `VendorCredits.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");
+```
+
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.VendorCreditsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `VendorCredits.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:** `WebhookReceivers.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:** `WebhookReceivers.RequestOptions`
+
+
+
+
+
+
+
+
+
diff --git a/src/Client.ts b/src/Client.ts
index f66caa1b0..a6eb15189 100644
--- a/src/Client.ts
+++ b/src/Client.ts
@@ -4,52 +4,55 @@
import * as environments from "./environments";
import * as core from "./core";
-import { Filestorage } from "./api/resources/filestorage/client/Client";
import { Ats } from "./api/resources/ats/client/Client";
+import { Filestorage } from "./api/resources/filestorage/client/Client";
import { Crm } from "./api/resources/crm/client/Client";
-import { Hris } from "./api/resources/hris/client/Client";
import { Ticketing } from "./api/resources/ticketing/client/Client";
+import { Hris } from "./api/resources/hris/client/Client";
import { Accounting } from "./api/resources/accounting/client/Client";
export declare namespace MergeClient {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
export class MergeClient {
constructor(protected readonly _options: MergeClient.Options) {}
- protected _filestorage: Filestorage | undefined;
-
- public get filestorage(): Filestorage {
- return (this._filestorage ??= new Filestorage(this._options));
- }
-
protected _ats: Ats | undefined;
public get ats(): Ats {
return (this._ats ??= new Ats(this._options));
}
- protected _crm: Crm | undefined;
+ protected _filestorage: Filestorage | undefined;
- public get crm(): Crm {
- return (this._crm ??= new Crm(this._options));
+ public get filestorage(): Filestorage {
+ return (this._filestorage ??= new Filestorage(this._options));
}
- protected _hris: Hris | undefined;
+ protected _crm: Crm | undefined;
- public get hris(): Hris {
- return (this._hris ??= new Hris(this._options));
+ public get crm(): Crm {
+ return (this._crm ??= new Crm(this._options));
}
protected _ticketing: Ticketing | undefined;
@@ -58,6 +61,12 @@ export class MergeClient {
return (this._ticketing ??= new Ticketing(this._options));
}
+ protected _hris: Hris | undefined;
+
+ public get hris(): Hris {
+ return (this._hris ??= new Hris(this._options));
+ }
+
protected _accounting: Accounting | undefined;
public get accounting(): Accounting {
diff --git a/src/api/resources/accounting/client/Client.ts b/src/api/resources/accounting/client/Client.ts
index 5622a138d..0574b9563 100644
--- a/src/api/resources/accounting/client/Client.ts
+++ b/src/api/resources/accounting/client/Client.ts
@@ -47,13 +47,22 @@ export declare namespace Accounting {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
diff --git a/src/api/resources/accounting/resources/accountDetails/client/Client.ts b/src/api/resources/accounting/resources/accountDetails/client/Client.ts
index 2223abf41..180cc5571 100644
--- a/src/api/resources/accounting/resources/accountDetails/client/Client.ts
+++ b/src/api/resources/accounting/resources/accountDetails/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace AccountDetails {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,10 @@ export class AccountDetails {
/**
* Get details for a linked account.
*
+ * @param {AccountDetails.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.accountDetails.retrieve()
+ * await client.accounting.accountDetails.retrieve()
*/
public async retrieve(requestOptions?: AccountDetails.RequestOptions): Promise {
const _response = await (this._options.fetcher ?? core.fetcher)({
@@ -47,14 +58,20 @@ export class AccountDetails {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.AccountDetails.parseOrThrow(_response.body, {
+ return serializers.accounting.AccountDetails.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -77,7 +94,7 @@ export class AccountDetails {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/account-details.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -85,7 +102,7 @@ export class AccountDetails {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/accountToken/client/Client.ts b/src/api/resources/accounting/resources/accountToken/client/Client.ts
index 8bc18c94b..39281ad20 100644
--- a/src/api/resources/accounting/resources/accountToken/client/Client.ts
+++ b/src/api/resources/accounting/resources/accountToken/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace AccountToken {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class AccountToken {
/**
* Returns the account token for the end user with the provided public token.
*
+ * @param {string} publicToken
+ * @param {AccountToken.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.accountToken.retrieve("public_token")
+ * await client.accounting.accountToken.retrieve("public_token")
*/
public async retrieve(
publicToken: string,
@@ -39,7 +51,7 @@ export class AccountToken {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/account-token/${publicToken}`
+ `accounting/v1/account-token/${encodeURIComponent(publicToken)}`
),
method: "GET",
headers: {
@@ -50,14 +62,20 @@ export class AccountToken {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.AccountToken.parseOrThrow(_response.body, {
+ return serializers.accounting.AccountToken.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -80,7 +98,9 @@ export class AccountToken {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/account-token/{public_token}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -88,7 +108,7 @@ export class AccountToken {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/accountingPeriods/client/Client.ts b/src/api/resources/accounting/resources/accountingPeriods/client/Client.ts
index 538fc9105..c56daa09c 100644
--- a/src/api/resources/accounting/resources/accountingPeriods/client/Client.ts
+++ b/src/api/resources/accounting/resources/accountingPeriods/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace AccountingPeriods {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,15 +38,18 @@ export class AccountingPeriods {
/**
* Returns a list of `AccountingPeriod` objects.
*
+ * @param {Merge.accounting.AccountingPeriodsListRequest} request
+ * @param {AccountingPeriods.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.accountingPeriods.list({})
+ * await client.accounting.accountingPeriods.list()
*/
public async list(
request: Merge.accounting.AccountingPeriodsListRequest = {},
requestOptions?: AccountingPeriods.RequestOptions
): Promise {
const { cursor, includeDeletedData, includeRemoteData, includeShellData, pageSize } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (cursor != null) {
_queryParams["cursor"] = cursor;
}
@@ -72,15 +84,21 @@ export class AccountingPeriods {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedAccountingPeriodList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedAccountingPeriodList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -103,7 +121,9 @@ export class AccountingPeriods {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/accounting-periods."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -114,8 +134,12 @@ export class AccountingPeriods {
/**
* Returns an `AccountingPeriod` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.AccountingPeriodsRetrieveRequest} request
+ * @param {AccountingPeriods.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.accountingPeriods.retrieve("id", {})
+ * await client.accounting.accountingPeriods.retrieve("id")
*/
public async retrieve(
id: string,
@@ -123,7 +147,7 @@ export class AccountingPeriods {
requestOptions?: AccountingPeriods.RequestOptions
): Promise {
const { includeRemoteData } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (includeRemoteData != null) {
_queryParams["include_remote_data"] = includeRemoteData.toString();
}
@@ -131,7 +155,7 @@ export class AccountingPeriods {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/accounting-periods/${id}`
+ `accounting/v1/accounting-periods/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -142,15 +166,21 @@ export class AccountingPeriods {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.AccountingPeriod.parseOrThrow(_response.body, {
+ return serializers.accounting.AccountingPeriod.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -173,7 +203,9 @@ export class AccountingPeriods {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/accounting-periods/{id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -181,7 +213,7 @@ export class AccountingPeriods {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/accountingPeriods/client/requests/index.ts b/src/api/resources/accounting/resources/accountingPeriods/client/requests/index.ts
index 51f2babae..37d63ca33 100644
--- a/src/api/resources/accounting/resources/accountingPeriods/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/accountingPeriods/client/requests/index.ts
@@ -1,2 +1,2 @@
-export { AccountingPeriodsListRequest } from "./AccountingPeriodsListRequest";
-export { AccountingPeriodsRetrieveRequest } from "./AccountingPeriodsRetrieveRequest";
+export { type AccountingPeriodsListRequest } from "./AccountingPeriodsListRequest";
+export { type AccountingPeriodsRetrieveRequest } from "./AccountingPeriodsRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/accounts/client/Client.ts b/src/api/resources/accounting/resources/accounts/client/Client.ts
index f96e8f91b..55c3115d0 100644
--- a/src/api/resources/accounting/resources/accounts/client/Client.ts
+++ b/src/api/resources/accounting/resources/accounts/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace Accounts {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class Accounts {
/**
* Returns a list of `Account` objects.
*
+ * @param {Merge.accounting.AccountsListRequest} request
+ * @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.accounts.list({})
+ * await client.accounting.accounts.list()
*/
public async list(
request: Merge.accounting.AccountsListRequest = {},
@@ -52,7 +64,7 @@ export class Accounts {
remoteId,
showEnumOrigins,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -123,15 +135,21 @@ export class Accounts {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedAccountList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedAccountList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -154,7 +172,7 @@ export class Accounts {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/accounts.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -165,8 +183,11 @@ export class Accounts {
/**
* Creates an `Account` object with the given values.
*
+ * @param {Merge.accounting.AccountEndpointRequest} request
+ * @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.accounts.create({
+ * await client.accounting.accounts.create({
* model: {}
* })
*/
@@ -175,7 +196,7 @@ export class Accounts {
requestOptions?: Accounts.RequestOptions
): Promise {
const { isDebugMode, runAsync, ..._body } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (isDebugMode != null) {
_queryParams["is_debug_mode"] = isDebugMode.toString();
}
@@ -198,18 +219,22 @@ export class Accounts {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
- body: await serializers.accounting.AccountEndpointRequest.jsonOrThrow(_body, {
- unrecognizedObjectKeys: "strip",
- }),
+ requestType: "json",
+ body: serializers.accounting.AccountEndpointRequest.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.AccountResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.AccountResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -232,7 +257,7 @@ export class Accounts {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling POST /accounting/v1/accounts.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -243,8 +268,12 @@ export class Accounts {
/**
* Returns an `Account` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.AccountsRetrieveRequest} request
+ * @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.accounts.retrieve("id", {})
+ * await client.accounting.accounts.retrieve("id")
*/
public async retrieve(
id: string,
@@ -252,7 +281,7 @@ export class Accounts {
requestOptions?: Accounts.RequestOptions
): Promise {
const { expand, includeRemoteData, remoteFields, showEnumOrigins } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -272,7 +301,7 @@ export class Accounts {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/accounts/${id}`
+ `accounting/v1/accounts/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -283,15 +312,21 @@ export class Accounts {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.Account.parseOrThrow(_response.body, {
+ return serializers.accounting.Account.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -314,7 +349,7 @@ export class Accounts {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/accounts/{id}.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -325,8 +360,10 @@ export class Accounts {
/**
* Returns metadata for `Account` POSTs.
*
+ * @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.accounts.metaPostRetrieve()
+ * await client.accounting.accounts.metaPostRetrieve()
*/
public async metaPostRetrieve(requestOptions?: Accounts.RequestOptions): Promise {
const _response = await (this._options.fetcher ?? core.fetcher)({
@@ -343,14 +380,20 @@ export class Accounts {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -373,7 +416,9 @@ export class Accounts {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/accounts/meta/post."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -381,7 +426,7 @@ export class Accounts {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/accounts/client/requests/AccountEndpointRequest.ts b/src/api/resources/accounting/resources/accounts/client/requests/AccountEndpointRequest.ts
index ba18bacf9..fa6cd6e9d 100644
--- a/src/api/resources/accounting/resources/accounts/client/requests/AccountEndpointRequest.ts
+++ b/src/api/resources/accounting/resources/accounts/client/requests/AccountEndpointRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/accounts/client/requests/AccountsListRequest.ts b/src/api/resources/accounting/resources/accounts/client/requests/AccountsListRequest.ts
index c2b923f5b..109176de7 100644
--- a/src/api/resources/accounting/resources/accounts/client/requests/AccountsListRequest.ts
+++ b/src/api/resources/accounting/resources/accounts/client/requests/AccountsListRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/accounts/client/requests/AccountsRetrieveRequest.ts b/src/api/resources/accounting/resources/accounts/client/requests/AccountsRetrieveRequest.ts
index 0521c1f59..a57620b48 100644
--- a/src/api/resources/accounting/resources/accounts/client/requests/AccountsRetrieveRequest.ts
+++ b/src/api/resources/accounting/resources/accounts/client/requests/AccountsRetrieveRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/accounts/client/requests/index.ts b/src/api/resources/accounting/resources/accounts/client/requests/index.ts
index adca0303a..447e5a665 100644
--- a/src/api/resources/accounting/resources/accounts/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/accounts/client/requests/index.ts
@@ -1,3 +1,3 @@
-export { AccountsListRequest } from "./AccountsListRequest";
-export { AccountEndpointRequest } from "./AccountEndpointRequest";
-export { AccountsRetrieveRequest } from "./AccountsRetrieveRequest";
+export { type AccountsListRequest } from "./AccountsListRequest";
+export { type AccountEndpointRequest } from "./AccountEndpointRequest";
+export { type AccountsRetrieveRequest } from "./AccountsRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/addresses/client/Client.ts b/src/api/resources/accounting/resources/addresses/client/Client.ts
index e99e2bd2c..a1e7f7aac 100644
--- a/src/api/resources/accounting/resources/addresses/client/Client.ts
+++ b/src/api/resources/accounting/resources/addresses/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace Addresses {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,12 @@ export class Addresses {
/**
* Returns an `Address` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.AddressesRetrieveRequest} request
+ * @param {Addresses.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.addresses.retrieve("id", {})
+ * await client.accounting.addresses.retrieve("id")
*/
public async retrieve(
id: string,
@@ -38,7 +51,7 @@ export class Addresses {
requestOptions?: Addresses.RequestOptions
): Promise {
const { includeRemoteData, remoteFields, showEnumOrigins } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (includeRemoteData != null) {
_queryParams["include_remote_data"] = includeRemoteData.toString();
}
@@ -54,7 +67,7 @@ export class Addresses {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/addresses/${id}`
+ `accounting/v1/addresses/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -65,15 +78,21 @@ export class Addresses {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.Address.parseOrThrow(_response.body, {
+ return serializers.accounting.Address.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -96,7 +115,7 @@ export class Addresses {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/addresses/{id}.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -104,7 +123,7 @@ export class Addresses {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/addresses/client/requests/index.ts b/src/api/resources/accounting/resources/addresses/client/requests/index.ts
index ff7eae4c9..a25ee5207 100644
--- a/src/api/resources/accounting/resources/addresses/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/addresses/client/requests/index.ts
@@ -1 +1 @@
-export { AddressesRetrieveRequest } from "./AddressesRetrieveRequest";
+export { type AddressesRetrieveRequest } from "./AddressesRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/asyncPassthrough/client/Client.ts b/src/api/resources/accounting/resources/asyncPassthrough/client/Client.ts
index 9810d0897..68014351b 100644
--- a/src/api/resources/accounting/resources/asyncPassthrough/client/Client.ts
+++ b/src/api/resources/accounting/resources/asyncPassthrough/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
-import * as serializers from "../../../../../../serialization";
+import * as Merge from "../../../../../index";
+import * as serializers from "../../../../../../serialization/index";
import urlJoin from "url-join";
-import * as errors from "../../../../../../errors";
+import * as errors from "../../../../../../errors/index";
export declare namespace AsyncPassthrough {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,9 +38,12 @@ export class AsyncPassthrough {
/**
* Asynchronously pull data from an endpoint not currently supported by Merge.
*
+ * @param {Merge.accounting.DataPassthroughRequest} request
+ * @param {AsyncPassthrough.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.asyncPassthrough.create({
- * method: Merge.accounting.MethodEnum.Get,
+ * await client.accounting.asyncPassthrough.create({
+ * method: "GET",
* path: "/scooters"
* })
*/
@@ -53,17 +65,23 @@ export class AsyncPassthrough {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
- body: await serializers.accounting.DataPassthroughRequest.jsonOrThrow(request, {
+ requestType: "json",
+ body: serializers.accounting.DataPassthroughRequest.jsonOrThrow(request, {
unrecognizedObjectKeys: "strip",
}),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.AsyncPassthroughReciept.parseOrThrow(_response.body, {
+ return serializers.accounting.AsyncPassthroughReciept.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -86,7 +104,9 @@ export class AsyncPassthrough {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling POST /accounting/v1/async-passthrough."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -96,6 +116,12 @@ export class AsyncPassthrough {
/**
* Retrieves data from earlier async-passthrough POST request
+ *
+ * @param {string} asyncPassthroughReceiptId
+ * @param {AsyncPassthrough.RequestOptions} requestOptions - Request-specific configuration.
+ *
+ * @example
+ * await client.accounting.asyncPassthrough.retrieve("async_passthrough_receipt_id")
*/
public async retrieve(
asyncPassthroughReceiptId: string,
@@ -104,7 +130,7 @@ export class AsyncPassthrough {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/async-passthrough/${asyncPassthroughReceiptId}`
+ `accounting/v1/async-passthrough/${encodeURIComponent(asyncPassthroughReceiptId)}`
),
method: "GET",
headers: {
@@ -115,14 +141,20 @@ export class AsyncPassthrough {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.AsyncPassthroughRetrieveResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.AsyncPassthroughRetrieveResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -145,7 +177,9 @@ export class AsyncPassthrough {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/async-passthrough/{async_passthrough_receipt_id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -153,7 +187,7 @@ export class AsyncPassthrough {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/asyncPassthrough/types/AsyncPassthroughRetrieveResponse.ts b/src/api/resources/accounting/resources/asyncPassthrough/types/AsyncPassthroughRetrieveResponse.ts
index 96f35a000..f5d6617ce 100644
--- a/src/api/resources/accounting/resources/asyncPassthrough/types/AsyncPassthroughRetrieveResponse.ts
+++ b/src/api/resources/accounting/resources/asyncPassthrough/types/AsyncPassthroughRetrieveResponse.ts
@@ -2,6 +2,6 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
export type AsyncPassthroughRetrieveResponse = Merge.accounting.RemoteResponse | string;
diff --git a/src/api/resources/accounting/resources/attachments/client/Client.ts b/src/api/resources/accounting/resources/attachments/client/Client.ts
index 3ded1a31a..fb8c523e9 100644
--- a/src/api/resources/accounting/resources/attachments/client/Client.ts
+++ b/src/api/resources/accounting/resources/attachments/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace Attachments {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class Attachments {
/**
* Returns a list of `AccountingAttachment` objects.
*
+ * @param {Merge.accounting.AttachmentsListRequest} request
+ * @param {Attachments.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.attachments.list({})
+ * await client.accounting.attachments.list()
*/
public async list(
request: Merge.accounting.AttachmentsListRequest = {},
@@ -49,7 +61,7 @@ export class Attachments {
pageSize,
remoteId,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -108,15 +120,21 @@ export class Attachments {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedAccountingAttachmentList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedAccountingAttachmentList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -139,7 +157,7 @@ export class Attachments {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/attachments.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -150,8 +168,11 @@ export class Attachments {
/**
* Creates an `AccountingAttachment` object with the given values.
*
+ * @param {Merge.accounting.AccountingAttachmentEndpointRequest} request
+ * @param {Attachments.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.attachments.create({
+ * await client.accounting.attachments.create({
* model: {}
* })
*/
@@ -160,7 +181,7 @@ export class Attachments {
requestOptions?: Attachments.RequestOptions
): Promise {
const { isDebugMode, runAsync, ..._body } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (isDebugMode != null) {
_queryParams["is_debug_mode"] = isDebugMode.toString();
}
@@ -183,18 +204,24 @@ export class Attachments {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
- body: await serializers.accounting.AccountingAttachmentEndpointRequest.jsonOrThrow(_body, {
+ requestType: "json",
+ body: serializers.accounting.AccountingAttachmentEndpointRequest.jsonOrThrow(_body, {
unrecognizedObjectKeys: "strip",
}),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.AccountingAttachmentResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.AccountingAttachmentResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -217,7 +244,7 @@ export class Attachments {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling POST /accounting/v1/attachments.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -228,8 +255,12 @@ export class Attachments {
/**
* Returns an `AccountingAttachment` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.AttachmentsRetrieveRequest} request
+ * @param {Attachments.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.attachments.retrieve("id", {})
+ * await client.accounting.attachments.retrieve("id")
*/
public async retrieve(
id: string,
@@ -237,7 +268,7 @@ export class Attachments {
requestOptions?: Attachments.RequestOptions
): Promise {
const { includeRemoteData } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (includeRemoteData != null) {
_queryParams["include_remote_data"] = includeRemoteData.toString();
}
@@ -245,7 +276,7 @@ export class Attachments {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/attachments/${id}`
+ `accounting/v1/attachments/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -256,15 +287,21 @@ export class Attachments {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.AccountingAttachment.parseOrThrow(_response.body, {
+ return serializers.accounting.AccountingAttachment.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -287,7 +324,9 @@ export class Attachments {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/attachments/{id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -298,8 +337,10 @@ export class Attachments {
/**
* Returns metadata for `AccountingAttachment` POSTs.
*
+ * @param {Attachments.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.attachments.metaPostRetrieve()
+ * await client.accounting.attachments.metaPostRetrieve()
*/
public async metaPostRetrieve(requestOptions?: Attachments.RequestOptions): Promise {
const _response = await (this._options.fetcher ?? core.fetcher)({
@@ -316,14 +357,20 @@ export class Attachments {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -346,7 +393,9 @@ export class Attachments {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/attachments/meta/post."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -354,7 +403,7 @@ export class Attachments {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/attachments/client/requests/AccountingAttachmentEndpointRequest.ts b/src/api/resources/accounting/resources/attachments/client/requests/AccountingAttachmentEndpointRequest.ts
index 685d0ebdb..5b706b836 100644
--- a/src/api/resources/accounting/resources/attachments/client/requests/AccountingAttachmentEndpointRequest.ts
+++ b/src/api/resources/accounting/resources/attachments/client/requests/AccountingAttachmentEndpointRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/attachments/client/requests/index.ts b/src/api/resources/accounting/resources/attachments/client/requests/index.ts
index c81d9ed55..51c069000 100644
--- a/src/api/resources/accounting/resources/attachments/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/attachments/client/requests/index.ts
@@ -1,3 +1,3 @@
-export { AttachmentsListRequest } from "./AttachmentsListRequest";
-export { AccountingAttachmentEndpointRequest } from "./AccountingAttachmentEndpointRequest";
-export { AttachmentsRetrieveRequest } from "./AttachmentsRetrieveRequest";
+export { type AttachmentsListRequest } from "./AttachmentsListRequest";
+export { type AccountingAttachmentEndpointRequest } from "./AccountingAttachmentEndpointRequest";
+export { type AttachmentsRetrieveRequest } from "./AttachmentsRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/auditTrail/client/Client.ts b/src/api/resources/accounting/resources/auditTrail/client/Client.ts
index 8d1f496a6..f2386b418 100644
--- a/src/api/resources/accounting/resources/auditTrail/client/Client.ts
+++ b/src/api/resources/accounting/resources/auditTrail/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace AuditTrail {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,15 +38,18 @@ export class AuditTrail {
/**
* Gets a list of audit trail events.
*
+ * @param {Merge.accounting.AuditTrailListRequest} request
+ * @param {AuditTrail.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.auditTrail.list({})
+ * await client.accounting.auditTrail.list()
*/
public async list(
request: Merge.accounting.AuditTrailListRequest = {},
requestOptions?: AuditTrail.RequestOptions
): Promise {
const { cursor, endDate, eventType, pageSize, startDate, userEmail } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (cursor != null) {
_queryParams["cursor"] = cursor;
}
@@ -76,15 +88,21 @@ export class AuditTrail {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedAuditLogEventList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedAuditLogEventList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -107,7 +125,7 @@ export class AuditTrail {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/audit-trail.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -115,7 +133,7 @@ export class AuditTrail {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/auditTrail/client/requests/index.ts b/src/api/resources/accounting/resources/auditTrail/client/requests/index.ts
index ddce9e786..2c0762c28 100644
--- a/src/api/resources/accounting/resources/auditTrail/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/auditTrail/client/requests/index.ts
@@ -1 +1 @@
-export { AuditTrailListRequest } from "./AuditTrailListRequest";
+export { type AuditTrailListRequest } from "./AuditTrailListRequest";
diff --git a/src/api/resources/accounting/resources/availableActions/client/Client.ts b/src/api/resources/accounting/resources/availableActions/client/Client.ts
index 3b867efd1..8e487b157 100644
--- a/src/api/resources/accounting/resources/availableActions/client/Client.ts
+++ b/src/api/resources/accounting/resources/availableActions/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace AvailableActions {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,10 @@ export class AvailableActions {
/**
* Returns a list of models and actions available for an account.
*
+ * @param {AvailableActions.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.availableActions.retrieve()
+ * await client.accounting.availableActions.retrieve()
*/
public async retrieve(
requestOptions?: AvailableActions.RequestOptions
@@ -49,14 +60,20 @@ export class AvailableActions {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.AvailableActions.parseOrThrow(_response.body, {
+ return serializers.accounting.AvailableActions.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -79,7 +96,9 @@ export class AvailableActions {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/available-actions."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -87,7 +106,7 @@ export class AvailableActions {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/balanceSheets/client/Client.ts b/src/api/resources/accounting/resources/balanceSheets/client/Client.ts
index 7fddd4e6d..f0390e675 100644
--- a/src/api/resources/accounting/resources/balanceSheets/client/Client.ts
+++ b/src/api/resources/accounting/resources/balanceSheets/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace BalanceSheets {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class BalanceSheets {
/**
* Returns a list of `BalanceSheet` objects.
*
+ * @param {Merge.accounting.BalanceSheetsListRequest} request
+ * @param {BalanceSheets.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.balanceSheets.list({})
+ * await client.accounting.balanceSheets.list()
*/
public async list(
request: Merge.accounting.BalanceSheetsListRequest = {},
@@ -50,7 +62,7 @@ export class BalanceSheets {
pageSize,
remoteId,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -113,15 +125,21 @@ export class BalanceSheets {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedBalanceSheetList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedBalanceSheetList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -144,7 +162,7 @@ export class BalanceSheets {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/balance-sheets.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -155,8 +173,12 @@ export class BalanceSheets {
/**
* Returns a `BalanceSheet` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.BalanceSheetsRetrieveRequest} request
+ * @param {BalanceSheets.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.balanceSheets.retrieve("id", {})
+ * await client.accounting.balanceSheets.retrieve("id")
*/
public async retrieve(
id: string,
@@ -164,7 +186,7 @@ export class BalanceSheets {
requestOptions?: BalanceSheets.RequestOptions
): Promise {
const { expand, includeRemoteData } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -176,7 +198,7 @@ export class BalanceSheets {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/balance-sheets/${id}`
+ `accounting/v1/balance-sheets/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -187,15 +209,21 @@ export class BalanceSheets {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.BalanceSheet.parseOrThrow(_response.body, {
+ return serializers.accounting.BalanceSheet.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -218,7 +246,9 @@ export class BalanceSheets {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/balance-sheets/{id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -226,7 +256,7 @@ export class BalanceSheets {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/balanceSheets/client/requests/index.ts b/src/api/resources/accounting/resources/balanceSheets/client/requests/index.ts
index 225f90d94..e6cae1ae7 100644
--- a/src/api/resources/accounting/resources/balanceSheets/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/balanceSheets/client/requests/index.ts
@@ -1,2 +1,2 @@
-export { BalanceSheetsListRequest } from "./BalanceSheetsListRequest";
-export { BalanceSheetsRetrieveRequest } from "./BalanceSheetsRetrieveRequest";
+export { type BalanceSheetsListRequest } from "./BalanceSheetsListRequest";
+export { type BalanceSheetsRetrieveRequest } from "./BalanceSheetsRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/cashFlowStatements/client/Client.ts b/src/api/resources/accounting/resources/cashFlowStatements/client/Client.ts
index 356b43aa0..78c3efe22 100644
--- a/src/api/resources/accounting/resources/cashFlowStatements/client/Client.ts
+++ b/src/api/resources/accounting/resources/cashFlowStatements/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace CashFlowStatements {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class CashFlowStatements {
/**
* Returns a list of `CashFlowStatement` objects.
*
+ * @param {Merge.accounting.CashFlowStatementsListRequest} request
+ * @param {CashFlowStatements.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.cashFlowStatements.list({})
+ * await client.accounting.cashFlowStatements.list()
*/
public async list(
request: Merge.accounting.CashFlowStatementsListRequest = {},
@@ -50,7 +62,7 @@ export class CashFlowStatements {
pageSize,
remoteId,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -113,15 +125,21 @@ export class CashFlowStatements {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedCashFlowStatementList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedCashFlowStatementList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -144,7 +162,9 @@ export class CashFlowStatements {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/cash-flow-statements."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -155,8 +175,12 @@ export class CashFlowStatements {
/**
* Returns a `CashFlowStatement` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.CashFlowStatementsRetrieveRequest} request
+ * @param {CashFlowStatements.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.cashFlowStatements.retrieve("id", {})
+ * await client.accounting.cashFlowStatements.retrieve("id")
*/
public async retrieve(
id: string,
@@ -164,7 +188,7 @@ export class CashFlowStatements {
requestOptions?: CashFlowStatements.RequestOptions
): Promise {
const { expand, includeRemoteData } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -176,7 +200,7 @@ export class CashFlowStatements {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/cash-flow-statements/${id}`
+ `accounting/v1/cash-flow-statements/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -187,15 +211,21 @@ export class CashFlowStatements {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.CashFlowStatement.parseOrThrow(_response.body, {
+ return serializers.accounting.CashFlowStatement.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -218,7 +248,9 @@ export class CashFlowStatements {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/cash-flow-statements/{id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -226,7 +258,7 @@ export class CashFlowStatements {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/cashFlowStatements/client/requests/index.ts b/src/api/resources/accounting/resources/cashFlowStatements/client/requests/index.ts
index b94e5785b..4a17c2c4b 100644
--- a/src/api/resources/accounting/resources/cashFlowStatements/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/cashFlowStatements/client/requests/index.ts
@@ -1,2 +1,2 @@
-export { CashFlowStatementsListRequest } from "./CashFlowStatementsListRequest";
-export { CashFlowStatementsRetrieveRequest } from "./CashFlowStatementsRetrieveRequest";
+export { type CashFlowStatementsListRequest } from "./CashFlowStatementsListRequest";
+export { type CashFlowStatementsRetrieveRequest } from "./CashFlowStatementsRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/companyInfo/client/Client.ts b/src/api/resources/accounting/resources/companyInfo/client/Client.ts
index fe4a62059..53d594bb0 100644
--- a/src/api/resources/accounting/resources/companyInfo/client/Client.ts
+++ b/src/api/resources/accounting/resources/companyInfo/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace CompanyInfo {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class CompanyInfo {
/**
* Returns a list of `CompanyInfo` objects.
*
+ * @param {Merge.accounting.CompanyInfoListRequest} request
+ * @param {CompanyInfo.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.companyInfo.list({})
+ * await client.accounting.companyInfo.list()
*/
public async list(
request: Merge.accounting.CompanyInfoListRequest = {},
@@ -49,7 +61,7 @@ export class CompanyInfo {
pageSize,
remoteId,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (createdAfter != null) {
_queryParams["created_after"] = createdAfter.toISOString();
}
@@ -108,15 +120,21 @@ export class CompanyInfo {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedCompanyInfoList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedCompanyInfoList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -139,7 +157,7 @@ export class CompanyInfo {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/company-info.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -150,8 +168,12 @@ export class CompanyInfo {
/**
* Returns a `CompanyInfo` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.CompanyInfoRetrieveRequest} request
+ * @param {CompanyInfo.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.companyInfo.retrieve("id", {})
+ * await client.accounting.companyInfo.retrieve("id")
*/
public async retrieve(
id: string,
@@ -159,7 +181,7 @@ export class CompanyInfo {
requestOptions?: CompanyInfo.RequestOptions
): Promise {
const { expand, includeRemoteData } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -171,7 +193,7 @@ export class CompanyInfo {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/company-info/${id}`
+ `accounting/v1/company-info/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -182,15 +204,21 @@ export class CompanyInfo {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.CompanyInfo.parseOrThrow(_response.body, {
+ return serializers.accounting.CompanyInfo.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -213,7 +241,9 @@ export class CompanyInfo {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/company-info/{id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -221,7 +251,7 @@ export class CompanyInfo {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/companyInfo/client/requests/CompanyInfoListRequest.ts b/src/api/resources/accounting/resources/companyInfo/client/requests/CompanyInfoListRequest.ts
index e8a41d9e5..4aa5007d0 100644
--- a/src/api/resources/accounting/resources/companyInfo/client/requests/CompanyInfoListRequest.ts
+++ b/src/api/resources/accounting/resources/companyInfo/client/requests/CompanyInfoListRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/companyInfo/client/requests/CompanyInfoRetrieveRequest.ts b/src/api/resources/accounting/resources/companyInfo/client/requests/CompanyInfoRetrieveRequest.ts
index 474c09155..49603e7cc 100644
--- a/src/api/resources/accounting/resources/companyInfo/client/requests/CompanyInfoRetrieveRequest.ts
+++ b/src/api/resources/accounting/resources/companyInfo/client/requests/CompanyInfoRetrieveRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/companyInfo/client/requests/index.ts b/src/api/resources/accounting/resources/companyInfo/client/requests/index.ts
index 7f5ada766..5ef809e57 100644
--- a/src/api/resources/accounting/resources/companyInfo/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/companyInfo/client/requests/index.ts
@@ -1,2 +1,2 @@
-export { CompanyInfoListRequest } from "./CompanyInfoListRequest";
-export { CompanyInfoRetrieveRequest } from "./CompanyInfoRetrieveRequest";
+export { type CompanyInfoListRequest } from "./CompanyInfoListRequest";
+export { type CompanyInfoRetrieveRequest } from "./CompanyInfoRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/contacts/client/Client.ts b/src/api/resources/accounting/resources/contacts/client/Client.ts
index 220283ce9..80db65658 100644
--- a/src/api/resources/accounting/resources/contacts/client/Client.ts
+++ b/src/api/resources/accounting/resources/contacts/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace Contacts {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class Contacts {
/**
* Returns a list of `Contact` objects.
*
+ * @param {Merge.accounting.ContactsListRequest} request
+ * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.contacts.list({})
+ * await client.accounting.contacts.list()
*/
public async list(
request: Merge.accounting.ContactsListRequest = {},
@@ -55,7 +67,7 @@ export class Contacts {
remoteId,
showEnumOrigins,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -138,15 +150,21 @@ export class Contacts {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedContactList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedContactList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -169,7 +187,7 @@ export class Contacts {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/contacts.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -180,8 +198,11 @@ export class Contacts {
/**
* Creates a `Contact` object with the given values.
*
+ * @param {Merge.accounting.ContactEndpointRequest} request
+ * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.contacts.create({
+ * await client.accounting.contacts.create({
* model: {}
* })
*/
@@ -190,7 +211,7 @@ export class Contacts {
requestOptions?: Contacts.RequestOptions
): Promise {
const { isDebugMode, runAsync, ..._body } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (isDebugMode != null) {
_queryParams["is_debug_mode"] = isDebugMode.toString();
}
@@ -213,18 +234,22 @@ export class Contacts {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
- body: await serializers.accounting.ContactEndpointRequest.jsonOrThrow(_body, {
- unrecognizedObjectKeys: "strip",
- }),
+ requestType: "json",
+ body: serializers.accounting.ContactEndpointRequest.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.ContactResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.ContactResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -247,7 +272,7 @@ export class Contacts {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling POST /accounting/v1/contacts.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -258,8 +283,12 @@ export class Contacts {
/**
* Returns a `Contact` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.ContactsRetrieveRequest} request
+ * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.contacts.retrieve("id", {})
+ * await client.accounting.contacts.retrieve("id")
*/
public async retrieve(
id: string,
@@ -267,7 +296,7 @@ export class Contacts {
requestOptions?: Contacts.RequestOptions
): Promise {
const { expand, includeRemoteData, includeRemoteFields, remoteFields, showEnumOrigins } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -291,7 +320,7 @@ export class Contacts {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/contacts/${id}`
+ `accounting/v1/contacts/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -302,15 +331,21 @@ export class Contacts {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.Contact.parseOrThrow(_response.body, {
+ return serializers.accounting.Contact.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -333,7 +368,7 @@ export class Contacts {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/contacts/{id}.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -344,8 +379,10 @@ export class Contacts {
/**
* Returns metadata for `Contact` POSTs.
*
+ * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.contacts.metaPostRetrieve()
+ * await client.accounting.contacts.metaPostRetrieve()
*/
public async metaPostRetrieve(requestOptions?: Contacts.RequestOptions): Promise {
const _response = await (this._options.fetcher ?? core.fetcher)({
@@ -362,14 +399,20 @@ export class Contacts {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -392,7 +435,9 @@ export class Contacts {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/contacts/meta/post."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -403,8 +448,11 @@ export class Contacts {
/**
* Returns a list of `RemoteFieldClass` objects.
*
+ * @param {Merge.accounting.ContactsRemoteFieldClassesListRequest} request
+ * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.contacts.remoteFieldClassesList({})
+ * await client.accounting.contacts.remoteFieldClassesList()
*/
public async remoteFieldClassesList(
request: Merge.accounting.ContactsRemoteFieldClassesListRequest = {},
@@ -412,7 +460,7 @@ export class Contacts {
): Promise {
const { cursor, includeDeletedData, includeRemoteData, includeShellData, isCommonModelField, pageSize } =
request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (cursor != null) {
_queryParams["cursor"] = cursor;
}
@@ -451,15 +499,21 @@ export class Contacts {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -482,7 +536,9 @@ export class Contacts {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/contacts/remote-field-classes."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -490,7 +546,7 @@ export class Contacts {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/contacts/client/requests/ContactEndpointRequest.ts b/src/api/resources/accounting/resources/contacts/client/requests/ContactEndpointRequest.ts
index eba7b1e3c..130bb61d7 100644
--- a/src/api/resources/accounting/resources/contacts/client/requests/ContactEndpointRequest.ts
+++ b/src/api/resources/accounting/resources/contacts/client/requests/ContactEndpointRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/contacts/client/requests/ContactsListRequest.ts b/src/api/resources/accounting/resources/contacts/client/requests/ContactsListRequest.ts
index 99de8f4ee..45554bece 100644
--- a/src/api/resources/accounting/resources/contacts/client/requests/ContactsListRequest.ts
+++ b/src/api/resources/accounting/resources/contacts/client/requests/ContactsListRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/contacts/client/requests/ContactsRetrieveRequest.ts b/src/api/resources/accounting/resources/contacts/client/requests/ContactsRetrieveRequest.ts
index cb37c046a..257eb5479 100644
--- a/src/api/resources/accounting/resources/contacts/client/requests/ContactsRetrieveRequest.ts
+++ b/src/api/resources/accounting/resources/contacts/client/requests/ContactsRetrieveRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/contacts/client/requests/index.ts b/src/api/resources/accounting/resources/contacts/client/requests/index.ts
index d21badab7..33ecbec66 100644
--- a/src/api/resources/accounting/resources/contacts/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/contacts/client/requests/index.ts
@@ -1,4 +1,4 @@
-export { ContactsListRequest } from "./ContactsListRequest";
-export { ContactEndpointRequest } from "./ContactEndpointRequest";
-export { ContactsRetrieveRequest } from "./ContactsRetrieveRequest";
-export { ContactsRemoteFieldClassesListRequest } from "./ContactsRemoteFieldClassesListRequest";
+export { type ContactsListRequest } from "./ContactsListRequest";
+export { type ContactEndpointRequest } from "./ContactEndpointRequest";
+export { type ContactsRetrieveRequest } from "./ContactsRetrieveRequest";
+export { type ContactsRemoteFieldClassesListRequest } from "./ContactsRemoteFieldClassesListRequest";
diff --git a/src/api/resources/accounting/resources/creditNotes/client/Client.ts b/src/api/resources/accounting/resources/creditNotes/client/Client.ts
index 299442607..e69825c96 100644
--- a/src/api/resources/accounting/resources/creditNotes/client/Client.ts
+++ b/src/api/resources/accounting/resources/creditNotes/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace CreditNotes {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class CreditNotes {
/**
* Returns a list of `CreditNote` objects.
*
+ * @param {Merge.accounting.CreditNotesListRequest} request
+ * @param {CreditNotes.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.creditNotes.list({})
+ * await client.accounting.creditNotes.list()
*/
public async list(
request: Merge.accounting.CreditNotesListRequest = {},
@@ -54,7 +66,7 @@ export class CreditNotes {
transactionDateAfter,
transactionDateBefore,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -133,15 +145,21 @@ export class CreditNotes {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedCreditNoteList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedCreditNoteList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -164,7 +182,7 @@ export class CreditNotes {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/credit-notes.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -175,8 +193,12 @@ export class CreditNotes {
/**
* Returns a `CreditNote` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.CreditNotesRetrieveRequest} request
+ * @param {CreditNotes.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.creditNotes.retrieve("id", {})
+ * await client.accounting.creditNotes.retrieve("id")
*/
public async retrieve(
id: string,
@@ -184,7 +206,7 @@ export class CreditNotes {
requestOptions?: CreditNotes.RequestOptions
): Promise {
const { expand, includeRemoteData, remoteFields, showEnumOrigins } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -204,7 +226,7 @@ export class CreditNotes {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/credit-notes/${id}`
+ `accounting/v1/credit-notes/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -215,15 +237,21 @@ export class CreditNotes {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.CreditNote.parseOrThrow(_response.body, {
+ return serializers.accounting.CreditNote.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -246,7 +274,9 @@ export class CreditNotes {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/credit-notes/{id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -254,7 +284,7 @@ export class CreditNotes {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/creditNotes/client/requests/CreditNotesListRequest.ts b/src/api/resources/accounting/resources/creditNotes/client/requests/CreditNotesListRequest.ts
index 4b1d3310e..57456f2ac 100644
--- a/src/api/resources/accounting/resources/creditNotes/client/requests/CreditNotesListRequest.ts
+++ b/src/api/resources/accounting/resources/creditNotes/client/requests/CreditNotesListRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/creditNotes/client/requests/CreditNotesRetrieveRequest.ts b/src/api/resources/accounting/resources/creditNotes/client/requests/CreditNotesRetrieveRequest.ts
index faf431feb..4fcddcf5d 100644
--- a/src/api/resources/accounting/resources/creditNotes/client/requests/CreditNotesRetrieveRequest.ts
+++ b/src/api/resources/accounting/resources/creditNotes/client/requests/CreditNotesRetrieveRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/creditNotes/client/requests/index.ts b/src/api/resources/accounting/resources/creditNotes/client/requests/index.ts
index b7f86b0da..349f24e30 100644
--- a/src/api/resources/accounting/resources/creditNotes/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/creditNotes/client/requests/index.ts
@@ -1,2 +1,2 @@
-export { CreditNotesListRequest } from "./CreditNotesListRequest";
-export { CreditNotesRetrieveRequest } from "./CreditNotesRetrieveRequest";
+export { type CreditNotesListRequest } from "./CreditNotesListRequest";
+export { type CreditNotesRetrieveRequest } from "./CreditNotesRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/deleteAccount/client/Client.ts b/src/api/resources/accounting/resources/deleteAccount/client/Client.ts
index d83d118dc..71cc8e1e2 100644
--- a/src/api/resources/accounting/resources/deleteAccount/client/Client.ts
+++ b/src/api/resources/accounting/resources/deleteAccount/client/Client.ts
@@ -5,19 +5,28 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
import urlJoin from "url-join";
-import * as errors from "../../../../../../errors";
+import * as errors from "../../../../../../errors/index";
export declare namespace DeleteAccount {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -27,8 +36,10 @@ export class DeleteAccount {
/**
* Delete a linked account.
*
+ * @param {DeleteAccount.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.deleteAccount.delete()
+ * await client.accounting.deleteAccount.delete()
*/
public async delete(requestOptions?: DeleteAccount.RequestOptions): Promise {
const _response = await (this._options.fetcher ?? core.fetcher)({
@@ -45,11 +56,17 @@ export class DeleteAccount {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
return;
@@ -69,7 +86,7 @@ export class DeleteAccount {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling POST /accounting/v1/delete-account.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -77,7 +94,7 @@ export class DeleteAccount {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/expenses/client/Client.ts b/src/api/resources/accounting/resources/expenses/client/Client.ts
index 6a0bccbec..692ff4c72 100644
--- a/src/api/resources/accounting/resources/expenses/client/Client.ts
+++ b/src/api/resources/accounting/resources/expenses/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace Expenses {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class Expenses {
/**
* Returns a list of `Expense` objects.
*
+ * @param {Merge.accounting.ExpensesListRequest} request
+ * @param {Expenses.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.expenses.list({})
+ * await client.accounting.expenses.list()
*/
public async list(
request: Merge.accounting.ExpensesListRequest = {},
@@ -53,7 +65,7 @@ export class Expenses {
transactionDateAfter,
transactionDateBefore,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -128,15 +140,21 @@ export class Expenses {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedExpenseList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedExpenseList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -159,7 +177,7 @@ export class Expenses {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/expenses.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -170,8 +188,11 @@ export class Expenses {
/**
* Creates an `Expense` object with the given values.
*
+ * @param {Merge.accounting.ExpenseEndpointRequest} request
+ * @param {Expenses.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.expenses.create({
+ * await client.accounting.expenses.create({
* model: {}
* })
*/
@@ -180,7 +201,7 @@ export class Expenses {
requestOptions?: Expenses.RequestOptions
): Promise {
const { isDebugMode, runAsync, ..._body } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (isDebugMode != null) {
_queryParams["is_debug_mode"] = isDebugMode.toString();
}
@@ -203,18 +224,22 @@ export class Expenses {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
- body: await serializers.accounting.ExpenseEndpointRequest.jsonOrThrow(_body, {
- unrecognizedObjectKeys: "strip",
- }),
+ requestType: "json",
+ body: serializers.accounting.ExpenseEndpointRequest.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.ExpenseResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.ExpenseResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -237,7 +262,7 @@ export class Expenses {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling POST /accounting/v1/expenses.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -248,8 +273,12 @@ export class Expenses {
/**
* Returns an `Expense` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.ExpensesRetrieveRequest} request
+ * @param {Expenses.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.expenses.retrieve("id", {})
+ * await client.accounting.expenses.retrieve("id")
*/
public async retrieve(
id: string,
@@ -257,7 +286,7 @@ export class Expenses {
requestOptions?: Expenses.RequestOptions
): Promise {
const { expand, includeRemoteData, includeRemoteFields } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -273,7 +302,7 @@ export class Expenses {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/expenses/${id}`
+ `accounting/v1/expenses/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -284,15 +313,21 @@ export class Expenses {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.Expense.parseOrThrow(_response.body, {
+ return serializers.accounting.Expense.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -315,7 +350,7 @@ export class Expenses {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/expenses/{id}.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -326,8 +361,11 @@ export class Expenses {
/**
* Returns a list of `RemoteFieldClass` objects.
*
+ * @param {Merge.accounting.ExpensesLinesRemoteFieldClassesListRequest} request
+ * @param {Expenses.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.expenses.linesRemoteFieldClassesList({})
+ * await client.accounting.expenses.linesRemoteFieldClassesList()
*/
public async linesRemoteFieldClassesList(
request: Merge.accounting.ExpensesLinesRemoteFieldClassesListRequest = {},
@@ -335,7 +373,7 @@ export class Expenses {
): Promise {
const { cursor, includeDeletedData, includeRemoteData, includeShellData, isCommonModelField, pageSize } =
request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (cursor != null) {
_queryParams["cursor"] = cursor;
}
@@ -374,15 +412,21 @@ export class Expenses {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -405,7 +449,9 @@ export class Expenses {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/expenses/lines/remote-field-classes."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -416,8 +462,10 @@ export class Expenses {
/**
* Returns metadata for `Expense` POSTs.
*
+ * @param {Expenses.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.expenses.metaPostRetrieve()
+ * await client.accounting.expenses.metaPostRetrieve()
*/
public async metaPostRetrieve(requestOptions?: Expenses.RequestOptions): Promise {
const _response = await (this._options.fetcher ?? core.fetcher)({
@@ -434,14 +482,20 @@ export class Expenses {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -464,7 +518,9 @@ export class Expenses {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/expenses/meta/post."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -475,8 +531,11 @@ export class Expenses {
/**
* Returns a list of `RemoteFieldClass` objects.
*
+ * @param {Merge.accounting.ExpensesRemoteFieldClassesListRequest} request
+ * @param {Expenses.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.expenses.remoteFieldClassesList({})
+ * await client.accounting.expenses.remoteFieldClassesList()
*/
public async remoteFieldClassesList(
request: Merge.accounting.ExpensesRemoteFieldClassesListRequest = {},
@@ -484,7 +543,7 @@ export class Expenses {
): Promise {
const { cursor, includeDeletedData, includeRemoteData, includeShellData, isCommonModelField, pageSize } =
request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (cursor != null) {
_queryParams["cursor"] = cursor;
}
@@ -523,15 +582,21 @@ export class Expenses {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -554,7 +619,9 @@ export class Expenses {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/expenses/remote-field-classes."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -562,7 +629,7 @@ export class Expenses {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/expenses/client/requests/ExpenseEndpointRequest.ts b/src/api/resources/accounting/resources/expenses/client/requests/ExpenseEndpointRequest.ts
index c3c733c49..026f23a62 100644
--- a/src/api/resources/accounting/resources/expenses/client/requests/ExpenseEndpointRequest.ts
+++ b/src/api/resources/accounting/resources/expenses/client/requests/ExpenseEndpointRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/expenses/client/requests/ExpensesListRequest.ts b/src/api/resources/accounting/resources/expenses/client/requests/ExpensesListRequest.ts
index f28c0b0ce..2084272bd 100644
--- a/src/api/resources/accounting/resources/expenses/client/requests/ExpensesListRequest.ts
+++ b/src/api/resources/accounting/resources/expenses/client/requests/ExpensesListRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/expenses/client/requests/ExpensesRetrieveRequest.ts b/src/api/resources/accounting/resources/expenses/client/requests/ExpensesRetrieveRequest.ts
index 613b4b1d9..aef07eb0e 100644
--- a/src/api/resources/accounting/resources/expenses/client/requests/ExpensesRetrieveRequest.ts
+++ b/src/api/resources/accounting/resources/expenses/client/requests/ExpensesRetrieveRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/expenses/client/requests/index.ts b/src/api/resources/accounting/resources/expenses/client/requests/index.ts
index 537ad4e87..fb7909348 100644
--- a/src/api/resources/accounting/resources/expenses/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/expenses/client/requests/index.ts
@@ -1,5 +1,5 @@
-export { ExpensesListRequest } from "./ExpensesListRequest";
-export { ExpenseEndpointRequest } from "./ExpenseEndpointRequest";
-export { ExpensesRetrieveRequest } from "./ExpensesRetrieveRequest";
-export { ExpensesLinesRemoteFieldClassesListRequest } from "./ExpensesLinesRemoteFieldClassesListRequest";
-export { ExpensesRemoteFieldClassesListRequest } from "./ExpensesRemoteFieldClassesListRequest";
+export { type ExpensesListRequest } from "./ExpensesListRequest";
+export { type ExpenseEndpointRequest } from "./ExpenseEndpointRequest";
+export { type ExpensesRetrieveRequest } from "./ExpensesRetrieveRequest";
+export { type ExpensesLinesRemoteFieldClassesListRequest } from "./ExpensesLinesRemoteFieldClassesListRequest";
+export { type ExpensesRemoteFieldClassesListRequest } from "./ExpensesRemoteFieldClassesListRequest";
diff --git a/src/api/resources/accounting/resources/fieldMapping/client/Client.ts b/src/api/resources/accounting/resources/fieldMapping/client/Client.ts
index 017699a2d..a1e25591a 100644
--- a/src/api/resources/accounting/resources/fieldMapping/client/Client.ts
+++ b/src/api/resources/accounting/resources/fieldMapping/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace FieldMapping {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,10 @@ export class FieldMapping {
/**
* 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/).
*
+ * @param {FieldMapping.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.fieldMapping.fieldMappingsRetrieve()
+ * await client.accounting.fieldMapping.fieldMappingsRetrieve()
*/
public async fieldMappingsRetrieve(
requestOptions?: FieldMapping.RequestOptions
@@ -49,14 +60,20 @@ export class FieldMapping {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.FieldMappingApiInstanceResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.FieldMappingApiInstanceResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -79,7 +96,7 @@ export class FieldMapping {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/field-mappings.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -90,8 +107,11 @@ export class FieldMapping {
/**
* 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.
*
+ * @param {Merge.accounting.CreateFieldMappingRequest} request
+ * @param {FieldMapping.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.fieldMapping.fieldMappingsCreate({
+ * await client.accounting.fieldMapping.fieldMappingsCreate({
* targetFieldName: "example_target_field_name",
* targetFieldDescription: "this is a example description of the target field",
* remoteFieldTraversalPath: ["example_remote_field"],
@@ -118,17 +138,23 @@ export class FieldMapping {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
- body: await serializers.accounting.CreateFieldMappingRequest.jsonOrThrow(request, {
+ requestType: "json",
+ body: serializers.accounting.CreateFieldMappingRequest.jsonOrThrow(request, {
unrecognizedObjectKeys: "strip",
}),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.FieldMappingInstanceResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.FieldMappingInstanceResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -151,7 +177,7 @@ export class FieldMapping {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling POST /accounting/v1/field-mappings.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -162,8 +188,11 @@ export class FieldMapping {
/**
* 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.
*
+ * @param {string} fieldMappingId
+ * @param {FieldMapping.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.fieldMapping.fieldMappingsDestroy("field_mapping_id")
+ * await client.accounting.fieldMapping.fieldMappingsDestroy("field_mapping_id")
*/
public async fieldMappingsDestroy(
fieldMappingId: string,
@@ -172,7 +201,7 @@ export class FieldMapping {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/field-mappings/${fieldMappingId}`
+ `accounting/v1/field-mappings/${encodeURIComponent(fieldMappingId)}`
),
method: "DELETE",
headers: {
@@ -183,14 +212,20 @@ export class FieldMapping {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.FieldMappingInstanceResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.FieldMappingInstanceResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -213,7 +248,9 @@ export class FieldMapping {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling DELETE /accounting/v1/field-mappings/{field_mapping_id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -224,8 +261,12 @@ export class FieldMapping {
/**
* 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.
*
+ * @param {string} fieldMappingId
+ * @param {Merge.accounting.PatchedEditFieldMappingRequest} request
+ * @param {FieldMapping.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", {})
+ * await client.accounting.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id")
*/
public async fieldMappingsPartialUpdate(
fieldMappingId: string,
@@ -235,7 +276,7 @@ export class FieldMapping {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/field-mappings/${fieldMappingId}`
+ `accounting/v1/field-mappings/${encodeURIComponent(fieldMappingId)}`
),
method: "PATCH",
headers: {
@@ -246,17 +287,23 @@ export class FieldMapping {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
- body: await serializers.accounting.PatchedEditFieldMappingRequest.jsonOrThrow(request, {
+ requestType: "json",
+ body: serializers.accounting.PatchedEditFieldMappingRequest.jsonOrThrow(request, {
unrecognizedObjectKeys: "strip",
}),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.FieldMappingInstanceResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.FieldMappingInstanceResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -279,7 +326,9 @@ export class FieldMapping {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling PATCH /accounting/v1/field-mappings/{field_mapping_id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -290,15 +339,18 @@ export class FieldMapping {
/**
* 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/).
*
+ * @param {Merge.accounting.RemoteFieldsRetrieveRequest} request
+ * @param {FieldMapping.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.fieldMapping.remoteFieldsRetrieve({})
+ * await client.accounting.fieldMapping.remoteFieldsRetrieve()
*/
public async remoteFieldsRetrieve(
request: Merge.accounting.RemoteFieldsRetrieveRequest = {},
requestOptions?: FieldMapping.RequestOptions
): Promise {
const { commonModels, includeExampleValues } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (commonModels != null) {
_queryParams["common_models"] = commonModels;
}
@@ -321,15 +373,21 @@ export class FieldMapping {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.RemoteFieldApiResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.RemoteFieldApiResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -352,7 +410,7 @@ export class FieldMapping {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/remote-fields.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -363,8 +421,10 @@ export class FieldMapping {
/**
* 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/).
*
+ * @param {FieldMapping.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.fieldMapping.targetFieldsRetrieve()
+ * await client.accounting.fieldMapping.targetFieldsRetrieve()
*/
public async targetFieldsRetrieve(
requestOptions?: FieldMapping.RequestOptions
@@ -383,14 +443,20 @@ export class FieldMapping {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.ExternalTargetFieldApiResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.ExternalTargetFieldApiResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -413,7 +479,7 @@ export class FieldMapping {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/target-fields.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -421,7 +487,7 @@ export class FieldMapping {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/fieldMapping/client/requests/index.ts b/src/api/resources/accounting/resources/fieldMapping/client/requests/index.ts
index cb93982a7..450f54c2b 100644
--- a/src/api/resources/accounting/resources/fieldMapping/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/fieldMapping/client/requests/index.ts
@@ -1,3 +1,3 @@
-export { CreateFieldMappingRequest } from "./CreateFieldMappingRequest";
-export { PatchedEditFieldMappingRequest } from "./PatchedEditFieldMappingRequest";
-export { RemoteFieldsRetrieveRequest } from "./RemoteFieldsRetrieveRequest";
+export { type CreateFieldMappingRequest } from "./CreateFieldMappingRequest";
+export { type PatchedEditFieldMappingRequest } from "./PatchedEditFieldMappingRequest";
+export { type RemoteFieldsRetrieveRequest } from "./RemoteFieldsRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/forceResync/client/Client.ts b/src/api/resources/accounting/resources/forceResync/client/Client.ts
index bf342c3c2..37c5d8dd0 100644
--- a/src/api/resources/accounting/resources/forceResync/client/Client.ts
+++ b/src/api/resources/accounting/resources/forceResync/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace ForceResync {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,10 @@ export class ForceResync {
/**
* Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API 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.
*
+ * @param {ForceResync.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.forceResync.syncStatusResyncCreate()
+ * await client.accounting.forceResync.syncStatusResyncCreate()
*/
public async syncStatusResyncCreate(
requestOptions?: ForceResync.RequestOptions
@@ -49,23 +60,26 @@ export class ForceResync {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.forceResync.syncStatusResyncCreate.Response.parseOrThrow(
- _response.body,
- {
- unrecognizedObjectKeys: "passthrough",
- allowUnrecognizedUnionMembers: true,
- allowUnrecognizedEnumValues: true,
- skipValidation: true,
- breadcrumbsPrefix: ["response"],
- }
- );
+ return serializers.accounting.forceResync.syncStatusResyncCreate.Response.parseOrThrow(_response.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ });
}
if (_response.error.reason === "status-code") {
@@ -82,7 +96,9 @@ export class ForceResync {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling POST /accounting/v1/sync-status/resync."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -90,7 +106,7 @@ export class ForceResync {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/generateKey/client/Client.ts b/src/api/resources/accounting/resources/generateKey/client/Client.ts
index ed8a7cf10..87525f4b8 100644
--- a/src/api/resources/accounting/resources/generateKey/client/Client.ts
+++ b/src/api/resources/accounting/resources/generateKey/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
-import * as serializers from "../../../../../../serialization";
+import * as Merge from "../../../../../index";
+import * as serializers from "../../../../../../serialization/index";
import urlJoin from "url-join";
-import * as errors from "../../../../../../errors";
+import * as errors from "../../../../../../errors/index";
export declare namespace GenerateKey {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class GenerateKey {
/**
* Create a remote key.
*
+ * @param {Merge.accounting.GenerateRemoteKeyRequest} request
+ * @param {GenerateKey.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.generateKey.create({
+ * await client.accounting.generateKey.create({
* name: "Remote Deployment Key 1"
* })
*/
@@ -52,17 +64,23 @@ export class GenerateKey {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
- body: await serializers.accounting.GenerateRemoteKeyRequest.jsonOrThrow(request, {
+ requestType: "json",
+ body: serializers.accounting.GenerateRemoteKeyRequest.jsonOrThrow(request, {
unrecognizedObjectKeys: "strip",
}),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.RemoteKey.parseOrThrow(_response.body, {
+ return serializers.accounting.RemoteKey.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -85,7 +103,7 @@ export class GenerateKey {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling POST /accounting/v1/generate-key.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -93,7 +111,7 @@ export class GenerateKey {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/generateKey/client/requests/index.ts b/src/api/resources/accounting/resources/generateKey/client/requests/index.ts
index 0df6e7c8b..d8255223c 100644
--- a/src/api/resources/accounting/resources/generateKey/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/generateKey/client/requests/index.ts
@@ -1 +1 @@
-export { GenerateRemoteKeyRequest } from "./GenerateRemoteKeyRequest";
+export { type GenerateRemoteKeyRequest } from "./GenerateRemoteKeyRequest";
diff --git a/src/api/resources/accounting/resources/incomeStatements/client/Client.ts b/src/api/resources/accounting/resources/incomeStatements/client/Client.ts
index d3e3293a4..afec28d9b 100644
--- a/src/api/resources/accounting/resources/incomeStatements/client/Client.ts
+++ b/src/api/resources/accounting/resources/incomeStatements/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace IncomeStatements {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class IncomeStatements {
/**
* Returns a list of `IncomeStatement` objects.
*
+ * @param {Merge.accounting.IncomeStatementsListRequest} request
+ * @param {IncomeStatements.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.incomeStatements.list({})
+ * await client.accounting.incomeStatements.list()
*/
public async list(
request: Merge.accounting.IncomeStatementsListRequest = {},
@@ -50,7 +62,7 @@ export class IncomeStatements {
pageSize,
remoteId,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -113,15 +125,21 @@ export class IncomeStatements {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedIncomeStatementList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedIncomeStatementList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -144,7 +162,9 @@ export class IncomeStatements {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/income-statements."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -155,8 +175,12 @@ export class IncomeStatements {
/**
* Returns an `IncomeStatement` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.IncomeStatementsRetrieveRequest} request
+ * @param {IncomeStatements.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.incomeStatements.retrieve("id", {})
+ * await client.accounting.incomeStatements.retrieve("id")
*/
public async retrieve(
id: string,
@@ -164,7 +188,7 @@ export class IncomeStatements {
requestOptions?: IncomeStatements.RequestOptions
): Promise {
const { expand, includeRemoteData } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -176,7 +200,7 @@ export class IncomeStatements {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/income-statements/${id}`
+ `accounting/v1/income-statements/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -187,15 +211,21 @@ export class IncomeStatements {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.IncomeStatement.parseOrThrow(_response.body, {
+ return serializers.accounting.IncomeStatement.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -218,7 +248,9 @@ export class IncomeStatements {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/income-statements/{id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -226,7 +258,7 @@ export class IncomeStatements {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/incomeStatements/client/requests/index.ts b/src/api/resources/accounting/resources/incomeStatements/client/requests/index.ts
index 763b753f6..5854e7695 100644
--- a/src/api/resources/accounting/resources/incomeStatements/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/incomeStatements/client/requests/index.ts
@@ -1,2 +1,2 @@
-export { IncomeStatementsListRequest } from "./IncomeStatementsListRequest";
-export { IncomeStatementsRetrieveRequest } from "./IncomeStatementsRetrieveRequest";
+export { type IncomeStatementsListRequest } from "./IncomeStatementsListRequest";
+export { type IncomeStatementsRetrieveRequest } from "./IncomeStatementsRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/invoices/client/Client.ts b/src/api/resources/accounting/resources/invoices/client/Client.ts
index 9e4827b1a..5ae519c3b 100644
--- a/src/api/resources/accounting/resources/invoices/client/Client.ts
+++ b/src/api/resources/accounting/resources/invoices/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace Invoices {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class Invoices {
/**
* Returns a list of `Invoice` objects.
*
+ * @param {Merge.accounting.InvoicesListRequest} request
+ * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.invoices.list({})
+ * await client.accounting.invoices.list()
*/
public async list(
request: Merge.accounting.InvoicesListRequest = {},
@@ -57,7 +69,7 @@ export class Invoices {
showEnumOrigins,
type: type_,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -148,15 +160,21 @@ export class Invoices {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedInvoiceList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedInvoiceList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -179,7 +197,7 @@ export class Invoices {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/invoices.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -190,8 +208,11 @@ export class Invoices {
/**
* Creates an `Invoice` object with the given values.
*
+ * @param {Merge.accounting.InvoiceEndpointRequest} request
+ * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.invoices.create({
+ * await client.accounting.invoices.create({
* model: {}
* })
*/
@@ -200,7 +221,7 @@ export class Invoices {
requestOptions?: Invoices.RequestOptions
): Promise {
const { isDebugMode, runAsync, ..._body } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (isDebugMode != null) {
_queryParams["is_debug_mode"] = isDebugMode.toString();
}
@@ -223,18 +244,22 @@ export class Invoices {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
- body: await serializers.accounting.InvoiceEndpointRequest.jsonOrThrow(_body, {
- unrecognizedObjectKeys: "strip",
- }),
+ requestType: "json",
+ body: serializers.accounting.InvoiceEndpointRequest.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.InvoiceResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.InvoiceResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -257,7 +282,7 @@ export class Invoices {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling POST /accounting/v1/invoices.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -268,8 +293,12 @@ export class Invoices {
/**
* Returns an `Invoice` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.InvoicesRetrieveRequest} request
+ * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.invoices.retrieve("id", {})
+ * await client.accounting.invoices.retrieve("id")
*/
public async retrieve(
id: string,
@@ -277,7 +306,7 @@ export class Invoices {
requestOptions?: Invoices.RequestOptions
): Promise {
const { expand, includeRemoteData, includeRemoteFields, remoteFields, showEnumOrigins } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -301,7 +330,7 @@ export class Invoices {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/invoices/${id}`
+ `accounting/v1/invoices/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -312,15 +341,21 @@ export class Invoices {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.Invoice.parseOrThrow(_response.body, {
+ return serializers.accounting.Invoice.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -343,7 +378,7 @@ export class Invoices {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/invoices/{id}.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -354,8 +389,12 @@ export class Invoices {
/**
* Updates an `Invoice` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.PatchedInvoiceEndpointRequest} request
+ * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.invoices.partialUpdate("id", {
+ * await client.accounting.invoices.partialUpdate("id", {
* model: {}
* })
*/
@@ -365,7 +404,7 @@ export class Invoices {
requestOptions?: Invoices.RequestOptions
): Promise {
const { isDebugMode, runAsync, ..._body } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (isDebugMode != null) {
_queryParams["is_debug_mode"] = isDebugMode.toString();
}
@@ -377,7 +416,7 @@ export class Invoices {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/invoices/${id}`
+ `accounting/v1/invoices/${encodeURIComponent(id)}`
),
method: "PATCH",
headers: {
@@ -388,18 +427,24 @@ export class Invoices {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
- body: await serializers.accounting.PatchedInvoiceEndpointRequest.jsonOrThrow(_body, {
+ requestType: "json",
+ body: serializers.accounting.PatchedInvoiceEndpointRequest.jsonOrThrow(_body, {
unrecognizedObjectKeys: "strip",
}),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.InvoiceResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.InvoiceResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -422,7 +467,7 @@ export class Invoices {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling PATCH /accounting/v1/invoices/{id}.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -433,8 +478,11 @@ export class Invoices {
/**
* Returns a list of `RemoteFieldClass` objects.
*
+ * @param {Merge.accounting.InvoicesLineItemsRemoteFieldClassesListRequest} request
+ * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.invoices.lineItemsRemoteFieldClassesList({})
+ * await client.accounting.invoices.lineItemsRemoteFieldClassesList()
*/
public async lineItemsRemoteFieldClassesList(
request: Merge.accounting.InvoicesLineItemsRemoteFieldClassesListRequest = {},
@@ -442,7 +490,7 @@ export class Invoices {
): Promise {
const { cursor, includeDeletedData, includeRemoteData, includeShellData, isCommonModelField, pageSize } =
request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (cursor != null) {
_queryParams["cursor"] = cursor;
}
@@ -481,15 +529,21 @@ export class Invoices {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -512,7 +566,9 @@ export class Invoices {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/invoices/line-items/remote-field-classes."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -523,8 +579,11 @@ export class Invoices {
/**
* Returns metadata for `Invoice` PATCHs.
*
+ * @param {string} id
+ * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.invoices.metaPatchRetrieve("id")
+ * await client.accounting.invoices.metaPatchRetrieve("id")
*/
public async metaPatchRetrieve(
id: string,
@@ -533,7 +592,7 @@ export class Invoices {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/invoices/meta/patch/${id}`
+ `accounting/v1/invoices/meta/patch/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -544,14 +603,20 @@ export class Invoices {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -574,7 +639,9 @@ export class Invoices {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/invoices/meta/patch/{id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -585,8 +652,10 @@ export class Invoices {
/**
* Returns metadata for `Invoice` POSTs.
*
+ * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.invoices.metaPostRetrieve()
+ * await client.accounting.invoices.metaPostRetrieve()
*/
public async metaPostRetrieve(requestOptions?: Invoices.RequestOptions): Promise {
const _response = await (this._options.fetcher ?? core.fetcher)({
@@ -603,14 +672,20 @@ export class Invoices {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -633,7 +708,9 @@ export class Invoices {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/invoices/meta/post."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -644,8 +721,11 @@ export class Invoices {
/**
* Returns a list of `RemoteFieldClass` objects.
*
+ * @param {Merge.accounting.InvoicesRemoteFieldClassesListRequest} request
+ * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.invoices.remoteFieldClassesList({})
+ * await client.accounting.invoices.remoteFieldClassesList()
*/
public async remoteFieldClassesList(
request: Merge.accounting.InvoicesRemoteFieldClassesListRequest = {},
@@ -653,7 +733,7 @@ export class Invoices {
): Promise {
const { cursor, includeDeletedData, includeRemoteData, includeShellData, isCommonModelField, pageSize } =
request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (cursor != null) {
_queryParams["cursor"] = cursor;
}
@@ -692,15 +772,21 @@ export class Invoices {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -723,7 +809,9 @@ export class Invoices {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/invoices/remote-field-classes."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -731,7 +819,7 @@ export class Invoices {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/invoices/client/requests/InvoiceEndpointRequest.ts b/src/api/resources/accounting/resources/invoices/client/requests/InvoiceEndpointRequest.ts
index f766a4a23..120195e41 100644
--- a/src/api/resources/accounting/resources/invoices/client/requests/InvoiceEndpointRequest.ts
+++ b/src/api/resources/accounting/resources/invoices/client/requests/InvoiceEndpointRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/invoices/client/requests/InvoicesListRequest.ts b/src/api/resources/accounting/resources/invoices/client/requests/InvoicesListRequest.ts
index b2689e755..129b37ace 100644
--- a/src/api/resources/accounting/resources/invoices/client/requests/InvoicesListRequest.ts
+++ b/src/api/resources/accounting/resources/invoices/client/requests/InvoicesListRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/invoices/client/requests/InvoicesRetrieveRequest.ts b/src/api/resources/accounting/resources/invoices/client/requests/InvoicesRetrieveRequest.ts
index 53ad5f7b1..166b5ac45 100644
--- a/src/api/resources/accounting/resources/invoices/client/requests/InvoicesRetrieveRequest.ts
+++ b/src/api/resources/accounting/resources/invoices/client/requests/InvoicesRetrieveRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/invoices/client/requests/PatchedInvoiceEndpointRequest.ts b/src/api/resources/accounting/resources/invoices/client/requests/PatchedInvoiceEndpointRequest.ts
index fd5881307..f1491a807 100644
--- a/src/api/resources/accounting/resources/invoices/client/requests/PatchedInvoiceEndpointRequest.ts
+++ b/src/api/resources/accounting/resources/invoices/client/requests/PatchedInvoiceEndpointRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/invoices/client/requests/index.ts b/src/api/resources/accounting/resources/invoices/client/requests/index.ts
index c1bb1b463..6fa67fe7e 100644
--- a/src/api/resources/accounting/resources/invoices/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/invoices/client/requests/index.ts
@@ -1,6 +1,6 @@
-export { InvoicesListRequest } from "./InvoicesListRequest";
-export { InvoiceEndpointRequest } from "./InvoiceEndpointRequest";
-export { InvoicesRetrieveRequest } from "./InvoicesRetrieveRequest";
-export { PatchedInvoiceEndpointRequest } from "./PatchedInvoiceEndpointRequest";
-export { InvoicesLineItemsRemoteFieldClassesListRequest } from "./InvoicesLineItemsRemoteFieldClassesListRequest";
-export { InvoicesRemoteFieldClassesListRequest } from "./InvoicesRemoteFieldClassesListRequest";
+export { type InvoicesListRequest } from "./InvoicesListRequest";
+export { type InvoiceEndpointRequest } from "./InvoiceEndpointRequest";
+export { type InvoicesRetrieveRequest } from "./InvoicesRetrieveRequest";
+export { type PatchedInvoiceEndpointRequest } from "./PatchedInvoiceEndpointRequest";
+export { type InvoicesLineItemsRemoteFieldClassesListRequest } from "./InvoicesLineItemsRemoteFieldClassesListRequest";
+export { type InvoicesRemoteFieldClassesListRequest } from "./InvoicesRemoteFieldClassesListRequest";
diff --git a/src/api/resources/accounting/resources/issues/client/Client.ts b/src/api/resources/accounting/resources/issues/client/Client.ts
index bbeeb91f7..e691cc806 100644
--- a/src/api/resources/accounting/resources/issues/client/Client.ts
+++ b/src/api/resources/accounting/resources/issues/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace Issues {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class Issues {
/**
* Gets all issues for Organization.
*
+ * @param {Merge.accounting.IssuesListRequest} request
+ * @param {Issues.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.issues.list({})
+ * await client.accounting.issues.list()
*/
public async list(
request: Merge.accounting.IssuesListRequest = {},
@@ -52,7 +64,7 @@ export class Issues {
startDate,
status,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (accountToken != null) {
_queryParams["account_token"] = accountToken;
}
@@ -123,15 +135,21 @@ export class Issues {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedIssueList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedIssueList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -154,7 +172,7 @@ export class Issues {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/issues.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -165,14 +183,17 @@ export class Issues {
/**
* Get a specific issue.
*
+ * @param {string} id
+ * @param {Issues.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.issues.retrieve("id")
+ * await client.accounting.issues.retrieve("id")
*/
public async retrieve(id: string, requestOptions?: Issues.RequestOptions): Promise {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/issues/${id}`
+ `accounting/v1/issues/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -183,14 +204,20 @@ export class Issues {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.Issue.parseOrThrow(_response.body, {
+ return serializers.accounting.Issue.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -213,7 +240,7 @@ export class Issues {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/issues/{id}.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -221,7 +248,7 @@ export class Issues {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/issues/client/requests/IssuesListRequest.ts b/src/api/resources/accounting/resources/issues/client/requests/IssuesListRequest.ts
index 44ca4b28c..9e5fac64b 100644
--- a/src/api/resources/accounting/resources/issues/client/requests/IssuesListRequest.ts
+++ b/src/api/resources/accounting/resources/issues/client/requests/IssuesListRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/issues/client/requests/index.ts b/src/api/resources/accounting/resources/issues/client/requests/index.ts
index 278763f77..ad215d907 100644
--- a/src/api/resources/accounting/resources/issues/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/issues/client/requests/index.ts
@@ -1 +1 @@
-export { IssuesListRequest } from "./IssuesListRequest";
+export { type IssuesListRequest } from "./IssuesListRequest";
diff --git a/src/api/resources/accounting/resources/items/client/Client.ts b/src/api/resources/accounting/resources/items/client/Client.ts
index 9dd3c1bb6..c3ab84211 100644
--- a/src/api/resources/accounting/resources/items/client/Client.ts
+++ b/src/api/resources/accounting/resources/items/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace Items {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class Items {
/**
* Returns a list of `Item` objects.
*
+ * @param {Merge.accounting.ItemsListRequest} request
+ * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.items.list({})
+ * await client.accounting.items.list()
*/
public async list(
request: Merge.accounting.ItemsListRequest = {},
@@ -52,7 +64,7 @@ export class Items {
remoteId,
showEnumOrigins,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -123,15 +135,21 @@ export class Items {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedItemList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedItemList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -154,7 +172,7 @@ export class Items {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/items.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -165,8 +183,12 @@ export class Items {
/**
* Returns an `Item` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.ItemsRetrieveRequest} request
+ * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.items.retrieve("id", {})
+ * await client.accounting.items.retrieve("id")
*/
public async retrieve(
id: string,
@@ -174,7 +196,7 @@ export class Items {
requestOptions?: Items.RequestOptions
): Promise {
const { expand, includeRemoteData, remoteFields, showEnumOrigins } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -194,7 +216,7 @@ export class Items {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/items/${id}`
+ `accounting/v1/items/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -205,15 +227,21 @@ export class Items {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.Item.parseOrThrow(_response.body, {
+ return serializers.accounting.Item.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -236,7 +264,7 @@ export class Items {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/items/{id}.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -244,7 +272,7 @@ export class Items {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise {
return `Bearer ${await core.Supplier.get(this._options.apiKey)}`;
}
}
diff --git a/src/api/resources/accounting/resources/items/client/requests/ItemsListRequest.ts b/src/api/resources/accounting/resources/items/client/requests/ItemsListRequest.ts
index 4d3942e87..7fd7861b8 100644
--- a/src/api/resources/accounting/resources/items/client/requests/ItemsListRequest.ts
+++ b/src/api/resources/accounting/resources/items/client/requests/ItemsListRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/items/client/requests/ItemsRetrieveRequest.ts b/src/api/resources/accounting/resources/items/client/requests/ItemsRetrieveRequest.ts
index ab8859956..4d3b6c2c7 100644
--- a/src/api/resources/accounting/resources/items/client/requests/ItemsRetrieveRequest.ts
+++ b/src/api/resources/accounting/resources/items/client/requests/ItemsRetrieveRequest.ts
@@ -2,7 +2,7 @@
* This file was auto-generated by Fern from our API Definition.
*/
-import * as Merge from "../../../../../..";
+import * as Merge from "../../../../../../index";
/**
* @example
diff --git a/src/api/resources/accounting/resources/items/client/requests/index.ts b/src/api/resources/accounting/resources/items/client/requests/index.ts
index 0ff0cec94..4be5a72cf 100644
--- a/src/api/resources/accounting/resources/items/client/requests/index.ts
+++ b/src/api/resources/accounting/resources/items/client/requests/index.ts
@@ -1,2 +1,2 @@
-export { ItemsListRequest } from "./ItemsListRequest";
-export { ItemsRetrieveRequest } from "./ItemsRetrieveRequest";
+export { type ItemsListRequest } from "./ItemsListRequest";
+export { type ItemsRetrieveRequest } from "./ItemsRetrieveRequest";
diff --git a/src/api/resources/accounting/resources/journalEntries/client/Client.ts b/src/api/resources/accounting/resources/journalEntries/client/Client.ts
index f4803a901..63d31f195 100644
--- a/src/api/resources/accounting/resources/journalEntries/client/Client.ts
+++ b/src/api/resources/accounting/resources/journalEntries/client/Client.ts
@@ -4,22 +4,31 @@
import * as environments from "../../../../../../environments";
import * as core from "../../../../../../core";
-import * as Merge from "../../../../..";
+import * as Merge from "../../../../../index";
import urlJoin from "url-join";
-import * as serializers from "../../../../../../serialization";
-import * as errors from "../../../../../../errors";
+import * as serializers from "../../../../../../serialization/index";
+import * as errors from "../../../../../../errors/index";
export declare namespace JournalEntries {
interface Options {
environment?: core.Supplier;
apiKey: core.Supplier;
+ /** Override the X-Account-Token header */
accountToken?: core.Supplier;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
+ /** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
+ /** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
+ /** A hook to abort the request. */
+ abortSignal?: AbortSignal;
+ /** Override the X-Account-Token header */
+ accountToken?: string | undefined;
+ /** Additional headers to include in the request. */
+ headers?: Record;
}
}
@@ -29,8 +38,11 @@ export class JournalEntries {
/**
* Returns a list of `JournalEntry` objects.
*
+ * @param {Merge.accounting.JournalEntriesListRequest} request
+ * @param {JournalEntries.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.journalEntries.list({})
+ * await client.accounting.journalEntries.list()
*/
public async list(
request: Merge.accounting.JournalEntriesListRequest = {},
@@ -53,7 +65,7 @@ export class JournalEntries {
transactionDateAfter,
transactionDateBefore,
} = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (companyId != null) {
_queryParams["company_id"] = companyId;
}
@@ -128,15 +140,21 @@ export class JournalEntries {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedJournalEntryList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedJournalEntryList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -159,7 +177,7 @@ export class JournalEntries {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError("Timeout exceeded when calling GET /accounting/v1/journal-entries.");
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -170,8 +188,11 @@ export class JournalEntries {
/**
* Creates a `JournalEntry` object with the given values.
*
+ * @param {Merge.accounting.JournalEntryEndpointRequest} request
+ * @param {JournalEntries.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.journalEntries.create({
+ * await client.accounting.journalEntries.create({
* model: {}
* })
*/
@@ -180,7 +201,7 @@ export class JournalEntries {
requestOptions?: JournalEntries.RequestOptions
): Promise {
const { isDebugMode, runAsync, ..._body } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (isDebugMode != null) {
_queryParams["is_debug_mode"] = isDebugMode.toString();
}
@@ -203,18 +224,24 @@ export class JournalEntries {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
- body: await serializers.accounting.JournalEntryEndpointRequest.jsonOrThrow(_body, {
+ requestType: "json",
+ body: serializers.accounting.JournalEntryEndpointRequest.jsonOrThrow(_body, {
unrecognizedObjectKeys: "strip",
}),
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.JournalEntryResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.JournalEntryResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -237,7 +264,9 @@ export class JournalEntries {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling POST /accounting/v1/journal-entries."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -248,8 +277,12 @@ export class JournalEntries {
/**
* Returns a `JournalEntry` object with the given `id`.
*
+ * @param {string} id
+ * @param {Merge.accounting.JournalEntriesRetrieveRequest} request
+ * @param {JournalEntries.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.journalEntries.retrieve("id", {})
+ * await client.accounting.journalEntries.retrieve("id")
*/
public async retrieve(
id: string,
@@ -257,7 +290,7 @@ export class JournalEntries {
requestOptions?: JournalEntries.RequestOptions
): Promise {
const { expand, includeRemoteData, includeRemoteFields } = request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (expand != null) {
_queryParams["expand"] = expand;
}
@@ -273,7 +306,7 @@ export class JournalEntries {
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.MergeEnvironment.Production,
- `accounting/v1/journal-entries/${id}`
+ `accounting/v1/journal-entries/${encodeURIComponent(id)}`
),
method: "GET",
headers: {
@@ -284,15 +317,21 @@ export class JournalEntries {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.JournalEntry.parseOrThrow(_response.body, {
+ return serializers.accounting.JournalEntry.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -315,7 +354,9 @@ export class JournalEntries {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/journal-entries/{id}."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -326,8 +367,11 @@ export class JournalEntries {
/**
* Returns a list of `RemoteFieldClass` objects.
*
+ * @param {Merge.accounting.JournalEntriesLinesRemoteFieldClassesListRequest} request
+ * @param {JournalEntries.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.journalEntries.linesRemoteFieldClassesList({})
+ * await client.accounting.journalEntries.linesRemoteFieldClassesList()
*/
public async linesRemoteFieldClassesList(
request: Merge.accounting.JournalEntriesLinesRemoteFieldClassesListRequest = {},
@@ -335,7 +379,7 @@ export class JournalEntries {
): Promise {
const { cursor, includeDeletedData, includeRemoteData, includeShellData, isCommonModelField, pageSize } =
request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (cursor != null) {
_queryParams["cursor"] = cursor;
}
@@ -374,15 +418,21 @@ export class JournalEntries {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -405,7 +455,9 @@ export class JournalEntries {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/journal-entries/lines/remote-field-classes."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -416,8 +468,10 @@ export class JournalEntries {
/**
* Returns metadata for `JournalEntry` POSTs.
*
+ * @param {JournalEntries.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.journalEntries.metaPostRetrieve()
+ * await client.accounting.journalEntries.metaPostRetrieve()
*/
public async metaPostRetrieve(
requestOptions?: JournalEntries.RequestOptions
@@ -436,14 +490,20 @@ export class JournalEntries {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
+ return serializers.accounting.MetaResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -466,7 +526,9 @@ export class JournalEntries {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/journal-entries/meta/post."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -477,8 +539,11 @@ export class JournalEntries {
/**
* Returns a list of `RemoteFieldClass` objects.
*
+ * @param {Merge.accounting.JournalEntriesRemoteFieldClassesListRequest} request
+ * @param {JournalEntries.RequestOptions} requestOptions - Request-specific configuration.
+ *
* @example
- * await merge.accounting.journalEntries.remoteFieldClassesList({})
+ * await client.accounting.journalEntries.remoteFieldClassesList()
*/
public async remoteFieldClassesList(
request: Merge.accounting.JournalEntriesRemoteFieldClassesListRequest = {},
@@ -486,7 +551,7 @@ export class JournalEntries {
): Promise {
const { cursor, includeDeletedData, includeRemoteData, includeShellData, isCommonModelField, pageSize } =
request;
- const _queryParams: Record = {};
+ const _queryParams: Record = {};
if (cursor != null) {
_queryParams["cursor"] = cursor;
}
@@ -525,15 +590,21 @@ export class JournalEntries {
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@mergeapi/merge-node-client",
- "X-Fern-SDK-Version": "1.0.12",
+ "X-Fern-SDK-Version": "1.1.0",
+ "User-Agent": "@mergeapi/merge-node-client/1.1.0",
+ "X-Fern-Runtime": core.RUNTIME.type,
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
+ ...requestOptions?.headers,
},
contentType: "application/json",
queryParameters: _queryParams,
+ requestType: "json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
- return await serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
+ return serializers.accounting.PaginatedRemoteFieldClassList.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -556,7 +627,9 @@ export class JournalEntries {
body: _response.error.rawBody,
});
case "timeout":
- throw new errors.MergeTimeoutError();
+ throw new errors.MergeTimeoutError(
+ "Timeout exceeded when calling GET /accounting/v1/journal-entries/remote-field-classes."
+ );
case "unknown":
throw new errors.MergeError({
message: _response.error.errorMessage,
@@ -564,7 +637,7 @@ export class JournalEntries {
}
}
- protected async _getAuthorizationHeader() {
+ protected async _getAuthorizationHeader(): Promise