diff --git a/.fern/metadata.json b/.fern/metadata.json
index 3594085a7..3a835c4cc 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -17,7 +17,8 @@
"fetchSupport": "node-fetch",
"generateSubpackageExports": true,
"packageManager": "yarn",
- "testFramework": "jest"
+ "testFramework": "jest",
+ "enableForwardCompatibleEnums": true
},
- "sdkVersion": "3.0.1"
+ "sdkVersion": "3.0.3"
}
diff --git a/reference.md b/reference.md
index ccb2348b5..f26fa38d5 100644
--- a/reference.md
+++ b/reference.md
@@ -115,12 +115,67 @@ await client.ats.accountToken.retrieve("public_token");
+
+
+
+
+client.ats.accountToken.regenerateCreate() -> Merge.RegenerateAccountToken
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Exchange Linked Account account tokens.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.ats.accountToken.regenerateCreate();
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `AccountTokenClient.RequestOptions`
+
+
+
+
+
+
+
client.ats.activities.list({ ...params }) -> Merge.PaginatedActivityList
+client.ats.activities.list({ ...params }) -> core.Page
-
@@ -147,11 +202,30 @@ Returns a list of `Activity` objects.
-
```typescript
-await client.ats.activities.list({
+const pageableResponse = await client.ats.activities.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "activity_type",
+ remoteId: "remote_id",
+ showEnumOrigins: "activity_type",
+ userId: "user_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.activities.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "user",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -163,6 +237,12 @@ await client.ats.activities.list({
showEnumOrigins: "activity_type",
userId: "user_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -294,7 +374,6 @@ Returns an `Activity` object with the given `id`.
```typescript
await client.ats.activities.retrieve("id", {
- expand: "user",
includeRemoteData: true,
includeShellData: true,
remoteFields: "activity_type",
@@ -399,7 +478,7 @@ await client.ats.activities.metaPostRetrieve();
client.ats.applications.list({ ...params }) -> Merge.PaginatedApplicationList
+client.ats.applications.list({ ...params }) -> core.Page
-
@@ -426,14 +505,13 @@ Returns a list of `Application` objects.
-
```typescript
-await client.ats.applications.list({
+const pageableResponse = await client.ats.applications.list({
candidateId: "candidate_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
creditedToId: "credited_to_id",
currentStageId: "current_stage_id",
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "candidate",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -445,6 +523,35 @@ await client.ats.applications.list({
remoteId: "remote_id",
source: "source"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.applications.list({
+ candidateId: "candidate_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ creditedToId: "credited_to_id",
+ currentStageId: "current_stage_id",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ jobId: "job_id",
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ rejectReasonId: "reject_reason_id",
+ remoteId: "remote_id",
+ source: "source"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -579,7 +686,6 @@ Returns an `Application` object with the given `id`.
```typescript
await client.ats.applications.retrieve("id", {
- expand: "candidate",
includeRemoteData: true,
includeShellData: true
});
@@ -896,7 +1002,7 @@ await client.ats.asyncPassthrough.retrieve("async_passthrough_receipt_id");
client.ats.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList
+client.ats.attachments.list({ ...params }) -> core.Page
-
@@ -923,12 +1029,31 @@ Returns a list of `Attachment` objects.
-
```typescript
-await client.ats.attachments.list({
+const pageableResponse = await client.ats.attachments.list({
+ candidateId: "candidate_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "attachment_type",
+ remoteId: "remote_id",
+ showEnumOrigins: "attachment_type"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.attachments.list({
candidateId: "candidate_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "candidate",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -939,6 +1064,12 @@ await client.ats.attachments.list({
remoteId: "remote_id",
showEnumOrigins: "attachment_type"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -1070,7 +1201,6 @@ Returns an `Attachment` object with the given `id`.
```typescript
await client.ats.attachments.retrieve("id", {
- expand: "candidate",
includeRemoteData: true,
includeShellData: true,
remoteFields: "attachment_type",
@@ -1175,7 +1305,7 @@ await client.ats.attachments.metaPostRetrieve();
client.ats.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+client.ats.auditTrail.list({ ...params }) -> core.Page
-
@@ -1202,7 +1332,7 @@ Gets a list of audit trail events.
-
```typescript
-await client.ats.auditTrail.list({
+const pageableResponse = await client.ats.auditTrail.list({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
endDate: "end_date",
eventType: "event_type",
@@ -1210,6 +1340,25 @@ await client.ats.auditTrail.list({
startDate: "start_date",
userEmail: "user_email"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.auditTrail.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endDate: "end_date",
+ eventType: "event_type",
+ pageSize: 1,
+ startDate: "start_date",
+ userEmail: "user_email"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -1302,7 +1451,7 @@ await client.ats.availableActions.retrieve();
client.ats.candidates.list({ ...params }) -> Merge.PaginatedCandidateList
+client.ats.candidates.list({ ...params }) -> core.Page
-
@@ -1329,12 +1478,11 @@ Returns a list of `Candidate` objects.
-
```typescript
-await client.ats.candidates.list({
+const pageableResponse = await client.ats.candidates.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
emailAddresses: "email_addresses",
- expand: "applications",
firstName: "first_name",
includeDeletedData: true,
includeRemoteData: true,
@@ -1346,6 +1494,33 @@ await client.ats.candidates.list({
remoteId: "remote_id",
tags: "tags"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.candidates.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ emailAddresses: "email_addresses",
+ firstName: "first_name",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ lastName: "last_name",
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ tags: "tags"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -1477,7 +1652,6 @@ Returns a `Candidate` object with the given `id`.
```typescript
await client.ats.candidates.retrieve("id", {
- expand: "applications",
includeRemoteData: true,
includeShellData: true
});
@@ -1653,7 +1827,7 @@ await client.ats.candidates.ignoreCreate("model_id", {
-
-**request:** `Merge.ats.IgnoreCommonModelRequest`
+**request:** `Merge.IgnoreCommonModelRequest`
@@ -2045,7 +2219,7 @@ await client.ats.deleteAccount.delete();
client.ats.departments.list({ ...params }) -> Merge.PaginatedDepartmentList
+client.ats.departments.list({ ...params }) -> core.Page
-
@@ -2072,7 +2246,24 @@ Returns a list of `Department` objects.
-
```typescript
-await client.ats.departments.list({
+const pageableResponse = await client.ats.departments.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.departments.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
@@ -2084,6 +2275,12 @@ await client.ats.departments.list({
pageSize: 1,
remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -2194,7 +2391,7 @@ await client.ats.departments.retrieve("id", {
client.ats.eeocs.list({ ...params }) -> Merge.PaginatedEeocList
+client.ats.eeocs.list({ ...params }) -> core.Page
-
@@ -2221,12 +2418,31 @@ Returns a list of `EEOC` objects.
-
```typescript
-await client.ats.eeocs.list({
+const pageableResponse = await client.ats.eeocs.list({
+ candidateId: "candidate_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "disability_status",
+ remoteId: "remote_id",
+ showEnumOrigins: "disability_status"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.eeocs.list({
candidateId: "candidate_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "candidate",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -2237,6 +2453,12 @@ await client.ats.eeocs.list({
remoteId: "remote_id",
showEnumOrigins: "disability_status"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -2300,7 +2522,6 @@ Returns an `EEOC` object with the given `id`.
```typescript
await client.ats.eeocs.retrieve("id", {
- expand: "candidate",
includeRemoteData: true,
includeShellData: true,
remoteFields: "disability_status",
@@ -2576,7 +2797,9 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
-
```typescript
-await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+await client.ats.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", {
+ remoteDataIterationCount: 1
+});
```
@@ -2808,7 +3031,7 @@ await client.ats.generateKey.create({
client.ats.interviews.list({ ...params }) -> Merge.PaginatedScheduledInterviewList
+client.ats.interviews.list({ ...params }) -> core.Page
-
@@ -2835,12 +3058,11 @@ Returns a list of `ScheduledInterview` objects.
-
```typescript
-await client.ats.interviews.list({
+const pageableResponse = await client.ats.interviews.list({
applicationId: "application_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "application",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -2854,6 +3076,35 @@ await client.ats.interviews.list({
remoteId: "remote_id",
showEnumOrigins: "status"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.interviews.list({
+ applicationId: "application_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ jobId: "job_id",
+ jobInterviewStageId: "job_interview_stage_id",
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ organizerId: "organizer_id",
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -2985,7 +3236,6 @@ Returns a `ScheduledInterview` object with the given `id`.
```typescript
await client.ats.interviews.retrieve("id", {
- expand: "application",
includeRemoteData: true,
includeShellData: true,
remoteFields: "status",
@@ -3090,7 +3340,7 @@ await client.ats.interviews.metaPostRetrieve();
client.ats.issues.list({ ...params }) -> Merge.PaginatedIssueList
+client.ats.issues.list({ ...params }) -> core.Page
-
@@ -3117,7 +3367,7 @@ Gets all issues for Organization.
-
```typescript
-await client.ats.issues.list({
+const pageableResponse = await client.ats.issues.list({
accountToken: "account_token",
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
endDate: "end_date",
@@ -3133,6 +3383,33 @@ await client.ats.issues.list({
startDate: "start_date",
status: "ONGOING"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.issues.list({
+ accountToken: "account_token",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endDate: "end_date",
+ endUserOrganizationName: "end_user_organization_name",
+ firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
+ includeMuted: "include_muted",
+ integrationName: "integration_name",
+ lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
+ linkedAccountId: "linked_account_id",
+ pageSize: 1,
+ startDate: "start_date",
+ status: "ONGOING"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -3232,7 +3509,7 @@ await client.ats.issues.retrieve("id");
client.ats.jobInterviewStages.list({ ...params }) -> Merge.PaginatedJobInterviewStageList
+client.ats.jobInterviewStages.list({ ...params }) -> core.Page
-
@@ -3259,11 +3536,10 @@ Returns a list of `JobInterviewStage` objects.
-
```typescript
-await client.ats.jobInterviewStages.list({
+const pageableResponse = await client.ats.jobInterviewStages.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "job",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -3273,6 +3549,30 @@ await client.ats.jobInterviewStages.list({
pageSize: 1,
remoteId: "remote_id"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.jobInterviewStages.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ jobId: "job_id",
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -3336,7 +3636,6 @@ Returns a `JobInterviewStage` object with the given `id`.
```typescript
await client.ats.jobInterviewStages.retrieve("id", {
- expand: "job",
includeRemoteData: true,
includeShellData: true
});
@@ -3384,7 +3683,7 @@ await client.ats.jobInterviewStages.retrieve("id", {
client.ats.jobPostings.list({ ...params }) -> Merge.PaginatedJobPostingList
+client.ats.jobPostings.list({ ...params }) -> core.Page
-
@@ -3411,11 +3710,10 @@ Returns a list of `JobPosting` objects.
-
```typescript
-await client.ats.jobPostings.list({
+const pageableResponse = await client.ats.jobPostings.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "job",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -3425,6 +3723,30 @@ await client.ats.jobPostings.list({
remoteId: "remote_id",
status: "CLOSED"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.jobPostings.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ status: "CLOSED"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -3488,7 +3810,6 @@ Returns a `JobPosting` object with the given `id`.
```typescript
await client.ats.jobPostings.retrieve("id", {
- expand: "job",
includeRemoteData: true,
includeShellData: true
});
@@ -3536,7 +3857,7 @@ await client.ats.jobPostings.retrieve("id", {
client.ats.jobs.list({ ...params }) -> Merge.PaginatedJobList
+client.ats.jobs.list({ ...params }) -> core.Page
-
@@ -3563,12 +3884,33 @@ Returns a list of `Job` objects.
-
```typescript
-await client.ats.jobs.list({
+const pageableResponse = await client.ats.jobs.list({
+ code: "code",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ offices: "offices",
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status",
+ status: "ARCHIVED"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.jobs.list({
code: "code",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "departments",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -3581,6 +3923,12 @@ await client.ats.jobs.list({
showEnumOrigins: "status",
status: "ARCHIVED"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -3644,7 +3992,6 @@ Returns a `Job` object with the given `id`.
```typescript
await client.ats.jobs.retrieve("id", {
- expand: "departments",
includeRemoteData: true,
includeShellData: true,
remoteFields: "status",
@@ -3693,7 +4040,7 @@ await client.ats.jobs.retrieve("id", {
client.ats.jobs.screeningQuestionsList(job_id, { ...params }) -> Merge.PaginatedScreeningQuestionList
+client.ats.jobs.screeningQuestionsList(job_id, { ...params }) -> core.Page
-
@@ -3720,14 +4067,31 @@ Returns a list of `ScreeningQuestion` objects.
-
```typescript
-await client.ats.jobs.screeningQuestionsList("job_id", {
+const pageableResponse = await client.ats.jobs.screeningQuestionsList("job_id", {
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "job",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
pageSize: 1
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.jobs.screeningQuestionsList("job_id", {
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -3784,7 +4148,7 @@ await client.ats.jobs.screeningQuestionsList("job_id", {
-
-Creates a link token to be used when linking a new end user.
+Creates a link token to be used when linking a new end user. The link token expires after single use.
@@ -3841,7 +4205,7 @@ await client.ats.linkToken.create({
client.ats.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+client.ats.linkedAccounts.list({ ...params }) -> core.Page
-
@@ -3868,7 +4232,7 @@ List linked accounts for your organization.
-
```typescript
-await client.ats.linkedAccounts.list({
+const pageableResponse = await client.ats.linkedAccounts.list({
category: "accounting",
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
endUserEmailAddress: "end_user_email_address",
@@ -3883,6 +4247,32 @@ await client.ats.linkedAccounts.list({
pageSize: 1,
status: "status"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.linkedAccounts.list({
+ category: "accounting",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endUserEmailAddress: "end_user_email_address",
+ endUserOrganizationName: "end_user_organization_name",
+ endUserOriginId: "end_user_origin_id",
+ endUserOriginIds: "end_user_origin_ids",
+ id: "id",
+ ids: "ids",
+ includeDuplicates: true,
+ integrationName: "integration_name",
+ isTestAccount: "is_test_account",
+ pageSize: 1,
+ status: "status"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -3919,7 +4309,7 @@ await client.ats.linkedAccounts.list({
client.ats.offers.list({ ...params }) -> Merge.PaginatedOfferList
+client.ats.offers.list({ ...params }) -> core.Page
-
@@ -3946,13 +4336,12 @@ Returns a list of `Offer` objects.
-
```typescript
-await client.ats.offers.list({
+const pageableResponse = await client.ats.offers.list({
applicationId: "application_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
creatorId: "creator_id",
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "application",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -3961,8 +4350,37 @@ await client.ats.offers.list({
pageSize: 1,
remoteFields: "status",
remoteId: "remote_id",
- showEnumOrigins: "status"
+ showEnumOrigins: "status",
+ status: "APPROVAL-SENT"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.offers.list({
+ applicationId: "application_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ creatorId: "creator_id",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status",
+ status: "APPROVAL-SENT"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -4026,7 +4444,6 @@ Returns an `Offer` object with the given `id`.
```typescript
await client.ats.offers.retrieve("id", {
- expand: "application",
includeRemoteData: true,
includeShellData: true,
remoteFields: "status",
@@ -4076,7 +4493,7 @@ await client.ats.offers.retrieve("id", {
client.ats.offices.list({ ...params }) -> Merge.PaginatedOfficeList
+client.ats.offices.list({ ...params }) -> core.Page
-
@@ -4103,7 +4520,7 @@ Returns a list of `Office` objects.
-
```typescript
-await client.ats.offices.list({
+const pageableResponse = await client.ats.offices.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
@@ -4115,6 +4532,29 @@ await client.ats.offices.list({
pageSize: 1,
remoteId: "remote_id"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.offices.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -4358,7 +4798,7 @@ await client.ats.regenerateKey.create({
client.ats.rejectReasons.list({ ...params }) -> Merge.PaginatedRejectReasonList
+client.ats.rejectReasons.list({ ...params }) -> core.Page
-
@@ -4385,7 +4825,7 @@ Returns a list of `RejectReason` objects.
-
```typescript
-await client.ats.rejectReasons.list({
+const pageableResponse = await client.ats.rejectReasons.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
@@ -4397,6 +4837,29 @@ await client.ats.rejectReasons.list({
pageSize: 1,
remoteId: "remote_id"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.rejectReasons.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -4507,7 +4970,7 @@ await client.ats.rejectReasons.retrieve("id", {
client.ats.scorecards.list({ ...params }) -> Merge.PaginatedScorecardList
+client.ats.scorecards.list({ ...params }) -> core.Page
-
@@ -4534,12 +4997,33 @@ Returns a list of `Scorecard` objects.
-
```typescript
-await client.ats.scorecards.list({
+const pageableResponse = await client.ats.scorecards.list({
+ applicationId: "application_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ interviewId: "interview_id",
+ interviewerId: "interviewer_id",
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "overall_recommendation",
+ remoteId: "remote_id",
+ showEnumOrigins: "overall_recommendation"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.scorecards.list({
applicationId: "application_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "application",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -4552,6 +5036,12 @@ await client.ats.scorecards.list({
remoteId: "remote_id",
showEnumOrigins: "overall_recommendation"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -4615,7 +5105,6 @@ Returns a `Scorecard` object with the given `id`.
```typescript
await client.ats.scorecards.retrieve("id", {
- expand: "application",
includeRemoteData: true,
includeShellData: true,
remoteFields: "overall_recommendation",
@@ -4665,7 +5154,7 @@ await client.ats.scorecards.retrieve("id", {
client.ats.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+client.ats.syncStatus.list({ ...params }) -> core.Page
-
@@ -4692,10 +5181,25 @@ Get sync status for the current sync and the most recently finished sync. `last_
-
```typescript
-await client.ats.syncStatus.list({
+const pageableResponse = await client.ats.syncStatus.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.syncStatus.list({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -4788,7 +5292,7 @@ await client.ats.forceResync.syncStatusResyncCreate();
client.ats.tags.list({ ...params }) -> Merge.PaginatedTagList
+client.ats.tags.list({ ...params }) -> core.Page
-
@@ -4815,7 +5319,7 @@ Returns a list of `Tag` objects.
-
```typescript
-await client.ats.tags.list({
+const pageableResponse = await client.ats.tags.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
@@ -4827,6 +5331,29 @@ await client.ats.tags.list({
pageSize: 1,
remoteId: "remote_id"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.tags.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -4863,7 +5390,7 @@ await client.ats.tags.list({
client.ats.users.list({ ...params }) -> Merge.PaginatedRemoteUserList
+client.ats.users.list({ ...params }) -> core.Page
-
@@ -4890,7 +5417,27 @@ Returns a list of `RemoteUser` objects.
-
```typescript
-await client.ats.users.list({
+const pageableResponse = await client.ats.users.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ email: "email",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "access_role",
+ remoteId: "remote_id",
+ showEnumOrigins: "access_role"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.ats.users.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
@@ -4905,6 +5452,12 @@ await client.ats.users.list({
remoteId: "remote_id",
showEnumOrigins: "access_role"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -5138,8 +5691,8 @@ await client.ats.webhookReceivers.create({
client.crm.accountDetails.retrieve() -> Merge.AccountDetails
+## Accounting AccountDetails
+client.accounting.accountDetails.retrieve() -> Merge.AccountDetails
-
@@ -5166,7 +5719,7 @@ Get details for a linked account.
-
```typescript
-await client.crm.accountDetails.retrieve();
+await client.accounting.accountDetails.retrieve();
```
@@ -5194,8 +5747,8 @@ await client.crm.accountDetails.retrieve();
client.crm.accountToken.retrieve(public_token) -> Merge.AccountToken
+## Accounting AccountToken
+client.accounting.accountToken.retrieve(public_token) -> Merge.AccountToken
-
@@ -5222,7 +5775,7 @@ Returns the account token for the end user with the provided public token.
-
```typescript
-await client.crm.accountToken.retrieve("public_token");
+await client.accounting.accountToken.retrieve("public_token");
```
@@ -5258,8 +5811,7 @@ await client.crm.accountToken.retrieve("public_token");
client.crm.accounts.list({ ...params }) -> Merge.PaginatedAccountList
+client.accounting.accountToken.regenerateCreate() -> Merge.RegenerateAccountToken
-
@@ -5271,7 +5823,7 @@ await client.crm.accountToken.retrieve("public_token");
-
-Returns a list of `Account` objects.
+Exchange Linked Account account tokens.
@@ -5286,22 +5838,7 @@ Returns a list of `Account` objects.
-
```typescript
-await client.crm.accounts.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "owner",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- name: "name",
- ownerId: "owner_id",
- pageSize: 1,
- remoteId: "remote_id"
-});
+await client.accounting.accountToken.regenerateCreate();
```
@@ -5317,15 +5854,7 @@ await client.crm.accounts.list({
-
-**request:** `Merge.crm.AccountsListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `AccountsClient.RequestOptions`
+**requestOptions:** `AccountTokenClient.RequestOptions`
@@ -5337,7 +5866,8 @@ await client.crm.accounts.list({
client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse
+## Accounting AccountingPeriods
+client.accounting.accountingPeriods.list({ ...params }) -> core.Page
-
@@ -5349,7 +5879,7 @@ await client.crm.accounts.list({
-
-Creates an `Account` object with the given values.
+Returns a list of `AccountingPeriod` objects.
@@ -5364,11 +5894,31 @@ Creates an `Account` object with the given values.
-
```typescript
-await client.crm.accounts.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
+const pageableResponse = await client.accounting.accountingPeriods.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.accountingPeriods.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -5384,7 +5934,7 @@ await client.crm.accounts.create({
-
-**request:** `Merge.crm.CrmAccountEndpointRequest`
+**request:** `Merge.accounting.AccountingPeriodsListRequest`
@@ -5392,7 +5942,7 @@ await client.crm.accounts.create({
-
-**requestOptions:** `AccountsClient.RequestOptions`
+**requestOptions:** `AccountingPeriodsClient.RequestOptions`
@@ -5404,7 +5954,7 @@ await client.crm.accounts.create({
client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account
+client.accounting.accountingPeriods.retrieve(id, { ...params }) -> Merge.AccountingPeriod
-
@@ -5416,7 +5966,7 @@ await client.crm.accounts.create({
-
-Returns an `Account` object with the given `id`.
+Returns an `AccountingPeriod` object with the given `id`.
@@ -5431,10 +5981,8 @@ Returns an `Account` object with the given `id`.
-
```typescript
-await client.crm.accounts.retrieve("id", {
- expand: "owner",
+await client.accounting.accountingPeriods.retrieve("id", {
includeRemoteData: true,
- includeRemoteFields: true,
includeShellData: true
});
@@ -5460,7 +6008,7 @@ await client.crm.accounts.retrieve("id", {
-
-**request:** `Merge.crm.AccountsRetrieveRequest`
+**request:** `Merge.accounting.AccountingPeriodsRetrieveRequest`
@@ -5468,7 +6016,7 @@ await client.crm.accounts.retrieve("id", {
-
-**requestOptions:** `AccountsClient.RequestOptions`
+**requestOptions:** `AccountingPeriodsClient.RequestOptions`
@@ -5480,7 +6028,8 @@ await client.crm.accounts.retrieve("id", {
client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse
+## Accounting Accounts
+client.accounting.accounts.list({ ...params }) -> core.Page
-
@@ -5492,7 +6041,7 @@ await client.crm.accounts.retrieve("id", {
-
-Updates an `Account` object with the given `id`.
+Returns a list of `Account` objects.
@@ -5507,11 +6056,55 @@ Updates an `Account` object with the given `id`.
-
```typescript
-await client.crm.accounts.partialUpdate("id", {
- isDebugMode: true,
- runAsync: true,
- model: {}
+const pageableResponse = await client.accounting.accounts.list({
+ accountType: "account_type",
+ classification: "",
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ pageSize: 1,
+ remoteFields: "classification",
+ remoteId: "remote_id",
+ showEnumOrigins: "classification",
+ status: ""
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.accounts.list({
+ accountType: "account_type",
+ classification: "",
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ pageSize: 1,
+ remoteFields: "classification",
+ remoteId: "remote_id",
+ showEnumOrigins: "classification",
+ status: ""
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -5527,7 +6120,7 @@ await client.crm.accounts.partialUpdate("id", {
-
-**id:** `string`
+**request:** `Merge.accounting.AccountsListRequest`
@@ -5535,7 +6128,66 @@ await client.crm.accounts.partialUpdate("id", {
-
-**request:** `Merge.crm.PatchedCrmAccountEndpointRequest`
+**requestOptions:** `AccountsClient.RequestOptions`
+
+
+
+
+
+
+
+
+
+client.accounting.accounts.create({ ...params }) -> Merge.AccountResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Account` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.accounts.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
+});
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.AccountEndpointRequest`
@@ -5555,7 +6207,7 @@ await client.crm.accounts.partialUpdate("id", {
client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse
+client.accounting.accounts.retrieve(id, { ...params }) -> Merge.Account
-
@@ -5567,7 +6219,7 @@ await client.crm.accounts.partialUpdate("id", {
-
-Returns metadata for `CRMAccount` PATCHs.
+Returns an `Account` object with the given `id`.
@@ -5582,7 +6234,12 @@ Returns metadata for `CRMAccount` PATCHs.
-
```typescript
-await client.crm.accounts.metaPatchRetrieve("id");
+await client.accounting.accounts.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true,
+ remoteFields: "classification",
+ showEnumOrigins: "classification"
+});
```
@@ -5606,6 +6263,14 @@ await client.crm.accounts.metaPatchRetrieve("id");
-
+**request:** `Merge.accounting.AccountsRetrieveRequest`
+
+
+
+
+
+-
+
**requestOptions:** `AccountsClient.RequestOptions`
@@ -5618,7 +6283,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse
+client.accounting.accounts.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -5630,7 +6295,7 @@ await client.crm.accounts.metaPatchRetrieve("id");
-
-Returns metadata for `CRMAccount` POSTs.
+Returns metadata for `Account` POSTs.
@@ -5645,7 +6310,7 @@ Returns metadata for `CRMAccount` POSTs.
-
```typescript
-await client.crm.accounts.metaPostRetrieve();
+await client.accounting.accounts.metaPostRetrieve();
```
@@ -5673,7 +6338,8 @@ await client.crm.accounts.metaPostRetrieve();
client.crm.accounts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+## Accounting Addresses
+client.accounting.addresses.retrieve(id, { ...params }) -> Merge.Address
-
@@ -5685,7 +6351,7 @@ await client.crm.accounts.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Returns an `Address` object with the given `id`.
@@ -5700,15 +6366,11 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.accounts.remoteFieldClassesList({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
+await client.accounting.addresses.retrieve("id", {
includeRemoteData: true,
- includeRemoteFields: true,
includeShellData: true,
- isCommonModelField: true,
- isCustom: true,
- pageSize: 1
+ remoteFields: "type",
+ showEnumOrigins: "type"
});
```
@@ -5725,7 +6387,7 @@ await client.crm.accounts.remoteFieldClassesList({
-
-**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest`
+**id:** `string`
@@ -5733,7 +6395,15 @@ await client.crm.accounts.remoteFieldClassesList({
-
-**requestOptions:** `AccountsClient.RequestOptions`
+**request:** `Merge.accounting.AddressesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AddressesClient.RequestOptions`
@@ -5745,8 +6415,8 @@ await client.crm.accounts.remoteFieldClassesList({
client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
+## Accounting AsyncPassthrough
+client.accounting.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
-
@@ -5773,7 +6443,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.crm.asyncPassthrough.create({
+await client.accounting.asyncPassthrough.create({
method: "GET",
path: "/scooters"
});
@@ -5812,7 +6482,7 @@ await client.crm.asyncPassthrough.create({
client.crm.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
+client.accounting.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
-
@@ -5839,7 +6509,7 @@ Retrieves data from earlier async-passthrough POST request
-
```typescript
-await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+await client.accounting.asyncPassthrough.retrieve("async_passthrough_receipt_id");
```
@@ -5875,8 +6545,8 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
client.crm.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+## Accounting AsyncTasks
+client.accounting.asyncTasks.retrieve(id) -> Merge.AsyncPostTask
-
@@ -5888,7 +6558,7 @@ await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-
-Gets a list of audit trail events.
+Returns an `AsyncPostTask` object with the given `id`.
@@ -5903,14 +6573,7 @@ Gets a list of audit trail events.
-
```typescript
-await client.crm.auditTrail.list({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endDate: "end_date",
- eventType: "event_type",
- pageSize: 1,
- startDate: "start_date",
- userEmail: "user_email"
-});
+await client.accounting.asyncTasks.retrieve("id");
```
@@ -5926,7 +6589,7 @@ await client.crm.auditTrail.list({
-
-**request:** `Merge.crm.AuditTrailListRequest`
+**id:** `string`
@@ -5934,7 +6597,7 @@ await client.crm.auditTrail.list({
-
-**requestOptions:** `AuditTrailClient.RequestOptions`
+**requestOptions:** `AsyncTasksClient.RequestOptions`
@@ -5946,8 +6609,8 @@ await client.crm.auditTrail.list({
client.crm.availableActions.retrieve() -> Merge.AvailableActions
+## Accounting Attachments
+client.accounting.attachments.list({ ...params }) -> core.Page
-
@@ -5959,7 +6622,7 @@ await client.crm.auditTrail.list({
-
-Returns a list of models and actions available for an account.
+Returns a list of `AccountingAttachment` objects.
@@ -5974,7 +6637,43 @@ Returns a list of models and actions available for an account.
-
```typescript
-await client.crm.availableActions.retrieve();
+const pageableResponse = await client.accounting.attachments.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.attachments.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -5990,7 +6689,15 @@ await client.crm.availableActions.retrieve();
-
-**requestOptions:** `AvailableActionsClient.RequestOptions`
+**request:** `Merge.accounting.AttachmentsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AttachmentsClient.RequestOptions`
@@ -6002,8 +6709,7 @@ await client.crm.availableActions.retrieve();
client.crm.contacts.list({ ...params }) -> Merge.PaginatedContactList
+client.accounting.attachments.create({ ...params }) -> Merge.AccountingAttachmentResponse
-
@@ -6015,7 +6721,7 @@ await client.crm.availableActions.retrieve();
-
-Returns a list of `Contact` objects.
+Creates an `AccountingAttachment` object with the given values.
@@ -6030,22 +6736,10 @@ Returns a list of `Contact` objects.
-
```typescript
-await client.crm.contacts.list({
- accountId: "account_id",
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- emailAddresses: "email_addresses",
- expand: "account",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- phoneNumbers: "phone_numbers",
- remoteId: "remote_id"
+await client.accounting.attachments.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -6062,7 +6756,7 @@ await client.crm.contacts.list({
-
-**request:** `Merge.crm.ContactsListRequest`
+**request:** `Merge.accounting.AccountingAttachmentEndpointRequest`
@@ -6070,7 +6764,7 @@ await client.crm.contacts.list({
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**requestOptions:** `AttachmentsClient.RequestOptions`
@@ -6082,7 +6776,7 @@ await client.crm.contacts.list({
client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse
+client.accounting.attachments.retrieve(id, { ...params }) -> Merge.AccountingAttachment
-
@@ -6094,7 +6788,7 @@ await client.crm.contacts.list({
-
-Creates a `Contact` object with the given values.
+Returns an `AccountingAttachment` object with the given `id`.
@@ -6109,10 +6803,9 @@ Creates a `Contact` object with the given values.
-
```typescript
-await client.crm.contacts.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
+await client.accounting.attachments.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true
});
```
@@ -6129,7 +6822,7 @@ await client.crm.contacts.create({
-
-**request:** `Merge.crm.CrmContactEndpointRequest`
+**id:** `string`
@@ -6137,7 +6830,15 @@ await client.crm.contacts.create({
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**request:** `Merge.accounting.AttachmentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AttachmentsClient.RequestOptions`
@@ -6149,7 +6850,7 @@ await client.crm.contacts.create({
client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact
+client.accounting.attachments.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -6161,7 +6862,7 @@ await client.crm.contacts.create({
-
-Returns a `Contact` object with the given `id`.
+Returns metadata for `AccountingAttachment` POSTs.
@@ -6176,12 +6877,7 @@ Returns a `Contact` object with the given `id`.
-
```typescript
-await client.crm.contacts.retrieve("id", {
- expand: "account",
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true
-});
+await client.accounting.attachments.metaPostRetrieve();
```
@@ -6197,23 +6893,7 @@ await client.crm.contacts.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.ContactsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**requestOptions:** `AttachmentsClient.RequestOptions`
@@ -6225,7 +6905,8 @@ await client.crm.contacts.retrieve("id", {
client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse
+## Accounting AuditTrail
+client.accounting.auditTrail.list({ ...params }) -> core.Page
-
@@ -6237,7 +6918,7 @@ await client.crm.contacts.retrieve("id", {
-
-Updates a `Contact` object with the given `id`.
+Gets a list of audit trail events.
@@ -6252,11 +6933,33 @@ Updates a `Contact` object with the given `id`.
-
```typescript
-await client.crm.contacts.partialUpdate("id", {
- isDebugMode: true,
- runAsync: true,
- model: {}
+const pageableResponse = await client.accounting.auditTrail.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endDate: "end_date",
+ eventType: "event_type",
+ pageSize: 1,
+ startDate: "start_date",
+ userEmail: "user_email"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.auditTrail.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endDate: "end_date",
+ eventType: "event_type",
+ pageSize: 1,
+ startDate: "start_date",
+ userEmail: "user_email"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -6272,7 +6975,7 @@ await client.crm.contacts.partialUpdate("id", {
-
-**id:** `string`
+**request:** `Merge.accounting.AuditTrailListRequest`
@@ -6280,15 +6983,63 @@ await client.crm.contacts.partialUpdate("id", {
-
-**request:** `Merge.crm.PatchedCrmContactEndpointRequest`
+**requestOptions:** `AuditTrailClient.RequestOptions`
+
+
+
+
+
+client.accounting.availableActions.retrieve() -> Merge.AvailableActions
-
-**requestOptions:** `ContactsClient.RequestOptions`
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.accounting.availableActions.retrieve();
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `AvailableActionsClient.RequestOptions`
@@ -6300,7 +7051,8 @@ await client.crm.contacts.partialUpdate("id", {
client.crm.contacts.ignoreCreate(model_id, { ...params }) -> void
+## Accounting BalanceSheets
+client.accounting.balanceSheets.list({ ...params }) -> core.Page
-
@@ -6312,7 +7064,7 @@ await client.crm.contacts.partialUpdate("id", {
-
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+Returns a list of `BalanceSheet` objects.
@@ -6327,9 +7079,43 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
-
```typescript
-await client.crm.contacts.ignoreCreate("model_id", {
- reason: "GENERAL_CUSTOMER_REQUEST"
+const pageableResponse = await client.accounting.balanceSheets.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.balanceSheets.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -6345,15 +7131,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-
-**model_id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.IgnoreCommonModelRequest`
+**request:** `Merge.accounting.BalanceSheetsListRequest`
@@ -6361,7 +7139,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**requestOptions:** `BalanceSheetsClient.RequestOptions`
@@ -6373,7 +7151,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse
+client.accounting.balanceSheets.retrieve(id, { ...params }) -> Merge.BalanceSheet
-
@@ -6385,7 +7163,7 @@ await client.crm.contacts.ignoreCreate("model_id", {
-
-Returns metadata for `CRMContact` PATCHs.
+Returns a `BalanceSheet` object with the given `id`.
@@ -6400,7 +7178,10 @@ Returns metadata for `CRMContact` PATCHs.
-
```typescript
-await client.crm.contacts.metaPatchRetrieve("id");
+await client.accounting.balanceSheets.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true
+});
```
@@ -6424,7 +7205,15 @@ await client.crm.contacts.metaPatchRetrieve("id");
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**request:** `Merge.accounting.BalanceSheetsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `BalanceSheetsClient.RequestOptions`
@@ -6436,7 +7225,8 @@ await client.crm.contacts.metaPatchRetrieve("id");
client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse
+## Accounting BankFeedAccounts
+client.accounting.bankFeedAccounts.list({ ...params }) -> core.Page
-
@@ -6448,7 +7238,7 @@ await client.crm.contacts.metaPatchRetrieve("id");
-
-Returns metadata for `CRMContact` POSTs.
+Returns a list of `BankFeedAccount` objects.
@@ -6463,7 +7253,31 @@ Returns metadata for `CRMContact` POSTs.
-
```typescript
-await client.crm.contacts.metaPostRetrieve();
+const pageableResponse = await client.accounting.bankFeedAccounts.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.bankFeedAccounts.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -6479,7 +7293,15 @@ await client.crm.contacts.metaPostRetrieve();
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**request:** `Merge.accounting.BankFeedAccountsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `BankFeedAccountsClient.RequestOptions`
@@ -6491,7 +7313,7 @@ await client.crm.contacts.metaPostRetrieve();
client.crm.contacts.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.accounting.bankFeedAccounts.create({ ...params }) -> Merge.BankFeedAccountResponse
-
@@ -6503,7 +7325,7 @@ await client.crm.contacts.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Creates a `BankFeedAccount` object with the given values.
@@ -6518,15 +7340,10 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.contacts.remoteFieldClassesList({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- isCommonModelField: true,
- isCustom: true,
- pageSize: 1
+await client.accounting.bankFeedAccounts.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -6543,7 +7360,7 @@ await client.crm.contacts.remoteFieldClassesList({
-
-**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.BankFeedAccountEndpointRequest`
@@ -6551,7 +7368,7 @@ await client.crm.contacts.remoteFieldClassesList({
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**requestOptions:** `BankFeedAccountsClient.RequestOptions`
@@ -6563,8 +7380,7 @@ await client.crm.contacts.remoteFieldClassesList({
client.crm.customObjectClasses.list({ ...params }) -> Merge.PaginatedCustomObjectClassList
+client.accounting.bankFeedAccounts.retrieve(id, { ...params }) -> Merge.BankFeedAccount
-
@@ -6576,7 +7392,7 @@ await client.crm.contacts.remoteFieldClassesList({
-
-Returns a list of `CustomObjectClass` objects.
+Returns a `BankFeedAccount` object with the given `id`.
@@ -6591,18 +7407,9 @@ Returns a list of `CustomObjectClass` objects.
-
```typescript
-await client.crm.customObjectClasses.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "fields",
- includeDeletedData: true,
+await client.accounting.bankFeedAccounts.retrieve("id", {
includeRemoteData: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteId: "remote_id"
+ includeShellData: true
});
```
@@ -6619,7 +7426,7 @@ await client.crm.customObjectClasses.list({
-
-**request:** `Merge.crm.CustomObjectClassesListRequest`
+**id:** `string`
@@ -6627,7 +7434,15 @@ await client.crm.customObjectClasses.list({
-
-**requestOptions:** `CustomObjectClassesClient.RequestOptions`
+**request:** `Merge.accounting.BankFeedAccountsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `BankFeedAccountsClient.RequestOptions`
@@ -6639,7 +7454,7 @@ await client.crm.customObjectClasses.list({
client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass
+client.accounting.bankFeedAccounts.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -6651,7 +7466,7 @@ await client.crm.customObjectClasses.list({
-
-Returns a `CustomObjectClass` object with the given `id`.
+Returns metadata for `BankFeedAccount` POSTs.
@@ -6666,11 +7481,7 @@ Returns a `CustomObjectClass` object with the given `id`.
-
```typescript
-await client.crm.customObjectClasses.retrieve("id", {
- expand: "fields",
- includeRemoteData: true,
- includeShellData: true
-});
+await client.accounting.bankFeedAccounts.metaPostRetrieve();
```
@@ -6686,23 +7497,7 @@ await client.crm.customObjectClasses.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CustomObjectClassesClient.RequestOptions`
+**requestOptions:** `BankFeedAccountsClient.RequestOptions`
@@ -6714,8 +7509,8 @@ await client.crm.customObjectClasses.retrieve("id", {
client.crm.associationTypes.customObjectClassesAssociationTypesList(custom_object_class_id, { ...params }) -> Merge.PaginatedAssociationTypeList
+## Accounting BankFeedTransactions
+client.accounting.bankFeedTransactions.list({ ...params }) -> core.Page
-
@@ -6727,7 +7522,7 @@ await client.crm.customObjectClasses.retrieve("id", {
-
-Returns a list of `AssociationType` objects.
+Returns a list of `BankFeedTransaction` objects.
@@ -6742,19 +7537,43 @@ Returns a list of `AssociationType` objects.
-
```typescript
-await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id", {
+const pageableResponse = await client.accounting.bankFeedTransactions.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isProcessed: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.bankFeedTransactions.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "target_object_classes",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
+ isProcessed: true,
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
pageSize: 1,
remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -6770,15 +7589,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-
-**custom_object_class_id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest`
+**request:** `Merge.accounting.BankFeedTransactionsListRequest`
@@ -6786,7 +7597,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-
-**requestOptions:** `AssociationTypesClient.RequestOptions`
+**requestOptions:** `BankFeedTransactionsClient.RequestOptions`
@@ -6798,7 +7609,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
client.crm.associationTypes.customObjectClassesAssociationTypesCreate(custom_object_class_id, { ...params }) -> Merge.CrmAssociationTypeResponse
+client.accounting.bankFeedTransactions.create({ ...params }) -> Merge.BankFeedTransactionResponse
-
@@ -6810,7 +7621,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesList("custo
-
-Creates an `AssociationType` object with the given values.
+Creates a `BankFeedTransaction` object with the given values.
@@ -6825,20 +7636,10 @@ Creates an `AssociationType` object with the given values.
-
```typescript
-await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("custom_object_class_id", {
+await client.accounting.bankFeedTransactions.create({
isDebugMode: true,
runAsync: true,
- model: {
- sourceObjectClass: {
- id: "id",
- originType: "CUSTOM_OBJECT"
- },
- targetObjectClasses: [{
- id: "id",
- originType: "CUSTOM_OBJECT"
- }],
- remoteKeyName: "remote_key_name"
- }
+ model: {}
});
```
@@ -6855,15 +7656,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-
-**custom_object_class_id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CrmAssociationTypeEndpointRequest`
+**request:** `Merge.accounting.BankFeedTransactionEndpointRequest`
@@ -6871,7 +7664,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-
-**requestOptions:** `AssociationTypesClient.RequestOptions`
+**requestOptions:** `BankFeedTransactionsClient.RequestOptions`
@@ -6883,7 +7676,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(custom_object_class_id, id, { ...params }) -> Merge.AssociationType
+client.accounting.bankFeedTransactions.retrieve(id, { ...params }) -> Merge.BankFeedTransaction
-
@@ -6895,7 +7688,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("cus
-
-Returns an `AssociationType` object with the given `id`.
+Returns a `BankFeedTransaction` object with the given `id`.
@@ -6910,8 +7703,7 @@ Returns an `AssociationType` object with the given `id`.
-
```typescript
-await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id", {
- expand: "target_object_classes",
+await client.accounting.bankFeedTransactions.retrieve("id", {
includeRemoteData: true,
includeShellData: true
});
@@ -6930,14 +7722,6 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-
-**custom_object_class_id:** `string`
-
-
-
-
-
--
-
**id:** `string`
@@ -6946,7 +7730,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-
-**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest`
+**request:** `Merge.accounting.BankFeedTransactionsRetrieveRequest`
@@ -6954,7 +7738,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-
-**requestOptions:** `AssociationTypesClient.RequestOptions`
+**requestOptions:** `BankFeedTransactionsClient.RequestOptions`
@@ -6966,7 +7750,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(custom_object_class_id) -> Merge.MetaResponse
+client.accounting.bankFeedTransactions.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -6978,7 +7762,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("c
-
-Returns metadata for `CRMAssociationType` POSTs.
+Returns metadata for `BankFeedTransaction` POSTs.
@@ -6993,7 +7777,7 @@ Returns metadata for `CRMAssociationType` POSTs.
-
```typescript
-await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id");
+await client.accounting.bankFeedTransactions.metaPostRetrieve();
```
@@ -7009,15 +7793,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-
-**custom_object_class_id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `AssociationTypesClient.RequestOptions`
+**requestOptions:** `BankFeedTransactionsClient.RequestOptions`
@@ -7029,8 +7805,8 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
client.crm.customObjects.customObjectClassesCustomObjectsList(custom_object_class_id, { ...params }) -> Merge.PaginatedCustomObjectList
+## Accounting CashFlowStatements
+client.accounting.cashFlowStatements.list({ ...params }) -> core.Page
-
@@ -7042,7 +7818,7 @@ await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRet
-
-Returns a list of `CustomObject` objects.
+Returns a list of `CashFlowStatement` objects.
@@ -7057,19 +7833,43 @@ Returns a list of `CustomObject` objects.
-
```typescript
-await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id", {
+const pageableResponse = await client.accounting.cashFlowStatements.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.cashFlowStatements.list({
+ companyId: "company_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
includeDeletedData: true,
includeRemoteData: true,
- includeRemoteFields: true,
includeShellData: true,
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
pageSize: 1,
remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -7085,15 +7885,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-
-**custom_object_class_id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest`
+**request:** `Merge.accounting.CashFlowStatementsListRequest`
@@ -7101,7 +7893,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-
-**requestOptions:** `CustomObjectsClient.RequestOptions`
+**requestOptions:** `CashFlowStatementsClient.RequestOptions`
@@ -7113,7 +7905,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
client.crm.customObjects.customObjectClassesCustomObjectsCreate(custom_object_class_id, { ...params }) -> Merge.CrmCustomObjectResponse
+client.accounting.cashFlowStatements.retrieve(id, { ...params }) -> Merge.CashFlowStatement
-
@@ -7125,7 +7917,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_obje
-
-Creates a `CustomObject` object with the given values.
+Returns a `CashFlowStatement` object with the given `id`.
@@ -7140,14 +7932,9 @@ Creates a `CustomObject` object with the given values.
-
```typescript
-await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", {
- isDebugMode: true,
- runAsync: true,
- model: {
- fields: {
- "test_field": "hello"
- }
- }
+await client.accounting.cashFlowStatements.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true
});
```
@@ -7164,7 +7951,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-
-**custom_object_class_id:** `string`
+**id:** `string`
@@ -7172,7 +7959,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-
-**request:** `Merge.crm.CrmCustomObjectEndpointRequest`
+**request:** `Merge.accounting.CashFlowStatementsRetrieveRequest`
@@ -7180,7 +7967,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-
-**requestOptions:** `CustomObjectsClient.RequestOptions`
+**requestOptions:** `CashFlowStatementsClient.RequestOptions`
@@ -7192,7 +7979,8 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(custom_object_class_id, id, { ...params }) -> Merge.CustomObject
+## Accounting CompanyInfo
+client.accounting.companyInfo.list({ ...params }) -> core.Page
-
@@ -7204,7 +7992,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_ob
-
-Returns a `CustomObject` object with the given `id`.
+Returns a list of `CompanyInfo` objects.
@@ -7219,11 +8007,43 @@ Returns a `CustomObject` object with the given `id`.
-
```typescript
-await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id", {
+const pageableResponse = await client.accounting.companyInfo.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.companyInfo.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ pageSize: 1,
+ remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -7239,23 +8059,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-
-**custom_object_class_id:** `string`
-
-
-
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest`
+**request:** `Merge.accounting.CompanyInfoListRequest`
@@ -7263,7 +8067,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-
-**requestOptions:** `CustomObjectsClient.RequestOptions`
+**requestOptions:** `CompanyInfoClient.RequestOptions`
@@ -7275,7 +8079,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(custom_object_class_id) -> Merge.MetaResponse
+client.accounting.companyInfo.retrieve(id, { ...params }) -> Merge.CompanyInfo
-
@@ -7287,7 +8091,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_
-
-Returns metadata for `CRMCustomObject` POSTs.
+Returns a `CompanyInfo` object with the given `id`.
@@ -7302,7 +8106,10 @@ Returns metadata for `CRMCustomObject` POSTs.
-
```typescript
-await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id");
+await client.accounting.companyInfo.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true
+});
```
@@ -7318,7 +8125,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-
-**custom_object_class_id:** `string`
+**id:** `string`
@@ -7326,7 +8133,15 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-
-**requestOptions:** `CustomObjectsClient.RequestOptions`
+**request:** `Merge.accounting.CompanyInfoRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CompanyInfoClient.RequestOptions`
@@ -7338,7 +8153,8 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+## Accounting Contacts
+client.accounting.contacts.list({ ...params }) -> core.Page
-
@@ -7350,7 +8166,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `Contact` objects.
@@ -7365,16 +8181,59 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({
+const pageableResponse = await client.accounting.contacts.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ emailAddress: "email_address",
includeDeletedData: true,
includeRemoteData: true,
includeRemoteFields: true,
includeShellData: true,
- isCommonModelField: true,
- isCustom: true,
- pageSize: 1
+ isCustomer: "is_customer",
+ isSupplier: "is_supplier",
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status",
+ status: ""
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.contacts.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ emailAddress: "email_address",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCustomer: "is_customer",
+ isSupplier: "is_supplier",
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status",
+ status: ""
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -7390,7 +8249,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.ContactsListRequest`
@@ -7398,7 +8257,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-
-**requestOptions:** `CustomObjectsClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -7410,8 +8269,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
client.crm.associations.customObjectClassesCustomObjectsAssociationsList(custom_object_class_id, object_id, { ...params }) -> Merge.PaginatedAssociationList
+client.accounting.contacts.create({ ...params }) -> Merge.ContactResponse
-
@@ -7423,7 +8281,7 @@ await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClasse
-
-Returns a list of `Association` objects.
+Creates a `Contact` object with the given values.
@@ -7438,19 +8296,10 @@ Returns a list of `Association` objects.
-
```typescript
-await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id", {
- associationTypeId: "association_type_id",
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "association_type",
- includeDeletedData: true,
- includeRemoteData: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteId: "remote_id"
+await client.accounting.contacts.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -7467,23 +8316,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-
-**custom_object_class_id:** `string`
-
-
-
-
-
--
-
-**object_id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest`
+**request:** `Merge.accounting.ContactEndpointRequest`
@@ -7491,7 +8324,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-
-**requestOptions:** `AssociationsClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -7503,7 +8336,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(source_class_id, source_object_id, target_class_id, target_object_id, association_type_id, { ...params }) -> Merge.Association
+client.accounting.contacts.retrieve(id, { ...params }) -> Merge.Contact
-
@@ -7515,7 +8348,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("
-
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
+Returns a `Contact` object with the given `id`.
@@ -7530,9 +8363,12 @@ Creates an Association between `source_object_id` and `target_object_id` of type
-
```typescript
-await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate("source_class_id", "source_object_id", "target_class_id", "target_object_id", "association_type_id", {
- isDebugMode: true,
- runAsync: true
+await client.accounting.contacts.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ remoteFields: "status",
+ showEnumOrigins: "status"
});
```
@@ -7549,7 +8385,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-
-**source_class_id:** `string`
+**id:** `string`
@@ -7557,7 +8393,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-
-**source_object_id:** `string`
+**request:** `Merge.accounting.ContactsRetrieveRequest`
@@ -7565,23 +8401,66 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-
-**target_class_id:** `string`
+**requestOptions:** `ContactsClient.RequestOptions`
+
+
+
+
+
+
+client.accounting.contacts.partialUpdate(id, { ...params }) -> Merge.ContactResponse
-
-**target_object_id:** `string`
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates a `Contact` object with the given `id`.
+
+
+#### 🔌 Usage
+
-
-**association_type_id:** `string`
+
+-
+
+```typescript
+await client.accounting.contacts.partialUpdate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
+});
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `string`
@@ -7589,7 +8468,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-
-**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest`
+**request:** `Merge.accounting.PatchedContactEndpointRequest`
@@ -7597,7 +8476,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-
-**requestOptions:** `AssociationsClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -7609,8 +8488,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
+client.accounting.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -7622,7 +8500,7 @@ await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns metadata for `Contact` PATCHs.
@@ -7637,7 +8515,7 @@ Get the default permissions for Merge Common Models and fields across all Linked
-
```typescript
-await client.crm.scopes.defaultScopesRetrieve();
+await client.accounting.contacts.metaPatchRetrieve("id");
```
@@ -7653,7 +8531,15 @@ await client.crm.scopes.defaultScopesRetrieve();
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -7665,7 +8551,7 @@ await client.crm.scopes.defaultScopesRetrieve();
client.crm.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
+client.accounting.contacts.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -7677,7 +8563,7 @@ await client.crm.scopes.defaultScopesRetrieve();
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns metadata for `Contact` POSTs.
@@ -7692,7 +8578,7 @@ Get all available permissions for Merge Common Models and fields for a single Li
-
```typescript
-await client.crm.scopes.linkedAccountScopesRetrieve();
+await client.accounting.contacts.metaPostRetrieve();
```
@@ -7708,7 +8594,7 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -7720,7 +8606,7 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
client.crm.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
+client.accounting.contacts.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -7732,7 +8618,7 @@ await client.crm.scopes.linkedAccountScopesRetrieve();
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+Returns a list of `RemoteFieldClass` objects.
@@ -7747,30 +8633,35 @@ Update permissions for any Common Model or field for a single Linked Account. An
-
```typescript
-await client.crm.scopes.linkedAccountScopesCreate({
- commonModels: [{
- modelName: "Employee",
- modelPermissions: {
- "READ": {
- isEnabled: true
- },
- "WRITE": {
- isEnabled: false
- }
- },
- fieldPermissions: {
- enabledFields: ["avatar", "home_location"],
- disabledFields: ["work_location"]
- }
- }, {
- modelName: "Benefit",
- modelPermissions: {
- "WRITE": {
- isEnabled: false
- }
- }
- }]
+const pageableResponse = await client.accounting.contacts.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.contacts.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -7786,7 +8677,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-
-**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest`
+**request:** `Merge.accounting.ContactsRemoteFieldClassesListRequest`
@@ -7794,7 +8685,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -7806,8 +8697,8 @@ await client.crm.scopes.linkedAccountScopesCreate({
client.crm.deleteAccount.delete() -> void
+## Accounting CreditNotes
+client.accounting.creditNotes.list({ ...params }) -> core.Page
-
@@ -7819,7 +8710,7 @@ await client.crm.scopes.linkedAccountScopesCreate({
-
-Delete a linked account.
+Returns a list of `CreditNote` objects.
@@ -7834,7 +8725,51 @@ Delete a linked account.
-
```typescript
-await client.crm.deleteAccount.delete();
+const pageableResponse = await client.accounting.creditNotes.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.creditNotes.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -7850,7 +8785,15 @@ await client.crm.deleteAccount.delete();
-
-**requestOptions:** `DeleteAccountClient.RequestOptions`
+**request:** `Merge.accounting.CreditNotesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CreditNotesClient.RequestOptions`
@@ -7862,8 +8805,7 @@ await client.crm.deleteAccount.delete();
client.crm.engagementTypes.list({ ...params }) -> Merge.PaginatedEngagementTypeList
+client.accounting.creditNotes.create({ ...params }) -> Merge.CreditNoteResponse
-
@@ -7875,7 +8817,7 @@ await client.crm.deleteAccount.delete();
-
-Returns a list of `EngagementType` objects.
+Creates a `CreditNote` object with the given values.
@@ -7890,18 +8832,10 @@ Returns a list of `EngagementType` objects.
-
```typescript
-await client.crm.engagementTypes.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteId: "remote_id"
+await client.accounting.creditNotes.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -7918,7 +8852,7 @@ await client.crm.engagementTypes.list({
-
-**request:** `Merge.crm.EngagementTypesListRequest`
+**request:** `Merge.accounting.CreditNoteEndpointRequest`
@@ -7926,7 +8860,7 @@ await client.crm.engagementTypes.list({
-
-**requestOptions:** `EngagementTypesClient.RequestOptions`
+**requestOptions:** `CreditNotesClient.RequestOptions`
@@ -7938,7 +8872,7 @@ await client.crm.engagementTypes.list({
client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType
+client.accounting.creditNotes.retrieve(id, { ...params }) -> Merge.CreditNote
-
@@ -7950,7 +8884,7 @@ await client.crm.engagementTypes.list({
-
-Returns an `EngagementType` object with the given `id`.
+Returns a `CreditNote` object with the given `id`.
@@ -7965,10 +8899,11 @@ Returns an `EngagementType` object with the given `id`.
-
```typescript
-await client.crm.engagementTypes.retrieve("id", {
+await client.accounting.creditNotes.retrieve("id", {
includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true
+ includeShellData: true,
+ remoteFields: "status",
+ showEnumOrigins: "status"
});
```
@@ -7993,7 +8928,7 @@ await client.crm.engagementTypes.retrieve("id", {
-
-**request:** `Merge.crm.EngagementTypesRetrieveRequest`
+**request:** `Merge.accounting.CreditNotesRetrieveRequest`
@@ -8001,7 +8936,7 @@ await client.crm.engagementTypes.retrieve("id", {
-
-**requestOptions:** `EngagementTypesClient.RequestOptions`
+**requestOptions:** `CreditNotesClient.RequestOptions`
@@ -8013,7 +8948,7 @@ await client.crm.engagementTypes.retrieve("id", {
client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.accounting.creditNotes.partialUpdate(id, { ...params }) -> Merge.CreditNoteResponse
-
@@ -8025,7 +8960,7 @@ await client.crm.engagementTypes.retrieve("id", {
-
-Returns a list of `RemoteFieldClass` objects.
+Updates a `CreditNote` object with the given `id`.
@@ -8040,15 +8975,10 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.engagementTypes.remoteFieldClassesList({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- isCommonModelField: true,
- isCustom: true,
- pageSize: 1
+await client.accounting.creditNotes.partialUpdate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -8065,7 +8995,7 @@ await client.crm.engagementTypes.remoteFieldClassesList({
-
-**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest`
+**id:** `string`
@@ -8073,7 +9003,15 @@ await client.crm.engagementTypes.remoteFieldClassesList({
-
-**requestOptions:** `EngagementTypesClient.RequestOptions`
+**request:** `Merge.accounting.PatchedCreditNoteEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CreditNotesClient.RequestOptions`
@@ -8085,8 +9023,7 @@ await client.crm.engagementTypes.remoteFieldClassesList({
client.crm.engagements.list({ ...params }) -> Merge.PaginatedEngagementList
+client.accounting.creditNotes.applicationCreate(id, { ...params }) -> Merge.CreditNoteResponse
-
@@ -8098,7 +9035,7 @@ await client.crm.engagementTypes.remoteFieldClassesList({
-
-Returns a list of `Engagement` objects.
+Creates a new CreditNoteApplyLine to apply a credit note to an invoice
@@ -8113,21 +9050,11 @@ Returns a list of `Engagement` objects.
-
```typescript
-await client.crm.engagements.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "account",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteId: "remote_id",
- startedAfter: new Date("2024-01-15T09:30:00.000Z"),
- startedBefore: new Date("2024-01-15T09:30:00.000Z")
+await client.accounting.creditNotes.applicationCreate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ appliedDate: new Date("2024-01-15T09:30:00.000Z"),
+ appliedAmount: "applied_amount"
});
```
@@ -8144,7 +9071,7 @@ await client.crm.engagements.list({
-
-**request:** `Merge.crm.EngagementsListRequest`
+**id:** `string`
@@ -8152,7 +9079,15 @@ await client.crm.engagements.list({
-
-**requestOptions:** `EngagementsClient.RequestOptions`
+**request:** `Merge.accounting.ApplyCreditNoteRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CreditNotesClient.RequestOptions`
@@ -8164,7 +9099,7 @@ await client.crm.engagements.list({
client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse
+client.accounting.creditNotes.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -8176,7 +9111,7 @@ await client.crm.engagements.list({
-
-Creates an `Engagement` object with the given values.
+Returns metadata for `CreditNote` PATCHs.
@@ -8191,11 +9126,7 @@ Creates an `Engagement` object with the given values.
-
```typescript
-await client.crm.engagements.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
-});
+await client.accounting.creditNotes.metaPatchRetrieve("id");
```
@@ -8211,7 +9142,7 @@ await client.crm.engagements.create({
-
-**request:** `Merge.crm.EngagementEndpointRequest`
+**id:** `string`
@@ -8219,7 +9150,7 @@ await client.crm.engagements.create({
-
-**requestOptions:** `EngagementsClient.RequestOptions`
+**requestOptions:** `CreditNotesClient.RequestOptions`
@@ -8231,7 +9162,7 @@ await client.crm.engagements.create({
client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement
+client.accounting.creditNotes.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -8243,7 +9174,7 @@ await client.crm.engagements.create({
-
-Returns an `Engagement` object with the given `id`.
+Returns metadata for `CreditNote` POSTs.
@@ -8258,12 +9189,7 @@ Returns an `Engagement` object with the given `id`.
-
```typescript
-await client.crm.engagements.retrieve("id", {
- expand: "account",
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true
-});
+await client.accounting.creditNotes.metaPostRetrieve();
```
@@ -8279,23 +9205,7 @@ await client.crm.engagements.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.EngagementsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `EngagementsClient.RequestOptions`
+**requestOptions:** `CreditNotesClient.RequestOptions`
@@ -8307,7 +9217,8 @@ await client.crm.engagements.retrieve("id", {
client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse
+## Accounting Scopes
+client.accounting.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
-
@@ -8319,7 +9230,7 @@ await client.crm.engagements.retrieve("id", {
-
-Updates an `Engagement` object with the given `id`.
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -8334,11 +9245,7 @@ Updates an `Engagement` object with the given `id`.
-
```typescript
-await client.crm.engagements.partialUpdate("id", {
- isDebugMode: true,
- runAsync: true,
- model: {}
-});
+await client.accounting.scopes.defaultScopesRetrieve();
```
@@ -8354,23 +9261,62 @@ await client.crm.engagements.partialUpdate("id", {
-
-**id:** `string`
+**requestOptions:** `ScopesClient.RequestOptions`
+
+
+
+
+
+
+client.accounting.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
+
+-
+
+#### 📝 Description
-
-**request:** `Merge.crm.PatchedEngagementEndpointRequest`
-
+
+-
+
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+
+
+#### 🔌 Usage
+
-
-**requestOptions:** `EngagementsClient.RequestOptions`
+
+-
+
+```typescript
+await client.accounting.scopes.linkedAccountScopesRetrieve();
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `ScopesClient.RequestOptions`
@@ -8382,7 +9328,7 @@ await client.crm.engagements.partialUpdate("id", {
client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse
+client.accounting.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
-
@@ -8394,7 +9340,7 @@ await client.crm.engagements.partialUpdate("id", {
-
-Returns metadata for `Engagement` PATCHs.
+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)
@@ -8409,7 +9355,30 @@ Returns metadata for `Engagement` PATCHs.
-
```typescript
-await client.crm.engagements.metaPatchRetrieve("id");
+await client.accounting.scopes.linkedAccountScopesCreate({
+ commonModels: [{
+ modelName: "Employee",
+ modelPermissions: {
+ "READ": {
+ isEnabled: true
+ },
+ "WRITE": {
+ isEnabled: false
+ }
+ },
+ fieldPermissions: {
+ enabledFields: ["avatar", "home_location"],
+ disabledFields: ["work_location"]
+ }
+ }, {
+ modelName: "Benefit",
+ modelPermissions: {
+ "WRITE": {
+ isEnabled: false
+ }
+ }
+ }]
+});
```
@@ -8425,7 +9394,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-
-**id:** `string`
+**request:** `Merge.accounting.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -8433,7 +9402,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-
-**requestOptions:** `EngagementsClient.RequestOptions`
+**requestOptions:** `ScopesClient.RequestOptions`
@@ -8445,7 +9414,8 @@ await client.crm.engagements.metaPatchRetrieve("id");
client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse
+## Accounting DeleteAccount
+client.accounting.deleteAccount.delete() -> void
-
@@ -8457,7 +9427,7 @@ await client.crm.engagements.metaPatchRetrieve("id");
-
-Returns metadata for `Engagement` POSTs.
+Delete a linked account.
@@ -8472,7 +9442,7 @@ Returns metadata for `Engagement` POSTs.
-
```typescript
-await client.crm.engagements.metaPostRetrieve();
+await client.accounting.deleteAccount.delete();
```
@@ -8488,7 +9458,7 @@ await client.crm.engagements.metaPostRetrieve();
-
-**requestOptions:** `EngagementsClient.RequestOptions`
+**requestOptions:** `DeleteAccountClient.RequestOptions`
@@ -8500,7 +9470,8 @@ await client.crm.engagements.metaPostRetrieve();
client.crm.engagements.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+## Accounting Employees
+client.accounting.employees.list({ ...params }) -> core.Page
-
@@ -8512,7 +9483,7 @@ await client.crm.engagements.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `Employee` objects.
@@ -8527,16 +9498,43 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.engagements.remoteFieldClassesList({
+const pageableResponse = await client.accounting.employees.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
includeDeletedData: true,
includeRemoteData: true,
- includeRemoteFields: true,
includeShellData: true,
- isCommonModelField: true,
- isCustom: true,
- pageSize: 1
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.employees.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -8552,7 +9550,7 @@ await client.crm.engagements.remoteFieldClassesList({
-
-**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.EmployeesListRequest`
@@ -8560,7 +9558,7 @@ await client.crm.engagements.remoteFieldClassesList({
-
-**requestOptions:** `EngagementsClient.RequestOptions`
+**requestOptions:** `EmployeesClient.RequestOptions`
@@ -8572,8 +9570,7 @@ await client.crm.engagements.remoteFieldClassesList({
client.crm.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
+client.accounting.employees.retrieve(id, { ...params }) -> Merge.Employee
-
@@ -8585,7 +9582,7 @@ await client.crm.engagements.remoteFieldClassesList({
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns an `Employee` object with the given `id`.
@@ -8600,8 +9597,9 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
-
```typescript
-await client.crm.fieldMapping.fieldMappingsRetrieve({
- excludeRemoteFieldMetadata: true
+await client.accounting.employees.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true
});
```
@@ -8618,7 +9616,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve({
-
-**request:** `Merge.crm.FieldMappingsRetrieveRequest`
+**id:** `string`
@@ -8626,7 +9624,15 @@ await client.crm.fieldMapping.fieldMappingsRetrieve({
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**request:** `Merge.accounting.EmployeesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EmployeesClient.RequestOptions`
@@ -8638,7 +9644,8 @@ await client.crm.fieldMapping.fieldMappingsRetrieve({
client.crm.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
+## Accounting ExpenseReports
+client.accounting.expenseReports.list({ ...params }) -> core.Page
-
@@ -8650,7 +9657,7 @@ await client.crm.fieldMapping.fieldMappingsRetrieve({
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `ExpenseReport` objects.
@@ -8665,15 +9672,45 @@ Create new Field Mappings that will be available after the next scheduled sync.
-
```typescript
-await client.crm.fieldMapping.fieldMappingsCreate({
- excludeRemoteFieldMetadata: true,
- targetFieldName: "example_target_field_name",
- targetFieldDescription: "this is a example description of the target field",
- remoteFieldTraversalPath: ["example_remote_field"],
- remoteMethod: "GET",
- remoteUrlPath: "/example-url-path",
- commonModelName: "ExampleCommonModel"
+const pageableResponse = await client.accounting.expenseReports.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.expenseReports.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -8689,7 +9726,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-
-**request:** `Merge.crm.CreateFieldMappingRequest`
+**request:** `Merge.accounting.ExpenseReportsListRequest`
@@ -8697,7 +9734,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `ExpenseReportsClient.RequestOptions`
@@ -8709,7 +9746,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
client.crm.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> Merge.FieldMappingInstanceResponse
+client.accounting.expenseReports.create({ ...params }) -> Merge.ExpenseReportResponse
-
@@ -8721,7 +9758,7 @@ await client.crm.fieldMapping.fieldMappingsCreate({
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Creates an `ExpenseReport` object with the given values.
@@ -8736,7 +9773,13 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
-
```typescript
-await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+await client.accounting.expenseReports.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {
+ trackingCategories: ["a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d", "d4c3b2a1-9e8f-7g6h-5i4j-3k2l1m0n9o8p"]
+ }
+});
```
@@ -8752,7 +9795,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**field_mapping_id:** `string`
+**request:** `Merge.accounting.ExpenseReportEndpointRequest`
@@ -8760,7 +9803,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `ExpenseReportsClient.RequestOptions`
@@ -8772,7 +9815,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
client.crm.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...params }) -> Merge.FieldMappingInstanceResponse
+client.accounting.expenseReports.linesList(expense_report_id, { ...params }) -> core.Page
-
@@ -8784,7 +9827,7 @@ await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `ExpenseReportLine` objects that point to a `ExpenseReport` with the given id.
@@ -8799,7 +9842,33 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
-
```typescript
-await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+const pageableResponse = await client.accounting.expenseReports.linesList("expense_report_id", {
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.expenseReports.linesList("expense_report_id", {
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -8815,7 +9884,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-**field_mapping_id:** `string`
+**expense_report_id:** `string`
@@ -8823,7 +9892,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-**request:** `Merge.crm.PatchedEditFieldMappingRequest`
+**request:** `Merge.accounting.ExpenseReportsLinesListRequest`
@@ -8831,7 +9900,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `ExpenseReportsClient.RequestOptions`
@@ -8843,7 +9912,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
client.crm.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
+client.accounting.expenseReports.retrieve(id, { ...params }) -> Merge.ExpenseReport
-
@@ -8855,7 +9924,7 @@ await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns an `ExpenseReport` object with the given `id`.
@@ -8870,9 +9939,10 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
-
```typescript
-await client.crm.fieldMapping.remoteFieldsRetrieve({
- commonModels: "common_models",
- includeExampleValues: "include_example_values"
+await client.accounting.expenseReports.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true
});
```
@@ -8889,7 +9959,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve({
-
-**request:** `Merge.crm.RemoteFieldsRetrieveRequest`
+**id:** `string`
@@ -8897,7 +9967,15 @@ await client.crm.fieldMapping.remoteFieldsRetrieve({
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**request:** `Merge.accounting.ExpenseReportsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ExpenseReportsClient.RequestOptions`
@@ -8909,7 +9987,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve({
client.crm.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
+client.accounting.expenseReports.linesRemoteFieldClassesList({ ...params }) -> core.Page
-
@@ -8921,7 +9999,7 @@ await client.crm.fieldMapping.remoteFieldsRetrieve({
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Returns a list of `RemoteFieldClass` objects.
@@ -8936,7 +10014,35 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
-
```typescript
-await client.crm.fieldMapping.targetFieldsRetrieve();
+const pageableResponse = await client.accounting.expenseReports.linesRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.expenseReports.linesRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -8952,7 +10058,15 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**request:** `Merge.accounting.ExpenseReportsLinesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ExpenseReportsClient.RequestOptions`
@@ -8964,8 +10078,7 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey
+client.accounting.expenseReports.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -8977,7 +10090,7 @@ await client.crm.fieldMapping.targetFieldsRetrieve();
-
-Create a remote key.
+Returns metadata for `ExpenseReport` POSTs.
@@ -8992,9 +10105,7 @@ Create a remote key.
-
```typescript
-await client.crm.generateKey.create({
- name: "Remote Deployment Key 1"
-});
+await client.accounting.expenseReports.metaPostRetrieve();
```
@@ -9010,15 +10121,7 @@ await client.crm.generateKey.create({
-
-**request:** `Merge.crm.GenerateRemoteKeyRequest`
-
-
-
-
-
--
-
-**requestOptions:** `GenerateKeyClient.RequestOptions`
+**requestOptions:** `ExpenseReportsClient.RequestOptions`
@@ -9030,8 +10133,7 @@ await client.crm.generateKey.create({
client.crm.issues.list({ ...params }) -> Merge.PaginatedIssueList
+client.accounting.expenseReports.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -9043,7 +10145,7 @@ await client.crm.generateKey.create({
-
-Gets all issues for Organization.
+Returns a list of `RemoteFieldClass` objects.
@@ -9058,22 +10160,35 @@ Gets all issues for Organization.
-
```typescript
-await client.crm.issues.list({
- accountToken: "account_token",
+const pageableResponse = await client.accounting.expenseReports.remoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endDate: "end_date",
- endUserOrganizationName: "end_user_organization_name",
- firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
- firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
- includeMuted: "include_muted",
- integrationName: "integration_name",
- lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
- lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
- linkedAccountId: "linked_account_id",
- pageSize: 1,
- startDate: "start_date",
- status: "ONGOING"
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.expenseReports.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -9089,7 +10204,7 @@ await client.crm.issues.list({
-
-**request:** `Merge.crm.IssuesListRequest`
+**request:** `Merge.accounting.ExpenseReportsRemoteFieldClassesListRequest`
@@ -9097,7 +10212,7 @@ await client.crm.issues.list({
-
-**requestOptions:** `IssuesClient.RequestOptions`
+**requestOptions:** `ExpenseReportsClient.RequestOptions`
@@ -9109,7 +10224,8 @@ await client.crm.issues.list({
client.crm.issues.retrieve(id) -> Merge.Issue
+## Accounting Expenses
+client.accounting.expenses.list({ ...params }) -> core.Page
-
@@ -9121,7 +10237,7 @@ await client.crm.issues.list({
-
-Get a specific issue.
+Returns a list of `Expense` objects.
@@ -9136,7 +10252,49 @@ Get a specific issue.
-
```typescript
-await client.crm.issues.retrieve("id");
+const pageableResponse = await client.accounting.expenses.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.expenses.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -9152,7 +10310,7 @@ await client.crm.issues.retrieve("id");
-
-**id:** `string`
+**request:** `Merge.accounting.ExpensesListRequest`
@@ -9160,7 +10318,7 @@ await client.crm.issues.retrieve("id");
-
-**requestOptions:** `IssuesClient.RequestOptions`
+**requestOptions:** `ExpensesClient.RequestOptions`
@@ -9172,8 +10330,7 @@ await client.crm.issues.retrieve("id");
client.crm.leads.list({ ...params }) -> Merge.PaginatedLeadList
+client.accounting.expenses.create({ ...params }) -> Merge.ExpenseResponse
-
@@ -9185,7 +10342,7 @@ await client.crm.issues.retrieve("id");
-
-Returns a list of `Lead` objects.
+Creates an `Expense` object with the given values.
@@ -9200,24 +10357,10 @@ Returns a list of `Lead` objects.
-
```typescript
-await client.crm.leads.list({
- convertedAccountId: "converted_account_id",
- convertedContactId: "converted_contact_id",
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- emailAddresses: "email_addresses",
- expand: "converted_account",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- ownerId: "owner_id",
- pageSize: 1,
- phoneNumbers: "phone_numbers",
- remoteId: "remote_id"
+await client.accounting.expenses.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -9234,7 +10377,7 @@ await client.crm.leads.list({
-
-**request:** `Merge.crm.LeadsListRequest`
+**request:** `Merge.accounting.ExpenseEndpointRequest`
@@ -9242,7 +10385,7 @@ await client.crm.leads.list({
-
-**requestOptions:** `LeadsClient.RequestOptions`
+**requestOptions:** `ExpensesClient.RequestOptions`
@@ -9254,7 +10397,7 @@ await client.crm.leads.list({
client.crm.leads.create({ ...params }) -> Merge.LeadResponse
+client.accounting.expenses.retrieve(id, { ...params }) -> Merge.Expense
-
@@ -9266,7 +10409,7 @@ await client.crm.leads.list({
-
-Creates a `Lead` object with the given values.
+Returns an `Expense` object with the given `id`.
@@ -9281,10 +10424,10 @@ Creates a `Lead` object with the given values.
-
```typescript
-await client.crm.leads.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
+await client.accounting.expenses.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true
});
```
@@ -9301,7 +10444,7 @@ await client.crm.leads.create({
-
-**request:** `Merge.crm.LeadEndpointRequest`
+**id:** `string`
@@ -9309,7 +10452,15 @@ await client.crm.leads.create({
-
-**requestOptions:** `LeadsClient.RequestOptions`
+**request:** `Merge.accounting.ExpensesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ExpensesClient.RequestOptions`
@@ -9321,7 +10472,7 @@ await client.crm.leads.create({
client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead
+client.accounting.expenses.asyncBulkCreate({ ...params }) -> Merge.ExpenseResponse
-
@@ -9333,7 +10484,7 @@ await client.crm.leads.create({
-
-Returns a `Lead` object with the given `id`.
+Creates an `Expense` object with the given values.
@@ -9348,11 +10499,13 @@ Returns a `Lead` object with the given `id`.
-
```typescript
-await client.crm.leads.retrieve("id", {
- expand: "converted_account",
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true
+await client.accounting.expenses.asyncBulkCreate({
+ isDebugMode: true,
+ runAsync: true,
+ batchItems: [{
+ itemId: "item_id",
+ payload: {}
+ }]
});
```
@@ -9369,7 +10522,7 @@ await client.crm.leads.retrieve("id", {
-
-**id:** `string`
+**request:** `Merge.accounting.ExpenseBulkRequest`
@@ -9377,15 +10530,7 @@ await client.crm.leads.retrieve("id", {
-
-**request:** `Merge.crm.LeadsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LeadsClient.RequestOptions`
+**requestOptions:** `ExpensesClient.RequestOptions`
@@ -9397,7 +10542,7 @@ await client.crm.leads.retrieve("id", {
client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse
+client.accounting.expenses.batchObjectsList(batch_id, { ...params }) -> core.Page
-
@@ -9409,7 +10554,7 @@ await client.crm.leads.retrieve("id", {
-
-Returns metadata for `Lead` POSTs.
+Returns a list of `Expense` objects.
@@ -9424,7 +10569,49 @@ Returns metadata for `Lead` POSTs.
-
```typescript
-await client.crm.leads.metaPostRetrieve();
+const pageableResponse = await client.accounting.expenses.batchObjectsList("batch_id", {
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.expenses.batchObjectsList("batch_id", {
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -9440,7 +10627,23 @@ await client.crm.leads.metaPostRetrieve();
-
-**requestOptions:** `LeadsClient.RequestOptions`
+**batch_id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.ExpensesBatchObjectsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ExpensesClient.RequestOptions`
@@ -9452,7 +10655,7 @@ await client.crm.leads.metaPostRetrieve();
client.crm.leads.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.accounting.expenses.linesRemoteFieldClassesList({ ...params }) -> core.Page
-
@@ -9479,16 +10682,35 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.leads.remoteFieldClassesList({
+const pageableResponse = await client.accounting.expenses.linesRemoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
includeDeletedData: true,
includeRemoteData: true,
- includeRemoteFields: true,
includeShellData: true,
isCommonModelField: true,
isCustom: true,
pageSize: 1
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.expenses.linesRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -9504,7 +10726,7 @@ await client.crm.leads.remoteFieldClassesList({
-
-**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.ExpensesLinesRemoteFieldClassesListRequest`
@@ -9512,7 +10734,7 @@ await client.crm.leads.remoteFieldClassesList({
-
-**requestOptions:** `LeadsClient.RequestOptions`
+**requestOptions:** `ExpensesClient.RequestOptions`
@@ -9524,8 +10746,7 @@ await client.crm.leads.remoteFieldClassesList({
client.crm.linkToken.create({ ...params }) -> Merge.LinkToken
+client.accounting.expenses.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -9537,7 +10758,7 @@ await client.crm.leads.remoteFieldClassesList({
-
-Creates a link token to be used when linking a new end user.
+Returns metadata for `Expense` POSTs.
@@ -9552,12 +10773,7 @@ Creates a link token to be used when linking a new end user.
-
```typescript
-await client.crm.linkToken.create({
- endUserEmailAddress: "example@gmail.com",
- endUserOrganizationName: "Test Organization",
- endUserOriginId: "12345",
- categories: ["hris", "ats"]
-});
+await client.accounting.expenses.metaPostRetrieve();
```
@@ -9573,15 +10789,7 @@ await client.crm.linkToken.create({
-
-**request:** `Merge.crm.EndUserDetailsRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LinkTokenClient.RequestOptions`
+**requestOptions:** `ExpensesClient.RequestOptions`
@@ -9593,8 +10801,7 @@ await client.crm.linkToken.create({
client.crm.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+client.accounting.expenses.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -9606,7 +10813,7 @@ await client.crm.linkToken.create({
-
-List linked accounts for your organization.
+Returns a list of `RemoteFieldClass` objects.
@@ -9621,21 +10828,35 @@ List linked accounts for your organization.
-
```typescript
-await client.crm.linkedAccounts.list({
- category: "accounting",
+const pageableResponse = await client.accounting.expenses.remoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endUserEmailAddress: "end_user_email_address",
- endUserOrganizationName: "end_user_organization_name",
- endUserOriginId: "end_user_origin_id",
- endUserOriginIds: "end_user_origin_ids",
- id: "id",
- ids: "ids",
- includeDuplicates: true,
- integrationName: "integration_name",
- isTestAccount: "is_test_account",
- pageSize: 1,
- status: "status"
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.expenses.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -9651,7 +10872,7 @@ await client.crm.linkedAccounts.list({
-
-**request:** `Merge.crm.LinkedAccountsListRequest`
+**request:** `Merge.accounting.ExpensesRemoteFieldClassesListRequest`
@@ -9659,7 +10880,7 @@ await client.crm.linkedAccounts.list({
-
-**requestOptions:** `LinkedAccountsClient.RequestOptions`
+**requestOptions:** `ExpensesClient.RequestOptions`
@@ -9671,8 +10892,8 @@ await client.crm.linkedAccounts.list({
client.crm.notes.list({ ...params }) -> Merge.PaginatedNoteList
+## Accounting FieldMapping
+client.accounting.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
-
@@ -9684,7 +10905,7 @@ await client.crm.linkedAccounts.list({
-
-Returns a list of `Note` objects.
+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/).
@@ -9699,23 +10920,8 @@ Returns a list of `Note` objects.
-
```typescript
-await client.crm.notes.list({
- accountId: "account_id",
- contactId: "contact_id",
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "account",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- opportunityId: "opportunity_id",
- ownerId: "owner_id",
- pageSize: 1,
- remoteId: "remote_id"
+await client.accounting.fieldMapping.fieldMappingsRetrieve({
+ excludeRemoteFieldMetadata: true
});
```
@@ -9732,7 +10938,7 @@ await client.crm.notes.list({
-
-**request:** `Merge.crm.NotesListRequest`
+**request:** `Merge.accounting.FieldMappingsRetrieveRequest`
@@ -9740,7 +10946,7 @@ await client.crm.notes.list({
-
-**requestOptions:** `NotesClient.RequestOptions`
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -9752,7 +10958,7 @@ await client.crm.notes.list({
client.crm.notes.create({ ...params }) -> Merge.NoteResponse
+client.accounting.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
-
@@ -9764,7 +10970,7 @@ await client.crm.notes.list({
-
-Creates a `Note` object with the given values.
+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.
@@ -9779,10 +10985,15 @@ Creates a `Note` object with the given values.
-
```typescript
-await client.crm.notes.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
+await client.accounting.fieldMapping.fieldMappingsCreate({
+ excludeRemoteFieldMetadata: true,
+ remoteDataIterationCount: 1,
+ targetFieldName: "example_target_field_name",
+ targetFieldDescription: "this is a example description of the target field",
+ remoteFieldTraversalPath: ["example_remote_field"],
+ remoteMethod: "GET",
+ remoteUrlPath: "/example-url-path",
+ commonModelName: "ExampleCommonModel"
});
```
@@ -9799,7 +11010,7 @@ await client.crm.notes.create({
-
-**request:** `Merge.crm.NoteEndpointRequest`
+**request:** `Merge.accounting.CreateFieldMappingRequest`
@@ -9807,7 +11018,7 @@ await client.crm.notes.create({
-
-**requestOptions:** `NotesClient.RequestOptions`
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -9819,7 +11030,7 @@ await client.crm.notes.create({
client.crm.notes.retrieve(id, { ...params }) -> Merge.Note
+client.accounting.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> Merge.FieldMappingInstanceResponse
-
@@ -9831,7 +11042,7 @@ await client.crm.notes.create({
-
-Returns a `Note` object with the given `id`.
+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.
@@ -9846,12 +11057,7 @@ Returns a `Note` object with the given `id`.
-
```typescript
-await client.crm.notes.retrieve("id", {
- expand: "account",
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true
-});
+await client.accounting.fieldMapping.fieldMappingsDestroy("field_mapping_id");
```
@@ -9867,15 +11073,7 @@ await client.crm.notes.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.NotesRetrieveRequest`
+**field_mapping_id:** `string`
@@ -9883,7 +11081,7 @@ await client.crm.notes.retrieve("id", {
-
-**requestOptions:** `NotesClient.RequestOptions`
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -9895,7 +11093,7 @@ await client.crm.notes.retrieve("id", {
client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse
+client.accounting.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...params }) -> Merge.FieldMappingInstanceResponse
-
@@ -9907,7 +11105,7 @@ await client.crm.notes.retrieve("id", {
-
-Returns metadata for `Note` POSTs.
+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.
@@ -9922,7 +11120,9 @@ Returns metadata for `Note` POSTs.
-
```typescript
-await client.crm.notes.metaPostRetrieve();
+await client.accounting.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", {
+ remoteDataIterationCount: 1
+});
```
@@ -9938,7 +11138,23 @@ await client.crm.notes.metaPostRetrieve();
-
-**requestOptions:** `NotesClient.RequestOptions`
+**field_mapping_id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -9950,7 +11166,7 @@ await client.crm.notes.metaPostRetrieve();
client.crm.notes.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.accounting.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
-
@@ -9962,7 +11178,7 @@ await client.crm.notes.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -9977,15 +11193,9 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.notes.remoteFieldClassesList({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- isCommonModelField: true,
- isCustom: true,
- pageSize: 1
+await client.accounting.fieldMapping.remoteFieldsRetrieve({
+ commonModels: "common_models",
+ includeExampleValues: "include_example_values"
});
```
@@ -10002,7 +11212,7 @@ await client.crm.notes.remoteFieldClassesList({
-
-**request:** `Merge.crm.NotesRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.RemoteFieldsRetrieveRequest`
@@ -10010,7 +11220,7 @@ await client.crm.notes.remoteFieldClassesList({
-
-**requestOptions:** `NotesClient.RequestOptions`
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -10022,8 +11232,7 @@ await client.crm.notes.remoteFieldClassesList({
client.crm.opportunities.list({ ...params }) -> Merge.PaginatedOpportunityList
+client.accounting.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
-
@@ -10035,7 +11244,7 @@ await client.crm.notes.remoteFieldClassesList({
-
-Returns a list of `Opportunity` objects.
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -10050,27 +11259,7 @@ Returns a list of `Opportunity` objects.
-
```typescript
-await client.crm.opportunities.list({
- accountId: "account_id",
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "account",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- ownerId: "owner_id",
- pageSize: 1,
- remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"),
- remoteFields: "status",
- remoteId: "remote_id",
- showEnumOrigins: "status",
- stageId: "stage_id",
- status: "LOST"
-});
+await client.accounting.fieldMapping.targetFieldsRetrieve();
```
@@ -10086,15 +11275,7 @@ await client.crm.opportunities.list({
-
-**request:** `Merge.crm.OpportunitiesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `OpportunitiesClient.RequestOptions`
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -10106,7 +11287,8 @@ await client.crm.opportunities.list({
client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse
+## Accounting GeneralLedgerTransactions
+client.accounting.generalLedgerTransactions.list({ ...params }) -> core.Page
-
@@ -10118,7 +11300,7 @@ await client.crm.opportunities.list({
-
-Creates an `Opportunity` object with the given values.
+Returns a list of `GeneralLedgerTransaction` objects.
@@ -10133,11 +11315,47 @@ Creates an `Opportunity` object with the given values.
-
```typescript
-await client.crm.opportunities.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
+const pageableResponse = await client.accounting.generalLedgerTransactions.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ postedDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ postedDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ remoteId: "remote_id"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.generalLedgerTransactions.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ postedDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ postedDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -10153,7 +11371,7 @@ await client.crm.opportunities.create({
-
-**request:** `Merge.crm.OpportunityEndpointRequest`
+**request:** `Merge.accounting.GeneralLedgerTransactionsListRequest`
@@ -10161,7 +11379,7 @@ await client.crm.opportunities.create({
-
-**requestOptions:** `OpportunitiesClient.RequestOptions`
+**requestOptions:** `GeneralLedgerTransactionsClient.RequestOptions`
@@ -10173,7 +11391,7 @@ await client.crm.opportunities.create({
client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity
+client.accounting.generalLedgerTransactions.retrieve(id, { ...params }) -> Merge.GeneralLedgerTransaction
-
@@ -10185,7 +11403,7 @@ await client.crm.opportunities.create({
-
-Returns an `Opportunity` object with the given `id`.
+Returns a `GeneralLedgerTransaction` object with the given `id`.
@@ -10200,13 +11418,9 @@ Returns an `Opportunity` object with the given `id`.
-
```typescript
-await client.crm.opportunities.retrieve("id", {
- expand: "account",
+await client.accounting.generalLedgerTransactions.retrieve("id", {
includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- remoteFields: "status",
- showEnumOrigins: "status"
+ includeShellData: true
});
```
@@ -10231,7 +11445,7 @@ await client.crm.opportunities.retrieve("id", {
-
-**request:** `Merge.crm.OpportunitiesRetrieveRequest`
+**request:** `Merge.accounting.GeneralLedgerTransactionsRetrieveRequest`
@@ -10239,7 +11453,7 @@ await client.crm.opportunities.retrieve("id", {
-
-**requestOptions:** `OpportunitiesClient.RequestOptions`
+**requestOptions:** `GeneralLedgerTransactionsClient.RequestOptions`
@@ -10251,7 +11465,8 @@ await client.crm.opportunities.retrieve("id", {
client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse
+## Accounting GenerateKey
+client.accounting.generateKey.create({ ...params }) -> Merge.RemoteKey
-
@@ -10263,7 +11478,7 @@ await client.crm.opportunities.retrieve("id", {
-
-Updates an `Opportunity` object with the given `id`.
+Create a remote key.
@@ -10278,10 +11493,8 @@ Updates an `Opportunity` object with the given `id`.
-
```typescript
-await client.crm.opportunities.partialUpdate("id", {
- isDebugMode: true,
- runAsync: true,
- model: {}
+await client.accounting.generateKey.create({
+ name: "Remote Deployment Key 1"
});
```
@@ -10298,7 +11511,7 @@ await client.crm.opportunities.partialUpdate("id", {
-
-**id:** `string`
+**request:** `Merge.accounting.GenerateRemoteKeyRequest`
@@ -10306,15 +11519,107 @@ await client.crm.opportunities.partialUpdate("id", {
-
-**request:** `Merge.crm.PatchedOpportunityEndpointRequest`
+**requestOptions:** `GenerateKeyClient.RequestOptions`
+
+
+
+
+
+client.accounting.incomeStatements.list({ ...params }) -> core.Page
-
-**requestOptions:** `OpportunitiesClient.RequestOptions`
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `IncomeStatement` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+const pageableResponse = await client.accounting.incomeStatements.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.incomeStatements.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Merge.accounting.IncomeStatementsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `IncomeStatementsClient.RequestOptions`
@@ -10326,7 +11631,7 @@ await client.crm.opportunities.partialUpdate("id", {
client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse
+client.accounting.incomeStatements.retrieve(id, { ...params }) -> Merge.IncomeStatement
-
@@ -10338,7 +11643,7 @@ await client.crm.opportunities.partialUpdate("id", {
-
-Returns metadata for `Opportunity` PATCHs.
+Returns an `IncomeStatement` object with the given `id`.
@@ -10353,7 +11658,10 @@ Returns metadata for `Opportunity` PATCHs.
-
```typescript
-await client.crm.opportunities.metaPatchRetrieve("id");
+await client.accounting.incomeStatements.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true
+});
```
@@ -10377,7 +11685,15 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-
-**requestOptions:** `OpportunitiesClient.RequestOptions`
+**request:** `Merge.accounting.IncomeStatementsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `IncomeStatementsClient.RequestOptions`
@@ -10389,7 +11705,8 @@ await client.crm.opportunities.metaPatchRetrieve("id");
client.crm.opportunities.metaPostRetrieve() -> Merge.MetaResponse
+## Accounting Invoices
+client.accounting.invoices.list({ ...params }) -> core.Page
-
@@ -10401,7 +11718,7 @@ await client.crm.opportunities.metaPatchRetrieve("id");
-
-Returns metadata for `Opportunity` POSTs.
+Returns a list of `Invoice` objects.
@@ -10416,7 +11733,61 @@ Returns metadata for `Opportunity` POSTs.
-
```typescript
-await client.crm.opportunities.metaPostRetrieve();
+const pageableResponse = await client.accounting.invoices.list({
+ companyId: "company_id",
+ contactId: "contact_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ issueDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ issueDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ number: "number",
+ pageSize: 1,
+ remoteFields: "type",
+ remoteId: "remote_id",
+ showEnumOrigins: "type",
+ status: "DRAFT",
+ type: "ACCOUNTS_PAYABLE"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.invoices.list({
+ companyId: "company_id",
+ contactId: "contact_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ issueDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ issueDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ number: "number",
+ pageSize: 1,
+ remoteFields: "type",
+ remoteId: "remote_id",
+ showEnumOrigins: "type",
+ status: "DRAFT",
+ type: "ACCOUNTS_PAYABLE"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -10432,7 +11803,15 @@ await client.crm.opportunities.metaPostRetrieve();
-
-**requestOptions:** `OpportunitiesClient.RequestOptions`
+**request:** `Merge.accounting.InvoicesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `InvoicesClient.RequestOptions`
@@ -10444,7 +11823,7 @@ await client.crm.opportunities.metaPostRetrieve();
client.crm.opportunities.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.accounting.invoices.create({ ...params }) -> Merge.InvoiceResponse
-
@@ -10456,7 +11835,9 @@ await client.crm.opportunities.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Creates an `Invoice` object with the given values.
+ Including a `PurchaseOrder` id in the `purchase_orders` property will generate an Accounts Payable Invoice from the specified Purchase Order(s).
+
@@ -10471,15 +11852,10 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.opportunities.remoteFieldClassesList({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- isCommonModelField: true,
- isCustom: true,
- pageSize: 1
+await client.accounting.invoices.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -10496,7 +11872,7 @@ await client.crm.opportunities.remoteFieldClassesList({
-
-**request:** `Merge.crm.OpportunitiesRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.InvoiceEndpointRequest`
@@ -10504,7 +11880,7 @@ await client.crm.opportunities.remoteFieldClassesList({
-
-**requestOptions:** `OpportunitiesClient.RequestOptions`
+**requestOptions:** `InvoicesClient.RequestOptions`
@@ -10516,8 +11892,7 @@ await client.crm.opportunities.remoteFieldClassesList({
client.crm.passthrough.create({ ...params }) -> Merge.RemoteResponse
+client.accounting.invoices.retrieve(id, { ...params }) -> Merge.Invoice
-
@@ -10529,7 +11904,7 @@ await client.crm.opportunities.remoteFieldClassesList({
-
-Pull data from an endpoint not currently supported by Merge.
+Returns an `Invoice` object with the given `id`.
@@ -10544,9 +11919,12 @@ Pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.crm.passthrough.create({
- method: "GET",
- path: "/scooters"
+await client.accounting.invoices.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ remoteFields: "type",
+ showEnumOrigins: "type"
});
```
@@ -10563,7 +11941,7 @@ await client.crm.passthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
+**id:** `string`
@@ -10571,7 +11949,15 @@ await client.crm.passthrough.create({
-
-**requestOptions:** `PassthroughClient.RequestOptions`
+**request:** `Merge.accounting.InvoicesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `InvoicesClient.RequestOptions`
@@ -10583,8 +11969,7 @@ await client.crm.passthrough.create({
client.crm.regenerateKey.create({ ...params }) -> Merge.RemoteKey
+client.accounting.invoices.partialUpdate(id, { ...params }) -> Merge.InvoiceResponse
-
@@ -10596,7 +11981,7 @@ await client.crm.passthrough.create({
-
-Exchange remote keys.
+Updates an `Invoice` object with the given `id`.
@@ -10611,8 +11996,10 @@ Exchange remote keys.
-
```typescript
-await client.crm.regenerateKey.create({
- name: "Remote Deployment Key 1"
+await client.accounting.invoices.partialUpdate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -10629,7 +12016,7 @@ await client.crm.regenerateKey.create({
-
-**request:** `Merge.crm.RemoteKeyForRegenerationRequest`
+**id:** `string`
@@ -10637,7 +12024,15 @@ await client.crm.regenerateKey.create({
-
-**requestOptions:** `RegenerateKeyClient.RequestOptions`
+**request:** `Merge.accounting.PatchedInvoiceEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `InvoicesClient.RequestOptions`
@@ -10649,8 +12044,7 @@ await client.crm.regenerateKey.create({
client.crm.stages.list({ ...params }) -> Merge.PaginatedStageList
+client.accounting.invoices.asyncBulkCreate({ ...params }) -> Merge.InvoiceResponse
-
@@ -10662,7 +12056,9 @@ await client.crm.regenerateKey.create({
-
-Returns a list of `Stage` objects.
+Creates an `Invoice` object with the given values.
+ Including a `PurchaseOrder` id in the `purchase_orders` property will generate an Accounts Payable Invoice from the specified Purchase Order(s).
+
@@ -10677,18 +12073,13 @@ Returns a list of `Stage` objects.
-
```typescript
-await client.crm.stages.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteId: "remote_id"
+await client.accounting.invoices.asyncBulkCreate({
+ isDebugMode: true,
+ runAsync: true,
+ batchItems: [{
+ itemId: "item_id",
+ payload: {}
+ }]
});
```
@@ -10705,7 +12096,7 @@ await client.crm.stages.list({
-
-**request:** `Merge.crm.StagesListRequest`
+**request:** `Merge.accounting.InvoiceBulkRequest`
@@ -10713,7 +12104,7 @@ await client.crm.stages.list({
-
-**requestOptions:** `StagesClient.RequestOptions`
+**requestOptions:** `InvoicesClient.RequestOptions`
@@ -10725,7 +12116,7 @@ await client.crm.stages.list({
client.crm.stages.retrieve(id, { ...params }) -> Merge.Stage
+client.accounting.invoices.batchObjectsList(batch_id, { ...params }) -> core.Page
-
@@ -10737,7 +12128,7 @@ await client.crm.stages.list({
-
-Returns a `Stage` object with the given `id`.
+Returns a list of `Invoice` objects.
@@ -10752,11 +12143,61 @@ Returns a `Stage` object with the given `id`.
-
```typescript
-await client.crm.stages.retrieve("id", {
+const pageableResponse = await client.accounting.invoices.batchObjectsList("batch_id", {
+ companyId: "company_id",
+ contactId: "contact_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
includeRemoteData: true,
includeRemoteFields: true,
- includeShellData: true
+ includeShellData: true,
+ issueDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ issueDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ number: "number",
+ pageSize: 1,
+ remoteFields: "type",
+ remoteId: "remote_id",
+ showEnumOrigins: "type",
+ status: "DRAFT",
+ type: "ACCOUNTS_PAYABLE"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.invoices.batchObjectsList("batch_id", {
+ companyId: "company_id",
+ contactId: "contact_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ issueDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ issueDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ number: "number",
+ pageSize: 1,
+ remoteFields: "type",
+ remoteId: "remote_id",
+ showEnumOrigins: "type",
+ status: "DRAFT",
+ type: "ACCOUNTS_PAYABLE"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -10772,7 +12213,7 @@ await client.crm.stages.retrieve("id", {
-
-**id:** `string`
+**batch_id:** `string`
@@ -10780,7 +12221,7 @@ await client.crm.stages.retrieve("id", {
-
-**request:** `Merge.crm.StagesRetrieveRequest`
+**request:** `Merge.accounting.InvoicesBatchObjectsListRequest`
@@ -10788,7 +12229,7 @@ await client.crm.stages.retrieve("id", {
-
-**requestOptions:** `StagesClient.RequestOptions`
+**requestOptions:** `InvoicesClient.RequestOptions`
@@ -10800,7 +12241,7 @@ await client.crm.stages.retrieve("id", {
client.crm.stages.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.accounting.invoices.lineItemsRemoteFieldClassesList({ ...params }) -> core.Page
-
@@ -10827,16 +12268,35 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.stages.remoteFieldClassesList({
+const pageableResponse = await client.accounting.invoices.lineItemsRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.invoices.lineItemsRemoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
includeDeletedData: true,
includeRemoteData: true,
- includeRemoteFields: true,
includeShellData: true,
isCommonModelField: true,
isCustom: true,
pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -10852,7 +12312,7 @@ await client.crm.stages.remoteFieldClassesList({
-
-**request:** `Merge.crm.StagesRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.InvoicesLineItemsRemoteFieldClassesListRequest`
@@ -10860,7 +12320,7 @@ await client.crm.stages.remoteFieldClassesList({
-
-**requestOptions:** `StagesClient.RequestOptions`
+**requestOptions:** `InvoicesClient.RequestOptions`
@@ -10872,8 +12332,7 @@ await client.crm.stages.remoteFieldClassesList({
client.crm.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+client.accounting.invoices.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -10885,7 +12344,7 @@ await client.crm.stages.remoteFieldClassesList({
-
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+Returns metadata for `Invoice` PATCHs.
@@ -10900,10 +12359,7 @@ Get sync status for the current sync and the most recently finished sync. `last_
-
```typescript
-await client.crm.syncStatus.list({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- pageSize: 1
-});
+await client.accounting.invoices.metaPatchRetrieve("id");
```
@@ -10919,7 +12375,7 @@ await client.crm.syncStatus.list({
-
-**request:** `Merge.crm.SyncStatusListRequest`
+**id:** `string`
@@ -10927,7 +12383,7 @@ await client.crm.syncStatus.list({
-
-**requestOptions:** `SyncStatusClient.RequestOptions`
+**requestOptions:** `InvoicesClient.RequestOptions`
@@ -10939,8 +12395,7 @@ await client.crm.syncStatus.list({
client.crm.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+client.accounting.invoices.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -10952,7 +12407,7 @@ await client.crm.syncStatus.list({
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+Returns metadata for `Invoice` POSTs.
@@ -10967,7 +12422,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
-
```typescript
-await client.crm.forceResync.syncStatusResyncCreate();
+await client.accounting.invoices.metaPostRetrieve();
```
@@ -10983,7 +12438,7 @@ await client.crm.forceResync.syncStatusResyncCreate();
-
-**requestOptions:** `ForceResyncClient.RequestOptions`
+**requestOptions:** `InvoicesClient.RequestOptions`
@@ -10995,8 +12450,7 @@ await client.crm.forceResync.syncStatusResyncCreate();
client.crm.tasks.list({ ...params }) -> Merge.PaginatedTaskList
+client.accounting.invoices.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -11008,7 +12462,7 @@ await client.crm.forceResync.syncStatusResyncCreate();
-
-Returns a list of `Task` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -11023,20 +12477,35 @@ Returns a list of `Task` objects.
-
```typescript
-await client.crm.tasks.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+const pageableResponse = await client.accounting.invoices.remoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "account",
includeDeletedData: true,
includeRemoteData: true,
- includeRemoteFields: true,
includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteId: "remote_id"
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.invoices.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -11052,7 +12521,7 @@ await client.crm.tasks.list({
-
-**request:** `Merge.crm.TasksListRequest`
+**request:** `Merge.accounting.InvoicesRemoteFieldClassesListRequest`
@@ -11060,7 +12529,7 @@ await client.crm.tasks.list({
-
-**requestOptions:** `TasksClient.RequestOptions`
+**requestOptions:** `InvoicesClient.RequestOptions`
@@ -11072,7 +12541,8 @@ await client.crm.tasks.list({
client.crm.tasks.create({ ...params }) -> Merge.TaskResponse
+## Accounting Issues
+client.accounting.issues.list({ ...params }) -> core.Page
-
@@ -11084,7 +12554,7 @@ await client.crm.tasks.list({
-
-Creates a `Task` object with the given values.
+Gets all issues for Organization.
@@ -11099,11 +12569,49 @@ Creates a `Task` object with the given values.
-
```typescript
-await client.crm.tasks.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
+const pageableResponse = await client.accounting.issues.list({
+ accountToken: "account_token",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endDate: "end_date",
+ endUserOrganizationName: "end_user_organization_name",
+ firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
+ includeMuted: "include_muted",
+ integrationName: "integration_name",
+ lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
+ linkedAccountId: "linked_account_id",
+ pageSize: 1,
+ startDate: "start_date",
+ status: "ONGOING"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.issues.list({
+ accountToken: "account_token",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endDate: "end_date",
+ endUserOrganizationName: "end_user_organization_name",
+ firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
+ includeMuted: "include_muted",
+ integrationName: "integration_name",
+ lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
+ linkedAccountId: "linked_account_id",
+ pageSize: 1,
+ startDate: "start_date",
+ status: "ONGOING"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -11119,7 +12627,7 @@ await client.crm.tasks.create({
-
-**request:** `Merge.crm.TaskEndpointRequest`
+**request:** `Merge.accounting.IssuesListRequest`
@@ -11127,7 +12635,7 @@ await client.crm.tasks.create({
-
-**requestOptions:** `TasksClient.RequestOptions`
+**requestOptions:** `IssuesClient.RequestOptions`
@@ -11139,7 +12647,7 @@ await client.crm.tasks.create({
client.crm.tasks.retrieve(id, { ...params }) -> Merge.Task
+client.accounting.issues.retrieve(id) -> Merge.Issue
-
@@ -11151,7 +12659,7 @@ await client.crm.tasks.create({
-
-Returns a `Task` object with the given `id`.
+Get a specific issue.
@@ -11166,12 +12674,7 @@ Returns a `Task` object with the given `id`.
-
```typescript
-await client.crm.tasks.retrieve("id", {
- expand: "account",
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true
-});
+await client.accounting.issues.retrieve("id");
```
@@ -11195,15 +12698,7 @@ await client.crm.tasks.retrieve("id", {
-
-**request:** `Merge.crm.TasksRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `TasksClient.RequestOptions`
+**requestOptions:** `IssuesClient.RequestOptions`
@@ -11215,7 +12710,8 @@ await client.crm.tasks.retrieve("id", {
client.crm.tasks.partialUpdate(id, { ...params }) -> Merge.TaskResponse
+## Accounting ItemFulfillments
+client.accounting.itemFulfillments.list({ ...params }) -> core.Page
-
@@ -11227,7 +12723,7 @@ await client.crm.tasks.retrieve("id", {
-
-Updates a `Task` object with the given `id`.
+Returns a list of `ItemFulfillment` objects.
@@ -11242,11 +12738,37 @@ Updates a `Task` object with the given `id`.
-
```typescript
-await client.crm.tasks.partialUpdate("id", {
- isDebugMode: true,
- runAsync: true,
- model: {}
+const pageableResponse = await client.accounting.itemFulfillments.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ pageSize: 1,
+ remoteFields: "status",
+ showEnumOrigins: "status"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.itemFulfillments.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ pageSize: 1,
+ remoteFields: "status",
+ showEnumOrigins: "status"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -11262,15 +12784,7 @@ await client.crm.tasks.partialUpdate("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.PatchedTaskEndpointRequest`
+**request:** `Merge.accounting.ItemFulfillmentsListRequest`
@@ -11278,7 +12792,7 @@ await client.crm.tasks.partialUpdate("id", {
-
-**requestOptions:** `TasksClient.RequestOptions`
+**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
@@ -11290,7 +12804,7 @@ await client.crm.tasks.partialUpdate("id", {
client.crm.tasks.metaPatchRetrieve(id) -> Merge.MetaResponse
+client.accounting.itemFulfillments.create({ ...params }) -> Merge.ItemFulfillmentResponse
-
@@ -11302,7 +12816,7 @@ await client.crm.tasks.partialUpdate("id", {
-
-Returns metadata for `Task` PATCHs.
+Creates an `ItemFulfillment` object with the given values.
@@ -11317,7 +12831,11 @@ Returns metadata for `Task` PATCHs.
-
```typescript
-await client.crm.tasks.metaPatchRetrieve("id");
+await client.accounting.itemFulfillments.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
+});
```
@@ -11333,7 +12851,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-
-**id:** `string`
+**request:** `Merge.accounting.ItemFulfillmentEndpointRequest`
@@ -11341,7 +12859,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-
-**requestOptions:** `TasksClient.RequestOptions`
+**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
@@ -11353,7 +12871,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
client.crm.tasks.metaPostRetrieve() -> Merge.MetaResponse
+client.accounting.itemFulfillments.retrieve(id, { ...params }) -> Merge.ItemFulfillment
-
@@ -11365,7 +12883,7 @@ await client.crm.tasks.metaPatchRetrieve("id");
-
-Returns metadata for `Task` POSTs.
+Returns an `ItemFulfillment` object with the given `id`.
@@ -11380,7 +12898,13 @@ Returns metadata for `Task` POSTs.
-
```typescript
-await client.crm.tasks.metaPostRetrieve();
+await client.accounting.itemFulfillments.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ remoteFields: "status",
+ showEnumOrigins: "status"
+});
```
@@ -11396,7 +12920,23 @@ await client.crm.tasks.metaPostRetrieve();
-
-**requestOptions:** `TasksClient.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.ItemFulfillmentsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
@@ -11408,7 +12948,7 @@ await client.crm.tasks.metaPostRetrieve();
client.crm.tasks.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.accounting.itemFulfillments.asyncBulkCreate({ ...params }) -> Merge.ItemFulfillmentResponse
-
@@ -11420,7 +12960,7 @@ await client.crm.tasks.metaPostRetrieve();
-
-Returns a list of `RemoteFieldClass` objects.
+Creates an `ItemFulfillment` object with the given values.
@@ -11435,15 +12975,13 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.tasks.remoteFieldClassesList({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
- includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true,
- isCommonModelField: true,
- isCustom: true,
- pageSize: 1
+await client.accounting.itemFulfillments.asyncBulkCreate({
+ isDebugMode: true,
+ runAsync: true,
+ batchItems: [{
+ itemId: "item_id",
+ payload: {}
+ }]
});
```
@@ -11460,7 +12998,7 @@ await client.crm.tasks.remoteFieldClassesList({
-
-**request:** `Merge.crm.TasksRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.ItemFulfillmentBulkRequest`
@@ -11468,7 +13006,7 @@ await client.crm.tasks.remoteFieldClassesList({
-
-**requestOptions:** `TasksClient.RequestOptions`
+**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
@@ -11480,8 +13018,7 @@ await client.crm.tasks.remoteFieldClassesList({
client.crm.users.list({ ...params }) -> Merge.PaginatedUserList
+client.accounting.itemFulfillments.batchObjectsList(batch_id, { ...params }) -> core.Page
-
@@ -11493,7 +13030,7 @@ await client.crm.tasks.remoteFieldClassesList({
-
-Returns a list of `User` objects.
+Returns a list of `ItemFulfillment` objects.
@@ -11508,20 +13045,37 @@ Returns a list of `User` objects.
-
```typescript
-await client.crm.users.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+const pageableResponse = await client.accounting.itemFulfillments.batchObjectsList("batch_id", {
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- email: "email",
includeDeletedData: true,
includeRemoteData: true,
includeRemoteFields: true,
includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
pageSize: 1,
- remoteId: "remote_id"
+ remoteFields: "status",
+ showEnumOrigins: "status"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.itemFulfillments.batchObjectsList("batch_id", {
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ pageSize: 1,
+ remoteFields: "status",
+ showEnumOrigins: "status"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -11537,7 +13091,7 @@ await client.crm.users.list({
-
-**request:** `Merge.crm.UsersListRequest`
+**batch_id:** `string`
@@ -11545,7 +13099,15 @@ await client.crm.users.list({
-
-**requestOptions:** `UsersClient.RequestOptions`
+**request:** `Merge.accounting.ItemFulfillmentsBatchObjectsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
@@ -11557,7 +13119,7 @@ await client.crm.users.list({
client.crm.users.retrieve(id, { ...params }) -> Merge.User
+client.accounting.itemFulfillments.linesRemoteFieldClassesList({ ...params }) -> core.Page
-
@@ -11569,7 +13131,7 @@ await client.crm.users.list({
-
-Returns a `User` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -11584,11 +13146,35 @@ Returns a `User` object with the given `id`.
-
```typescript
-await client.crm.users.retrieve("id", {
+const pageableResponse = await client.accounting.itemFulfillments.linesRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
includeRemoteData: true,
- includeRemoteFields: true,
- includeShellData: true
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.itemFulfillments.linesRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -11604,15 +13190,7 @@ await client.crm.users.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.crm.UsersRetrieveRequest`
+**request:** `Merge.accounting.ItemFulfillmentsLinesRemoteFieldClassesListRequest`
@@ -11620,7 +13198,7 @@ await client.crm.users.retrieve("id", {
-
-**requestOptions:** `UsersClient.RequestOptions`
+**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
@@ -11632,7 +13210,7 @@ await client.crm.users.retrieve("id", {
client.crm.users.ignoreCreate(model_id, { ...params }) -> void
+client.accounting.itemFulfillments.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -11644,7 +13222,7 @@ await client.crm.users.retrieve("id", {
-
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+Returns metadata for `ItemFulfillment` POSTs.
@@ -11659,9 +13237,7 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
-
```typescript
-await client.crm.users.ignoreCreate("model_id", {
- reason: "GENERAL_CUSTOMER_REQUEST"
-});
+await client.accounting.itemFulfillments.metaPostRetrieve();
```
@@ -11677,23 +13253,7 @@ await client.crm.users.ignoreCreate("model_id", {
-
-**model_id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.IgnoreCommonModelRequest`
-
-
-
-
-
--
-
-**requestOptions:** `UsersClient.RequestOptions`
+**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
@@ -11705,7 +13265,7 @@ await client.crm.users.ignoreCreate("model_id", {
client.crm.users.remoteFieldClassesList({ ...params }) -> Merge.PaginatedRemoteFieldClassList
+client.accounting.itemFulfillments.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -11732,16 +13292,35 @@ Returns a list of `RemoteFieldClass` objects.
-
```typescript
-await client.crm.users.remoteFieldClassesList({
+const pageableResponse = await client.accounting.itemFulfillments.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.itemFulfillments.remoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
includeDeletedData: true,
includeRemoteData: true,
- includeRemoteFields: true,
includeShellData: true,
isCommonModelField: true,
isCustom: true,
pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -11757,7 +13336,7 @@ await client.crm.users.remoteFieldClassesList({
-
-**request:** `Merge.crm.UsersRemoteFieldClassesListRequest`
+**request:** `Merge.accounting.ItemFulfillmentsRemoteFieldClassesListRequest`
@@ -11765,7 +13344,7 @@ await client.crm.users.remoteFieldClassesList({
-
-**requestOptions:** `UsersClient.RequestOptions`
+**requestOptions:** `ItemFulfillmentsClient.RequestOptions`
@@ -11777,8 +13356,8 @@ await client.crm.users.remoteFieldClassesList({
client.crm.webhookReceivers.list() -> Merge.WebhookReceiver[]
+## Accounting Items
+client.accounting.items.list({ ...params }) -> core.Page
-
@@ -11790,7 +13369,7 @@ await client.crm.users.remoteFieldClassesList({
-
-Returns a list of `WebhookReceiver` objects.
+Returns a list of `Item` objects.
@@ -11805,7 +13384,49 @@ Returns a list of `WebhookReceiver` objects.
-
```typescript
-await client.crm.webhookReceivers.list();
+const pageableResponse = await client.accounting.items.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.items.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -11821,7 +13442,15 @@ await client.crm.webhookReceivers.list();
-
-**requestOptions:** `WebhookReceiversClient.RequestOptions`
+**request:** `Merge.accounting.ItemsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ItemsClient.RequestOptions`
@@ -11833,7 +13462,7 @@ await client.crm.webhookReceivers.list();
client.crm.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
+client.accounting.items.create({ ...params }) -> Merge.ItemResponse
-
@@ -11845,7 +13474,7 @@ await client.crm.webhookReceivers.list();
-
-Creates a `WebhookReceiver` object with the given values.
+Creates an `Item` object with the given values.
@@ -11860,9 +13489,10 @@ Creates a `WebhookReceiver` object with the given values.
-
```typescript
-await client.crm.webhookReceivers.create({
- event: "event",
- isActive: true
+await client.accounting.items.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -11879,7 +13509,7 @@ await client.crm.webhookReceivers.create({
-
-**request:** `Merge.crm.WebhookReceiverRequest`
+**request:** `Merge.accounting.ItemEndpointRequest`
@@ -11887,7 +13517,7 @@ await client.crm.webhookReceivers.create({
-
-**requestOptions:** `WebhookReceiversClient.RequestOptions`
+**requestOptions:** `ItemsClient.RequestOptions`
@@ -11899,8 +13529,7 @@ await client.crm.webhookReceivers.create({
client.filestorage.accountDetails.retrieve() -> Merge.AccountDetails
+client.accounting.items.retrieve(id, { ...params }) -> Merge.Item
-
@@ -11912,7 +13541,7 @@ await client.crm.webhookReceivers.create({
-
-Get details for a linked account.
+Returns an `Item` object with the given `id`.
@@ -11927,7 +13556,12 @@ Get details for a linked account.
-
```typescript
-await client.filestorage.accountDetails.retrieve();
+await client.accounting.items.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true,
+ remoteFields: "status",
+ showEnumOrigins: "status"
+});
```
@@ -11943,7 +13577,23 @@ await client.filestorage.accountDetails.retrieve();
-
-**requestOptions:** `AccountDetailsClient.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.ItemsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ItemsClient.RequestOptions`
@@ -11955,8 +13605,7 @@ await client.filestorage.accountDetails.retrieve();
client.filestorage.accountToken.retrieve(public_token) -> Merge.AccountToken
+client.accounting.items.partialUpdate(id, { ...params }) -> Merge.ItemResponse
-
@@ -11968,7 +13617,7 @@ await client.filestorage.accountDetails.retrieve();
-
-Returns the account token for the end user with the provided public token.
+Updates an `Item` object with the given `id`.
@@ -11983,7 +13632,11 @@ Returns the account token for the end user with the provided public token.
-
```typescript
-await client.filestorage.accountToken.retrieve("public_token");
+await client.accounting.items.partialUpdate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
+});
```
@@ -11999,7 +13652,7 @@ await client.filestorage.accountToken.retrieve("public_token");
-
-**public_token:** `string`
+**id:** `string`
@@ -12007,7 +13660,15 @@ await client.filestorage.accountToken.retrieve("public_token");
-
-**requestOptions:** `AccountTokenClient.RequestOptions`
+**request:** `Merge.accounting.PatchedItemEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ItemsClient.RequestOptions`
@@ -12019,8 +13680,7 @@ await client.filestorage.accountToken.retrieve("public_token");
client.filestorage.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
+client.accounting.items.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -12032,7 +13692,7 @@ await client.filestorage.accountToken.retrieve("public_token");
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns metadata for `Item` PATCHs.
@@ -12047,10 +13707,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.filestorage.asyncPassthrough.create({
- method: "GET",
- path: "/scooters"
-});
+await client.accounting.items.metaPatchRetrieve("id");
```
@@ -12066,7 +13723,7 @@ await client.filestorage.asyncPassthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
+**id:** `string`
@@ -12074,7 +13731,7 @@ await client.filestorage.asyncPassthrough.create({
-
-**requestOptions:** `AsyncPassthroughClient.RequestOptions`
+**requestOptions:** `ItemsClient.RequestOptions`
@@ -12086,7 +13743,7 @@ await client.filestorage.asyncPassthrough.create({
client.filestorage.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
+client.accounting.items.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -12098,7 +13755,7 @@ await client.filestorage.asyncPassthrough.create({
-
-Retrieves data from earlier async-passthrough POST request
+Returns metadata for `Item` POSTs.
@@ -12113,7 +13770,7 @@ Retrieves data from earlier async-passthrough POST request
-
```typescript
-await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+await client.accounting.items.metaPostRetrieve();
```
@@ -12129,15 +13786,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-
-**async_passthrough_receipt_id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `AsyncPassthroughClient.RequestOptions`
+**requestOptions:** `ItemsClient.RequestOptions`
@@ -12149,8 +13798,8 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
client.filestorage.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+## Accounting JournalEntries
+client.accounting.journalEntries.list({ ...params }) -> core.Page
-
@@ -12162,7 +13811,7 @@ await client.filestorage.asyncPassthrough.retrieve("async_passthrough_receipt_id
-
-Gets a list of audit trail events.
+Returns a list of `JournalEntry` objects.
@@ -12177,14 +13826,49 @@ Gets a list of audit trail events.
-
```typescript
-await client.filestorage.auditTrail.list({
+const pageableResponse = await client.accounting.journalEntries.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endDate: "end_date",
- eventType: "event_type",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
pageSize: 1,
- startDate: "start_date",
- userEmail: "user_email"
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.journalEntries.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -12200,7 +13884,7 @@ await client.filestorage.auditTrail.list({
-
-**request:** `Merge.filestorage.AuditTrailListRequest`
+**request:** `Merge.accounting.JournalEntriesListRequest`
@@ -12208,7 +13892,7 @@ await client.filestorage.auditTrail.list({
-
-**requestOptions:** `AuditTrailClient.RequestOptions`
+**requestOptions:** `JournalEntriesClient.RequestOptions`
@@ -12220,8 +13904,7 @@ await client.filestorage.auditTrail.list({
client.filestorage.availableActions.retrieve() -> Merge.AvailableActions
+client.accounting.journalEntries.create({ ...params }) -> Merge.JournalEntryResponse
-
@@ -12233,7 +13916,7 @@ await client.filestorage.auditTrail.list({
-
-Returns a list of models and actions available for an account.
+Creates a `JournalEntry` object with the given values.
@@ -12248,7 +13931,11 @@ Returns a list of models and actions available for an account.
-
```typescript
-await client.filestorage.availableActions.retrieve();
+await client.accounting.journalEntries.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
+});
```
@@ -12264,7 +13951,15 @@ await client.filestorage.availableActions.retrieve();
-
-**requestOptions:** `AvailableActionsClient.RequestOptions`
+**request:** `Merge.accounting.JournalEntryEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JournalEntriesClient.RequestOptions`
@@ -12276,8 +13971,7 @@ await client.filestorage.availableActions.retrieve();
client.filestorage.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
+client.accounting.journalEntries.retrieve(id, { ...params }) -> Merge.JournalEntry
-
@@ -12289,7 +13983,7 @@ await client.filestorage.availableActions.retrieve();
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a `JournalEntry` object with the given `id`.
@@ -12304,7 +13998,11 @@ Get the default permissions for Merge Common Models and fields across all Linked
-
```typescript
-await client.filestorage.scopes.defaultScopesRetrieve();
+await client.accounting.journalEntries.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true
+});
```
@@ -12320,7 +14018,23 @@ await client.filestorage.scopes.defaultScopesRetrieve();
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.JournalEntriesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JournalEntriesClient.RequestOptions`
@@ -12332,7 +14046,7 @@ await client.filestorage.scopes.defaultScopesRetrieve();
client.filestorage.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
+client.accounting.journalEntries.linesRemoteFieldClassesList({ ...params }) -> core.Page
-
@@ -12344,7 +14058,7 @@ await client.filestorage.scopes.defaultScopesRetrieve();
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a list of `RemoteFieldClass` objects.
@@ -12359,7 +14073,35 @@ Get all available permissions for Merge Common Models and fields for a single Li
-
```typescript
-await client.filestorage.scopes.linkedAccountScopesRetrieve();
+const pageableResponse = await client.accounting.journalEntries.linesRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.journalEntries.linesRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -12375,7 +14117,15 @@ await client.filestorage.scopes.linkedAccountScopesRetrieve();
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**request:** `Merge.accounting.JournalEntriesLinesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `JournalEntriesClient.RequestOptions`
@@ -12387,7 +14137,7 @@ await client.filestorage.scopes.linkedAccountScopesRetrieve();
client.filestorage.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
+client.accounting.journalEntries.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -12399,7 +14149,7 @@ await client.filestorage.scopes.linkedAccountScopesRetrieve();
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+Returns metadata for `JournalEntry` POSTs.
@@ -12414,30 +14164,7 @@ Update permissions for any Common Model or field for a single Linked Account. An
-
```typescript
-await client.filestorage.scopes.linkedAccountScopesCreate({
- commonModels: [{
- modelName: "Employee",
- modelPermissions: {
- "READ": {
- isEnabled: true
- },
- "WRITE": {
- isEnabled: false
- }
- },
- fieldPermissions: {
- enabledFields: ["avatar", "home_location"],
- disabledFields: ["work_location"]
- }
- }, {
- modelName: "Benefit",
- modelPermissions: {
- "WRITE": {
- isEnabled: false
- }
- }
- }]
-});
+await client.accounting.journalEntries.metaPostRetrieve();
```
@@ -12453,15 +14180,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-
-**request:** `Merge.filestorage.LinkedAccountCommonModelScopeDeserializerRequest`
-
-
-
-
-
--
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**requestOptions:** `JournalEntriesClient.RequestOptions`
@@ -12473,8 +14192,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
client.filestorage.deleteAccount.delete() -> void
+client.accounting.journalEntries.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -12486,7 +14204,7 @@ await client.filestorage.scopes.linkedAccountScopesCreate({
-
-Delete a linked account.
+Returns a list of `RemoteFieldClass` objects.
@@ -12501,75 +14219,35 @@ Delete a linked account.
-
```typescript
-await client.filestorage.deleteAccount.delete();
+const pageableResponse = await client.accounting.journalEntries.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `DeleteAccountClient.RequestOptions`
-
-
-
-
-
-
-
-
-
-client.filestorage.drives.list({ ...params }) -> Merge.PaginatedDriveList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Drive` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.filestorage.drives.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+// Or you can manually iterate page-by-page
+let page = await client.accounting.journalEntries.remoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- name: "name",
- pageSize: 1,
- remoteId: "remote_id"
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -12585,7 +14263,7 @@ await client.filestorage.drives.list({
-
-**request:** `Merge.filestorage.DrivesListRequest`
+**request:** `Merge.accounting.JournalEntriesRemoteFieldClassesListRequest`
@@ -12593,7 +14271,7 @@ await client.filestorage.drives.list({
-
-**requestOptions:** `DrivesClient.RequestOptions`
+**requestOptions:** `JournalEntriesClient.RequestOptions`
@@ -12605,7 +14283,8 @@ await client.filestorage.drives.list({
client.filestorage.drives.retrieve(id, { ...params }) -> Merge.Drive
+## Accounting LinkToken
+client.accounting.linkToken.create({ ...params }) -> Merge.LinkToken
-
@@ -12617,7 +14296,7 @@ await client.filestorage.drives.list({
-
-Returns a `Drive` object with the given `id`.
+Creates a link token to be used when linking a new end user. The link token expires after single use.
@@ -12632,9 +14311,11 @@ Returns a `Drive` object with the given `id`.
-
```typescript
-await client.filestorage.drives.retrieve("id", {
- includeRemoteData: true,
- includeShellData: true
+await client.accounting.linkToken.create({
+ endUserEmailAddress: "example@gmail.com",
+ endUserOrganizationName: "Test Organization",
+ endUserOriginId: "12345",
+ categories: ["hris", "ats"]
});
```
@@ -12651,15 +14332,7 @@ await client.filestorage.drives.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.filestorage.DrivesRetrieveRequest`
+**request:** `Merge.accounting.EndUserDetailsRequest`
@@ -12667,7 +14340,7 @@ await client.filestorage.drives.retrieve("id", {
-
-**requestOptions:** `DrivesClient.RequestOptions`
+**requestOptions:** `LinkTokenClient.RequestOptions`
@@ -12679,8 +14352,8 @@ await client.filestorage.drives.retrieve("id", {
client.filestorage.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
+## Accounting LinkedAccounts
+client.accounting.linkedAccounts.list({ ...params }) -> core.Page
-
@@ -12692,7 +14365,7 @@ await client.filestorage.drives.retrieve("id", {
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+List linked accounts for your organization.
@@ -12707,9 +14380,47 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
-
```typescript
-await client.filestorage.fieldMapping.fieldMappingsRetrieve({
- excludeRemoteFieldMetadata: true
+const pageableResponse = await client.accounting.linkedAccounts.list({
+ category: "accounting",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endUserEmailAddress: "end_user_email_address",
+ endUserOrganizationName: "end_user_organization_name",
+ endUserOriginId: "end_user_origin_id",
+ endUserOriginIds: "end_user_origin_ids",
+ id: "id",
+ ids: "ids",
+ includeDuplicates: true,
+ integrationName: "integration_name",
+ isTestAccount: "is_test_account",
+ pageSize: 1,
+ status: "status"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.linkedAccounts.list({
+ category: "accounting",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endUserEmailAddress: "end_user_email_address",
+ endUserOrganizationName: "end_user_organization_name",
+ endUserOriginId: "end_user_origin_id",
+ endUserOriginIds: "end_user_origin_ids",
+ id: "id",
+ ids: "ids",
+ includeDuplicates: true,
+ integrationName: "integration_name",
+ isTestAccount: "is_test_account",
+ pageSize: 1,
+ status: "status"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -12725,7 +14436,7 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve({
-
-**request:** `Merge.filestorage.FieldMappingsRetrieveRequest`
+**request:** `Merge.accounting.LinkedAccountsListRequest`
@@ -12733,7 +14444,7 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve({
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `LinkedAccountsClient.RequestOptions`
@@ -12745,7 +14456,8 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve({
client.filestorage.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
+## Accounting Passthrough
+client.accounting.passthrough.create({ ...params }) -> Merge.RemoteResponse
-
@@ -12757,7 +14469,7 @@ await client.filestorage.fieldMapping.fieldMappingsRetrieve({
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Pull data from an endpoint not currently supported by Merge.
@@ -12772,14 +14484,9 @@ Create new Field Mappings that will be available after the next scheduled sync.
-
```typescript
-await client.filestorage.fieldMapping.fieldMappingsCreate({
- excludeRemoteFieldMetadata: true,
- targetFieldName: "example_target_field_name",
- targetFieldDescription: "this is a example description of the target field",
- remoteFieldTraversalPath: ["example_remote_field"],
- remoteMethod: "GET",
- remoteUrlPath: "/example-url-path",
- commonModelName: "ExampleCommonModel"
+await client.accounting.passthrough.create({
+ method: "GET",
+ path: "/scooters"
});
```
@@ -12796,7 +14503,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-
-**request:** `Merge.filestorage.CreateFieldMappingRequest`
+**request:** `Merge.DataPassthroughRequest`
@@ -12804,7 +14511,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `PassthroughClient.RequestOptions`
@@ -12816,7 +14523,8 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
client.filestorage.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> Merge.FieldMappingInstanceResponse
+## Accounting PaymentMethods
+client.accounting.paymentMethods.list({ ...params }) -> core.Page
-
@@ -12828,7 +14536,7 @@ await client.filestorage.fieldMapping.fieldMappingsCreate({
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `PaymentMethod` objects.
@@ -12843,7 +14551,31 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
-
```typescript
-await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+const pageableResponse = await client.accounting.paymentMethods.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.paymentMethods.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -12859,7 +14591,7 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**field_mapping_id:** `string`
+**request:** `Merge.accounting.PaymentMethodsListRequest`
@@ -12867,7 +14599,7 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `PaymentMethodsClient.RequestOptions`
@@ -12879,7 +14611,7 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
client.filestorage.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...params }) -> Merge.FieldMappingInstanceResponse
+client.accounting.paymentMethods.retrieve(id, { ...params }) -> Merge.PaymentMethod
-
@@ -12891,7 +14623,7 @@ await client.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a `PaymentMethod` object with the given `id`.
@@ -12906,7 +14638,10 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
-
```typescript
-await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+await client.accounting.paymentMethods.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true
+});
```
@@ -12922,7 +14657,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-
-**field_mapping_id:** `string`
+**id:** `string`
@@ -12930,7 +14665,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-
-**request:** `Merge.filestorage.PatchedEditFieldMappingRequest`
+**request:** `Merge.accounting.PaymentMethodsRetrieveRequest`
@@ -12938,7 +14673,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `PaymentMethodsClient.RequestOptions`
@@ -12950,7 +14685,8 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
client.filestorage.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
+## Accounting PaymentTerms
+client.accounting.paymentTerms.list({ ...params }) -> core.Page
-
@@ -12962,7 +14698,7 @@ await client.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns a list of `PaymentTerm` objects.
@@ -12977,10 +14713,31 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
-
```typescript
-await client.filestorage.fieldMapping.remoteFieldsRetrieve({
- commonModels: "common_models",
- includeExampleValues: "include_example_values"
+const pageableResponse = await client.accounting.paymentTerms.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ pageSize: 1
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.paymentTerms.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -12996,7 +14753,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve({
-
-**request:** `Merge.filestorage.RemoteFieldsRetrieveRequest`
+**request:** `Merge.accounting.PaymentTermsListRequest`
@@ -13004,7 +14761,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve({
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `PaymentTermsClient.RequestOptions`
@@ -13016,7 +14773,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve({
client.filestorage.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
+client.accounting.paymentTerms.retrieve(id, { ...params }) -> Merge.PaymentTerm
-
@@ -13028,7 +14785,7 @@ await client.filestorage.fieldMapping.remoteFieldsRetrieve({
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Returns a `PaymentTerm` object with the given `id`.
@@ -13043,7 +14800,10 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
-
```typescript
-await client.filestorage.fieldMapping.targetFieldsRetrieve();
+await client.accounting.paymentTerms.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true
+});
```
@@ -13059,7 +14819,23 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.accounting.PaymentTermsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PaymentTermsClient.RequestOptions`
@@ -13071,8 +14847,8 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
client.filestorage.files.list({ ...params }) -> Merge.PaginatedFileList
+## Accounting Payments
+client.accounting.payments.list({ ...params }) -> core.Page
-
@@ -13084,7 +14860,7 @@ await client.filestorage.fieldMapping.targetFieldsRetrieve();
-
-Returns a list of `File` objects.
+Returns a list of `Payment` objects.
@@ -13099,26 +14875,53 @@ Returns a list of `File` objects.
-
```typescript
-await client.filestorage.files.list({
+const pageableResponse = await client.accounting.payments.list({
+ accountId: "account_id",
+ companyId: "company_id",
+ contactId: "contact_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- driveId: "drive_id",
- expand: "drive",
- folderId: "folder_id",
includeDeletedData: true,
includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true,
- mimeType: "mime_type",
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- name: "name",
- orderBy: "-created_at",
pageSize: 1,
- remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"),
- remoteCreatedBefore: new Date("2024-01-15T09:30:00.000Z"),
- remoteId: "remote_id"
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.payments.list({
+ accountId: "account_id",
+ companyId: "company_id",
+ contactId: "contact_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -13134,7 +14937,7 @@ await client.filestorage.files.list({
-
-**request:** `Merge.filestorage.FilesListRequest`
+**request:** `Merge.accounting.PaymentsListRequest`
@@ -13142,7 +14945,7 @@ await client.filestorage.files.list({
-
-**requestOptions:** `FilesClient.RequestOptions`
+**requestOptions:** `PaymentsClient.RequestOptions`
@@ -13154,7 +14957,7 @@ await client.filestorage.files.list({
client.filestorage.files.create({ ...params }) -> Merge.FileStorageFileResponse
+client.accounting.payments.create({ ...params }) -> Merge.PaymentResponse
-
@@ -13166,7 +14969,7 @@ await client.filestorage.files.list({
-
-Creates a `File` object with the given values.
+Creates a `Payment` object with the given values.
@@ -13181,7 +14984,7 @@ Creates a `File` object with the given values.
-
```typescript
-await client.filestorage.files.create({
+await client.accounting.payments.create({
isDebugMode: true,
runAsync: true,
model: {}
@@ -13201,7 +15004,7 @@ await client.filestorage.files.create({
-
-**request:** `Merge.filestorage.FileStorageFileEndpointRequest`
+**request:** `Merge.accounting.PaymentEndpointRequest`
@@ -13209,7 +15012,7 @@ await client.filestorage.files.create({
-
-**requestOptions:** `FilesClient.RequestOptions`
+**requestOptions:** `PaymentsClient.RequestOptions`
@@ -13221,7 +15024,7 @@ await client.filestorage.files.create({
client.filestorage.files.retrieve(id, { ...params }) -> Merge.File_
+client.accounting.payments.retrieve(id, { ...params }) -> Merge.Payment
-
@@ -13233,7 +15036,7 @@ await client.filestorage.files.create({
-
-Returns a `File` object with the given `id`.
+Returns a `Payment` object with the given `id`.
@@ -13248,9 +15051,9 @@ Returns a `File` object with the given `id`.
-
```typescript
-await client.filestorage.files.retrieve("id", {
- expand: "drive",
+await client.accounting.payments.retrieve("id", {
includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true
});
@@ -13276,7 +15079,7 @@ await client.filestorage.files.retrieve("id", {
-
-**request:** `Merge.filestorage.FilesRetrieveRequest`
+**request:** `Merge.accounting.PaymentsRetrieveRequest`
@@ -13284,7 +15087,7 @@ await client.filestorage.files.retrieve("id", {
-
-**requestOptions:** `FilesClient.RequestOptions`
+**requestOptions:** `PaymentsClient.RequestOptions`
@@ -13296,7 +15099,7 @@ await client.filestorage.files.retrieve("id", {
client.filestorage.files.downloadRequestMetaRetrieve(id, { ...params }) -> Merge.DownloadRequestMeta
+client.accounting.payments.partialUpdate(id, { ...params }) -> Merge.PaymentResponse
-
@@ -13308,7 +15111,7 @@ await client.filestorage.files.retrieve("id", {
-
-Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
+Updates a `Payment` object with the given `id`.
@@ -13323,8 +15126,10 @@ Returns metadata to construct an authenticated file download request for a singu
-
```typescript
-await client.filestorage.files.downloadRequestMetaRetrieve("id", {
- mimeType: "mime_type"
+await client.accounting.payments.partialUpdate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -13349,7 +15154,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id", {
-
-**request:** `Merge.filestorage.FilesDownloadRequestMetaRetrieveRequest`
+**request:** `Merge.accounting.PatchedPaymentEndpointRequest`
@@ -13357,7 +15162,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id", {
-
-**requestOptions:** `FilesClient.RequestOptions`
+**requestOptions:** `PaymentsClient.RequestOptions`
@@ -13369,7 +15174,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id", {
client.filestorage.files.downloadRequestMetaList({ ...params }) -> Merge.PaginatedDownloadRequestMetaList
+client.accounting.payments.lineItemsRemoteFieldClassesList({ ...params }) -> core.Page
-
@@ -13381,7 +15186,7 @@ await client.filestorage.files.downloadRequestMetaRetrieve("id", {
-
-Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
+Returns a list of `RemoteFieldClass` objects.
@@ -13396,17 +15201,35 @@ Returns metadata to construct authenticated file download requests, allowing you
-
```typescript
-await client.filestorage.files.downloadRequestMetaList({
- createdAfter: "created_after",
- createdBefore: "created_before",
+const pageableResponse = await client.accounting.payments.lineItemsRemoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
includeDeletedData: true,
- mimeTypes: "mime_types",
- modifiedAfter: "modified_after",
- modifiedBefore: "modified_before",
- orderBy: "-created_at",
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.payments.lineItemsRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -13422,70 +15245,15 @@ await client.filestorage.files.downloadRequestMetaList({
-
-**request:** `Merge.filestorage.FilesDownloadRequestMetaListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `FilesClient.RequestOptions`
+**request:** `Merge.accounting.PaymentsLineItemsRemoteFieldClassesListRequest`
-
-
-
-
-
-client.filestorage.files.metaPostRetrieve() -> Merge.MetaResponse
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `FileStorageFile` POSTs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.filestorage.files.metaPostRetrieve();
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `FilesClient.RequestOptions`
+**requestOptions:** `PaymentsClient.RequestOptions`
@@ -13497,8 +15265,7 @@ await client.filestorage.files.metaPostRetrieve();
client.filestorage.folders.list({ ...params }) -> Merge.PaginatedFolderList
+client.accounting.payments.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -13510,7 +15277,7 @@ await client.filestorage.files.metaPostRetrieve();
-
-Returns a list of `Folder` objects.
+Returns metadata for `Payment` PATCHs.
@@ -13525,22 +15292,7 @@ Returns a list of `Folder` objects.
-
```typescript
-await client.filestorage.folders.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- driveId: "drive_id",
- expand: "drive",
- includeDeletedData: true,
- includeRemoteData: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- name: "name",
- pageSize: 1,
- parentFolderId: "parent_folder_id",
- remoteId: "remote_id"
-});
+await client.accounting.payments.metaPatchRetrieve("id");
```
@@ -13556,7 +15308,7 @@ await client.filestorage.folders.list({
-
-**request:** `Merge.filestorage.FoldersListRequest`
+**id:** `string`
@@ -13564,7 +15316,7 @@ await client.filestorage.folders.list({
-
-**requestOptions:** `FoldersClient.RequestOptions`
+**requestOptions:** `PaymentsClient.RequestOptions`
@@ -13576,7 +15328,7 @@ await client.filestorage.folders.list({
client.filestorage.folders.create({ ...params }) -> Merge.FileStorageFolderResponse
+client.accounting.payments.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -13588,7 +15340,7 @@ await client.filestorage.folders.list({
-
-Creates a `Folder` object with the given values.
+Returns metadata for `Payment` POSTs.
@@ -13603,11 +15355,7 @@ Creates a `Folder` object with the given values.
-
```typescript
-await client.filestorage.folders.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
-});
+await client.accounting.payments.metaPostRetrieve();
```
@@ -13623,15 +15371,7 @@ await client.filestorage.folders.create({
-
-**request:** `Merge.filestorage.FileStorageFolderEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `FoldersClient.RequestOptions`
+**requestOptions:** `PaymentsClient.RequestOptions`
@@ -13643,7 +15383,7 @@ await client.filestorage.folders.create({
client.filestorage.folders.retrieve(id, { ...params }) -> Merge.Folder
+client.accounting.payments.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -13655,7 +15395,7 @@ await client.filestorage.folders.create({
-
-Returns a `Folder` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -13670,11 +15410,35 @@ Returns a `Folder` object with the given `id`.
-
```typescript
-await client.filestorage.folders.retrieve("id", {
- expand: "drive",
+const pageableResponse = await client.accounting.payments.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
includeRemoteData: true,
- includeShellData: true
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.payments.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -13690,15 +15454,7 @@ await client.filestorage.folders.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.filestorage.FoldersRetrieveRequest`
+**request:** `Merge.accounting.PaymentsRemoteFieldClassesListRequest`
@@ -13706,7 +15462,7 @@ await client.filestorage.folders.retrieve("id", {
-
-**requestOptions:** `FoldersClient.RequestOptions`
+**requestOptions:** `PaymentsClient.RequestOptions`
@@ -13718,7 +15474,8 @@ await client.filestorage.folders.retrieve("id", {
client.filestorage.folders.metaPostRetrieve() -> Merge.MetaResponse
+## Accounting PhoneNumbers
+client.accounting.phoneNumbers.retrieve(id, { ...params }) -> Merge.AccountingPhoneNumber
-
@@ -13730,7 +15487,7 @@ await client.filestorage.folders.retrieve("id", {
-
-Returns metadata for `FileStorageFolder` POSTs.
+Returns an `AccountingPhoneNumber` object with the given `id`.
@@ -13745,7 +15502,10 @@ Returns metadata for `FileStorageFolder` POSTs.
-
```typescript
-await client.filestorage.folders.metaPostRetrieve();
+await client.accounting.phoneNumbers.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true
+});
```
@@ -13761,65 +15521,15 @@ await client.filestorage.folders.metaPostRetrieve();
-
-**requestOptions:** `FoldersClient.RequestOptions`
+**id:** `string`
-
-
-
-
-
-
-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`
+**request:** `Merge.accounting.PhoneNumbersRetrieveRequest`
@@ -13827,7 +15537,7 @@ await client.filestorage.generateKey.create({
-
-**requestOptions:** `GenerateKeyClient.RequestOptions`
+**requestOptions:** `PhoneNumbersClient.RequestOptions`
@@ -13839,8 +15549,8 @@ await client.filestorage.generateKey.create({
client.filestorage.groups.list({ ...params }) -> Merge.PaginatedGroupList
+## Accounting Projects
+client.accounting.projects.list({ ...params }) -> core.Page
-
@@ -13852,7 +15562,7 @@ await client.filestorage.generateKey.create({
-
-Returns a list of `Group` objects.
+Returns a list of `Project` objects.
@@ -13867,11 +15577,11 @@ Returns a list of `Group` objects.
-
```typescript
-await client.filestorage.groups.list({
+const pageableResponse = await client.accounting.projects.list({
+ companyId: "company_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "child_groups",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
@@ -13880,6 +15590,30 @@ await client.filestorage.groups.list({
pageSize: 1,
remoteId: "remote_id"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.projects.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -13895,7 +15629,7 @@ await client.filestorage.groups.list({
-
-**request:** `Merge.filestorage.GroupsListRequest`
+**request:** `Merge.accounting.ProjectsListRequest`
@@ -13903,7 +15637,7 @@ await client.filestorage.groups.list({
-
-**requestOptions:** `GroupsClient.RequestOptions`
+**requestOptions:** `ProjectsClient.RequestOptions`
@@ -13915,7 +15649,7 @@ await client.filestorage.groups.list({
client.filestorage.groups.retrieve(id, { ...params }) -> Merge.Group
+client.accounting.projects.retrieve(id, { ...params }) -> Merge.Project
-
@@ -13927,7 +15661,7 @@ await client.filestorage.groups.list({
-
-Returns a `Group` object with the given `id`.
+Returns a `Project` object with the given `id`.
@@ -13942,8 +15676,7 @@ Returns a `Group` object with the given `id`.
-
```typescript
-await client.filestorage.groups.retrieve("id", {
- expand: "child_groups",
+await client.accounting.projects.retrieve("id", {
includeRemoteData: true,
includeShellData: true
});
@@ -13970,7 +15703,7 @@ await client.filestorage.groups.retrieve("id", {
-
-**request:** `Merge.filestorage.GroupsRetrieveRequest`
+**request:** `Merge.accounting.ProjectsRetrieveRequest`
@@ -13978,7 +15711,7 @@ await client.filestorage.groups.retrieve("id", {
-
-**requestOptions:** `GroupsClient.RequestOptions`
+**requestOptions:** `ProjectsClient.RequestOptions`
@@ -13990,8 +15723,8 @@ await client.filestorage.groups.retrieve("id", {
client.filestorage.issues.list({ ...params }) -> Merge.PaginatedIssueList
+## Accounting PurchaseOrders
+client.accounting.purchaseOrders.list({ ...params }) -> core.Page
-
@@ -14003,7 +15736,7 @@ await client.filestorage.groups.retrieve("id", {
-
-Gets all issues for Organization.
+Returns a list of `PurchaseOrder` objects.
@@ -14018,22 +15751,53 @@ Gets all issues for Organization.
-
```typescript
-await client.filestorage.issues.list({
- accountToken: "account_token",
+const pageableResponse = await client.accounting.purchaseOrders.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endDate: "end_date",
- endUserOrganizationName: "end_user_organization_name",
- firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
- firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
- includeMuted: "include_muted",
- integrationName: "integration_name",
- lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
- lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
- linkedAccountId: "linked_account_id",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ issueDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ issueDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
pageSize: 1,
- startDate: "start_date",
- status: "ONGOING"
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.purchaseOrders.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ issueDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ issueDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -14049,7 +15813,7 @@ await client.filestorage.issues.list({
-
-**request:** `Merge.filestorage.IssuesListRequest`
+**request:** `Merge.accounting.PurchaseOrdersListRequest`
@@ -14057,7 +15821,7 @@ await client.filestorage.issues.list({
-
-**requestOptions:** `IssuesClient.RequestOptions`
+**requestOptions:** `PurchaseOrdersClient.RequestOptions`
@@ -14069,7 +15833,7 @@ await client.filestorage.issues.list({
client.filestorage.issues.retrieve(id) -> Merge.Issue
+client.accounting.purchaseOrders.create({ ...params }) -> Merge.PurchaseOrderResponse
-
@@ -14081,7 +15845,7 @@ await client.filestorage.issues.list({
-
-Get a specific issue.
+Creates a `PurchaseOrder` object with the given values.
@@ -14096,7 +15860,11 @@ Get a specific issue.
-
```typescript
-await client.filestorage.issues.retrieve("id");
+await client.accounting.purchaseOrders.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
+});
```
@@ -14112,7 +15880,7 @@ await client.filestorage.issues.retrieve("id");
-
-**id:** `string`
+**request:** `Merge.accounting.PurchaseOrderEndpointRequest`
@@ -14120,7 +15888,7 @@ await client.filestorage.issues.retrieve("id");
-
-**requestOptions:** `IssuesClient.RequestOptions`
+**requestOptions:** `PurchaseOrdersClient.RequestOptions`
@@ -14132,8 +15900,7 @@ await client.filestorage.issues.retrieve("id");
client.filestorage.linkToken.create({ ...params }) -> Merge.LinkToken
+client.accounting.purchaseOrders.retrieve(id, { ...params }) -> Merge.PurchaseOrder
-
@@ -14145,7 +15912,7 @@ await client.filestorage.issues.retrieve("id");
-
-Creates a link token to be used when linking a new end user.
+Returns a `PurchaseOrder` object with the given `id`.
@@ -14160,11 +15927,12 @@ Creates a link token to be used when linking a new end user.
-
```typescript
-await client.filestorage.linkToken.create({
- endUserEmailAddress: "example@gmail.com",
- endUserOrganizationName: "Test Organization",
- endUserOriginId: "12345",
- categories: ["hris", "ats"]
+await client.accounting.purchaseOrders.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ remoteFields: "status",
+ showEnumOrigins: "status"
});
```
@@ -14181,7 +15949,7 @@ await client.filestorage.linkToken.create({
-
-**request:** `Merge.filestorage.EndUserDetailsRequest`
+**id:** `string`
@@ -14189,7 +15957,15 @@ await client.filestorage.linkToken.create({
-
-**requestOptions:** `LinkTokenClient.RequestOptions`
+**request:** `Merge.accounting.PurchaseOrdersRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `PurchaseOrdersClient.RequestOptions`
@@ -14201,8 +15977,7 @@ await client.filestorage.linkToken.create({
client.filestorage.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList({ ...params }) -> core.Page
-
@@ -14214,7 +15989,7 @@ await client.filestorage.linkToken.create({
-
-List linked accounts for your organization.
+Returns a list of `RemoteFieldClass` objects.
@@ -14229,21 +16004,35 @@ List linked accounts for your organization.
-
```typescript
-await client.filestorage.linkedAccounts.list({
- category: "accounting",
+const pageableResponse = await client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endUserEmailAddress: "end_user_email_address",
- endUserOrganizationName: "end_user_organization_name",
- endUserOriginId: "end_user_origin_id",
- endUserOriginIds: "end_user_origin_ids",
- id: "id",
- ids: "ids",
- includeDuplicates: true,
- integrationName: "integration_name",
- isTestAccount: "is_test_account",
- pageSize: 1,
- status: "status"
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.purchaseOrders.lineItemsRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -14259,7 +16048,7 @@ await client.filestorage.linkedAccounts.list({
-
-**request:** `Merge.filestorage.LinkedAccountsListRequest`
+**request:** `Merge.accounting.PurchaseOrdersLineItemsRemoteFieldClassesListRequest`
@@ -14267,7 +16056,7 @@ await client.filestorage.linkedAccounts.list({
-
-**requestOptions:** `LinkedAccountsClient.RequestOptions`
+**requestOptions:** `PurchaseOrdersClient.RequestOptions`
@@ -14279,8 +16068,7 @@ await client.filestorage.linkedAccounts.list({
client.filestorage.passthrough.create({ ...params }) -> Merge.RemoteResponse
+client.accounting.purchaseOrders.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -14292,7 +16080,7 @@ await client.filestorage.linkedAccounts.list({
-
-Pull data from an endpoint not currently supported by Merge.
+Returns metadata for `PurchaseOrder` POSTs.
@@ -14307,10 +16095,7 @@ Pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.filestorage.passthrough.create({
- method: "GET",
- path: "/scooters"
-});
+await client.accounting.purchaseOrders.metaPostRetrieve();
```
@@ -14326,15 +16111,7 @@ await client.filestorage.passthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
-
-
-
-
-
--
-
-**requestOptions:** `PassthroughClient.RequestOptions`
+**requestOptions:** `PurchaseOrdersClient.RequestOptions`
@@ -14346,8 +16123,7 @@ await client.filestorage.passthrough.create({
client.filestorage.regenerateKey.create({ ...params }) -> Merge.RemoteKey
+client.accounting.purchaseOrders.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -14359,7 +16135,7 @@ await client.filestorage.passthrough.create({
-
-Exchange remote keys.
+Returns a list of `RemoteFieldClass` objects.
@@ -14374,9 +16150,35 @@ Exchange remote keys.
-
```typescript
-await client.filestorage.regenerateKey.create({
- name: "Remote Deployment Key 1"
+const pageableResponse = await client.accounting.purchaseOrders.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.purchaseOrders.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -14392,7 +16194,7 @@ await client.filestorage.regenerateKey.create({
-
-**request:** `Merge.filestorage.RemoteKeyForRegenerationRequest`
+**request:** `Merge.accounting.PurchaseOrdersRemoteFieldClassesListRequest`
@@ -14400,7 +16202,7 @@ await client.filestorage.regenerateKey.create({
-
-**requestOptions:** `RegenerateKeyClient.RequestOptions`
+**requestOptions:** `PurchaseOrdersClient.RequestOptions`
@@ -14412,8 +16214,8 @@ await client.filestorage.regenerateKey.create({
client.filestorage.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
+## Accounting RegenerateKey
+client.accounting.regenerateKey.create({ ...params }) -> Merge.RemoteKey
-
@@ -14425,7 +16227,7 @@ await client.filestorage.regenerateKey.create({
-
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+Exchange remote keys.
@@ -14440,9 +16242,8 @@ Get sync status for the current sync and the most recently finished sync. `last_
-
```typescript
-await client.filestorage.syncStatus.list({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- pageSize: 1
+await client.accounting.regenerateKey.create({
+ name: "Remote Deployment Key 1"
});
```
@@ -14459,7 +16260,7 @@ await client.filestorage.syncStatus.list({
-
-**request:** `Merge.filestorage.SyncStatusListRequest`
+**request:** `Merge.accounting.RemoteKeyForRegenerationRequest`
@@ -14467,7 +16268,7 @@ await client.filestorage.syncStatus.list({
-
-**requestOptions:** `SyncStatusClient.RequestOptions`
+**requestOptions:** `RegenerateKeyClient.RequestOptions`
@@ -14479,8 +16280,8 @@ await client.filestorage.syncStatus.list({
client.filestorage.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+## Accounting SalesOrders
+client.accounting.salesOrders.list({ ...params }) -> core.Page
-
@@ -14492,7 +16293,7 @@ await client.filestorage.syncStatus.list({
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+Returns a list of `SalesOrder` objects.
@@ -14507,7 +16308,53 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
-
```typescript
-await client.filestorage.forceResync.syncStatusResyncCreate();
+const pageableResponse = await client.accounting.salesOrders.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ issueDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ issueDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.salesOrders.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ issueDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ issueDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -14523,7 +16370,15 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-
-**requestOptions:** `ForceResyncClient.RequestOptions`
+**request:** `Merge.accounting.SalesOrdersListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `SalesOrdersClient.RequestOptions`
@@ -14535,8 +16390,7 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
client.filestorage.users.list({ ...params }) -> Merge.PaginatedUserList
+client.accounting.salesOrders.create({ ...params }) -> Merge.SalesOrderResponse
-
@@ -14548,7 +16402,7 @@ await client.filestorage.forceResync.syncStatusResyncCreate();
-
-Returns a list of `User` objects.
+Creates a `SalesOrder` object with the given values.
@@ -14563,18 +16417,10 @@ Returns a list of `User` objects.
-
```typescript
-await client.filestorage.users.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
- includeRemoteData: true,
- includeShellData: true,
- isMe: "is_me",
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteId: "remote_id"
+await client.accounting.salesOrders.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -14591,7 +16437,7 @@ await client.filestorage.users.list({
-
-**request:** `Merge.filestorage.UsersListRequest`
+**request:** `Merge.accounting.SalesOrderEndpointRequest`
@@ -14599,7 +16445,7 @@ await client.filestorage.users.list({
-
-**requestOptions:** `UsersClient.RequestOptions`
+**requestOptions:** `SalesOrdersClient.RequestOptions`
@@ -14611,7 +16457,7 @@ await client.filestorage.users.list({
client.filestorage.users.retrieve(id, { ...params }) -> Merge.User
+client.accounting.salesOrders.retrieve(id, { ...params }) -> Merge.SalesOrder
-
@@ -14623,7 +16469,7 @@ await client.filestorage.users.list({
-
-Returns a `User` object with the given `id`.
+Returns a `SalesOrder` object with the given `id`.
@@ -14638,9 +16484,12 @@ Returns a `User` object with the given `id`.
-
```typescript
-await client.filestorage.users.retrieve("id", {
+await client.accounting.salesOrders.retrieve("id", {
includeRemoteData: true,
- includeShellData: true
+ includeRemoteFields: true,
+ includeShellData: true,
+ remoteFields: "status",
+ showEnumOrigins: "status"
});
```
@@ -14665,7 +16514,7 @@ await client.filestorage.users.retrieve("id", {
-
-**request:** `Merge.filestorage.UsersRetrieveRequest`
+**request:** `Merge.accounting.SalesOrdersRetrieveRequest`
@@ -14673,7 +16522,7 @@ await client.filestorage.users.retrieve("id", {
-
-**requestOptions:** `UsersClient.RequestOptions`
+**requestOptions:** `SalesOrdersClient.RequestOptions`
@@ -14685,8 +16534,7 @@ await client.filestorage.users.retrieve("id", {
client.filestorage.webhookReceivers.list() -> Merge.WebhookReceiver[]
+client.accounting.salesOrders.asyncBulkCreate({ ...params }) -> Merge.SalesOrderResponse
-
@@ -14698,7 +16546,7 @@ await client.filestorage.users.retrieve("id", {
-
-Returns a list of `WebhookReceiver` objects.
+Creates a `SalesOrder` object with the given values.
@@ -14713,7 +16561,14 @@ Returns a list of `WebhookReceiver` objects.
-
```typescript
-await client.filestorage.webhookReceivers.list();
+await client.accounting.salesOrders.asyncBulkCreate({
+ isDebugMode: true,
+ runAsync: true,
+ batchItems: [{
+ itemId: "item_id",
+ payload: {}
+ }]
+});
```
@@ -14729,7 +16584,15 @@ await client.filestorage.webhookReceivers.list();
-
-**requestOptions:** `WebhookReceiversClient.RequestOptions`
+**request:** `Merge.accounting.SalesOrderBulkRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `SalesOrdersClient.RequestOptions`
@@ -14741,7 +16604,7 @@ await client.filestorage.webhookReceivers.list();
client.filestorage.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
+client.accounting.salesOrders.batchObjectsList(batch_id, { ...params }) -> core.Page
-
@@ -14753,7 +16616,7 @@ await client.filestorage.webhookReceivers.list();
-
-Creates a `WebhookReceiver` object with the given values.
+Returns a list of `SalesOrder` objects.
@@ -14768,10 +16631,53 @@ Creates a `WebhookReceiver` object with the given values.
-
```typescript
-await client.filestorage.webhookReceivers.create({
- event: "event",
- isActive: true
+const pageableResponse = await client.accounting.salesOrders.batchObjectsList("batch_id", {
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ issueDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ issueDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.salesOrders.batchObjectsList("batch_id", {
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ issueDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ issueDateBefore: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -14787,7 +16693,7 @@ await client.filestorage.webhookReceivers.create({
-
-**request:** `Merge.filestorage.WebhookReceiverRequest`
+**batch_id:** `string`
@@ -14795,63 +16701,15 @@ await client.filestorage.webhookReceivers.create({
-
-**requestOptions:** `WebhookReceiversClient.RequestOptions`
+**request:** `Merge.accounting.SalesOrdersBatchObjectsListRequest`
-
-
-
-
-
-
-
-
-client.hris.accountDetails.retrieve() -> Merge.AccountDetails
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get details for a linked account.
-
-
-#### 🔌 Usage
-
-
-
--
-
-```typescript
-await client.hris.accountDetails.retrieve();
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `AccountDetailsClient.RequestOptions`
+**requestOptions:** `SalesOrdersClient.RequestOptions`
@@ -14863,8 +16721,7 @@ await client.hris.accountDetails.retrieve();
client.hris.accountToken.retrieve(public_token) -> Merge.AccountToken
+client.accounting.salesOrders.linesRemoteFieldClassesList({ ...params }) -> core.Page
-
@@ -14876,7 +16733,7 @@ await client.hris.accountDetails.retrieve();
-
-Returns the account token for the end user with the provided public token.
+Returns a list of `RemoteFieldClass` objects.
@@ -14891,7 +16748,35 @@ Returns the account token for the end user with the provided public token.
-
```typescript
-await client.hris.accountToken.retrieve("public_token");
+const pageableResponse = await client.accounting.salesOrders.linesRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.salesOrders.linesRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -14907,7 +16792,7 @@ await client.hris.accountToken.retrieve("public_token");
-
-**public_token:** `string`
+**request:** `Merge.accounting.SalesOrdersLinesRemoteFieldClassesListRequest`
@@ -14915,7 +16800,7 @@ await client.hris.accountToken.retrieve("public_token");
-
-**requestOptions:** `AccountTokenClient.RequestOptions`
+**requestOptions:** `SalesOrdersClient.RequestOptions`
@@ -14927,8 +16812,7 @@ await client.hris.accountToken.retrieve("public_token");
client.hris.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
+client.accounting.salesOrders.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -14940,7 +16824,7 @@ await client.hris.accountToken.retrieve("public_token");
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns metadata for `SalesOrder` POSTs.
@@ -14955,10 +16839,7 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.hris.asyncPassthrough.create({
- method: "GET",
- path: "/scooters"
-});
+await client.accounting.salesOrders.metaPostRetrieve();
```
@@ -14974,15 +16855,7 @@ await client.hris.asyncPassthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
-
-
-
-
-
--
-
-**requestOptions:** `AsyncPassthroughClient.RequestOptions`
+**requestOptions:** `SalesOrdersClient.RequestOptions`
@@ -14994,7 +16867,7 @@ await client.hris.asyncPassthrough.create({
client.hris.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
+client.accounting.salesOrders.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -15006,7 +16879,7 @@ await client.hris.asyncPassthrough.create({
-
-Retrieves data from earlier async-passthrough POST request
+Returns a list of `RemoteFieldClass` objects.
@@ -15021,7 +16894,35 @@ Retrieves data from earlier async-passthrough POST request
-
```typescript
-await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+const pageableResponse = await client.accounting.salesOrders.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.salesOrders.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -15037,7 +16938,7 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-
-**async_passthrough_receipt_id:** `string`
+**request:** `Merge.accounting.SalesOrdersRemoteFieldClassesListRequest`
@@ -15045,7 +16946,7 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-
-**requestOptions:** `AsyncPassthroughClient.RequestOptions`
+**requestOptions:** `SalesOrdersClient.RequestOptions`
@@ -15057,8 +16958,8 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
client.hris.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+## Accounting SyncStatus
+client.accounting.syncStatus.list({ ...params }) -> core.Page
-
@@ -15070,7 +16971,7 @@ await client.hris.asyncPassthrough.retrieve("async_passthrough_receipt_id");
-
-Gets a list of audit trail events.
+Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -15085,14 +16986,25 @@ Gets a list of audit trail events.
-
```typescript
-await client.hris.auditTrail.list({
+const pageableResponse = await client.accounting.syncStatus.list({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endDate: "end_date",
- eventType: "event_type",
- pageSize: 1,
- startDate: "start_date",
- userEmail: "user_email"
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.syncStatus.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -15108,7 +17020,7 @@ await client.hris.auditTrail.list({
-
-**request:** `Merge.hris.AuditTrailListRequest`
+**request:** `Merge.accounting.SyncStatusListRequest`
@@ -15116,7 +17028,7 @@ await client.hris.auditTrail.list({
-
-**requestOptions:** `AuditTrailClient.RequestOptions`
+**requestOptions:** `SyncStatusClient.RequestOptions`
@@ -15128,8 +17040,8 @@ await client.hris.auditTrail.list({
client.hris.availableActions.retrieve() -> Merge.AvailableActions
+## Accounting ForceResync
+client.accounting.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
-
@@ -15141,7 +17053,7 @@ await client.hris.auditTrail.list({
-
-Returns a list of models and actions available for an account.
+Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -15156,7 +17068,7 @@ Returns a list of models and actions available for an account.
-
```typescript
-await client.hris.availableActions.retrieve();
+await client.accounting.forceResync.syncStatusResyncCreate();
```
@@ -15172,7 +17084,7 @@ await client.hris.availableActions.retrieve();
-
-**requestOptions:** `AvailableActionsClient.RequestOptions`
+**requestOptions:** `ForceResyncClient.RequestOptions`
@@ -15184,8 +17096,8 @@ await client.hris.availableActions.retrieve();
client.hris.bankInfo.list({ ...params }) -> Merge.PaginatedBankInfoList
+## Accounting TaxRates
+client.accounting.taxRates.list({ ...params }) -> core.Page
-
@@ -15197,7 +17109,7 @@ await client.hris.availableActions.retrieve();
-
-Returns a list of `BankInfo` objects.
+Returns a list of `TaxRate` objects.
@@ -15212,25 +17124,45 @@ Returns a list of `BankInfo` objects.
-
```typescript
-await client.hris.bankInfo.list({
- accountType: "CHECKING",
- bankName: "bank_name",
+const pageableResponse = await client.accounting.taxRates.list({
+ companyId: "company_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employeeId: "employee_id",
- expand: "employee",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- orderBy: "-remote_created_at",
+ name: "name",
pageSize: 1,
- remoteFields: "account_type",
- remoteId: "remote_id",
- showEnumOrigins: "account_type"
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.taxRates.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ pageSize: 1,
+ remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -15246,7 +17178,7 @@ await client.hris.bankInfo.list({
-
-**request:** `Merge.hris.BankInfoListRequest`
+**request:** `Merge.accounting.TaxRatesListRequest`
@@ -15254,7 +17186,7 @@ await client.hris.bankInfo.list({
-
-**requestOptions:** `BankInfoClient.RequestOptions`
+**requestOptions:** `TaxRatesClient.RequestOptions`
@@ -15266,7 +17198,7 @@ await client.hris.bankInfo.list({
client.hris.bankInfo.retrieve(id, { ...params }) -> Merge.BankInfo
+client.accounting.taxRates.retrieve(id, { ...params }) -> Merge.TaxRate
-
@@ -15278,7 +17210,7 @@ await client.hris.bankInfo.list({
-
-Returns a `BankInfo` object with the given `id`.
+Returns a `TaxRate` object with the given `id`.
@@ -15293,12 +17225,9 @@ Returns a `BankInfo` object with the given `id`.
-
```typescript
-await client.hris.bankInfo.retrieve("id", {
- expand: "employee",
+await client.accounting.taxRates.retrieve("id", {
includeRemoteData: true,
- includeShellData: true,
- remoteFields: "account_type",
- showEnumOrigins: "account_type"
+ includeShellData: true
});
```
@@ -15323,7 +17252,7 @@ await client.hris.bankInfo.retrieve("id", {
-
-**request:** `Merge.hris.BankInfoRetrieveRequest`
+**request:** `Merge.accounting.TaxRatesRetrieveRequest`
@@ -15331,7 +17260,7 @@ await client.hris.bankInfo.retrieve("id", {
-
-**requestOptions:** `BankInfoClient.RequestOptions`
+**requestOptions:** `TaxRatesClient.RequestOptions`
@@ -15343,8 +17272,8 @@ await client.hris.bankInfo.retrieve("id", {
client.hris.benefits.list({ ...params }) -> Merge.PaginatedBenefitList
+## Accounting TrackingCategories
+client.accounting.trackingCategories.list({ ...params }) -> core.Page
-
@@ -15356,7 +17285,7 @@ await client.hris.bankInfo.retrieve("id", {
-
-Returns a list of `Benefit` objects.
+Returns a list of `TrackingCategory` objects.
@@ -15371,20 +17300,53 @@ Returns a list of `Benefit` objects.
-
```typescript
-await client.hris.benefits.list({
+const pageableResponse = await client.accounting.trackingCategories.list({
+ categoryType: "",
+ companyId: "company_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employeeId: "employee_id",
- expand: "employee",
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
pageSize: 1,
- remoteId: "remote_id"
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status",
+ status: ""
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.trackingCategories.list({
+ categoryType: "",
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ pageSize: 1,
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status",
+ status: ""
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -15400,7 +17362,7 @@ await client.hris.benefits.list({
-
-**request:** `Merge.hris.BenefitsListRequest`
+**request:** `Merge.accounting.TrackingCategoriesListRequest`
@@ -15408,7 +17370,7 @@ await client.hris.benefits.list({
-
-**requestOptions:** `BenefitsClient.RequestOptions`
+**requestOptions:** `TrackingCategoriesClient.RequestOptions`
@@ -15420,7 +17382,7 @@ await client.hris.benefits.list({
client.hris.benefits.retrieve(id, { ...params }) -> Merge.Benefit
+client.accounting.trackingCategories.retrieve(id, { ...params }) -> Merge.TrackingCategory
-
@@ -15432,7 +17394,7 @@ await client.hris.benefits.list({
-
-Returns a `Benefit` object with the given `id`.
+Returns a `TrackingCategory` object with the given `id`.
@@ -15447,10 +17409,11 @@ Returns a `Benefit` object with the given `id`.
-
```typescript
-await client.hris.benefits.retrieve("id", {
- expand: "employee",
+await client.accounting.trackingCategories.retrieve("id", {
includeRemoteData: true,
- includeShellData: true
+ includeShellData: true,
+ remoteFields: "status",
+ showEnumOrigins: "status"
});
```
@@ -15475,7 +17438,7 @@ await client.hris.benefits.retrieve("id", {
-
-**request:** `Merge.hris.BenefitsRetrieveRequest`
+**request:** `Merge.accounting.TrackingCategoriesRetrieveRequest`
@@ -15483,7 +17446,7 @@ await client.hris.benefits.retrieve("id", {
-
-**requestOptions:** `BenefitsClient.RequestOptions`
+**requestOptions:** `TrackingCategoriesClient.RequestOptions`
@@ -15495,8 +17458,8 @@ await client.hris.benefits.retrieve("id", {
client.hris.companies.list({ ...params }) -> Merge.PaginatedCompanyList
+## Accounting Transactions
+client.accounting.transactions.list({ ...params }) -> core.Page
-
@@ -15508,7 +17471,7 @@ await client.hris.benefits.retrieve("id", {
-
-Returns a list of `Company` objects.
+Returns a list of `Transaction` objects.
@@ -15523,7 +17486,8 @@ Returns a list of `Company` objects.
-
```typescript
-await client.hris.companies.list({
+const pageableResponse = await client.accounting.transactions.list({
+ companyId: "company_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
@@ -15533,8 +17497,36 @@ await client.hris.companies.list({
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
pageSize: 1,
- remoteId: "remote_id"
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.transactions.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -15550,7 +17542,7 @@ await client.hris.companies.list({
-
-**request:** `Merge.hris.CompaniesListRequest`
+**request:** `Merge.accounting.TransactionsListRequest`
@@ -15558,7 +17550,7 @@ await client.hris.companies.list({
-
-**requestOptions:** `CompaniesClient.RequestOptions`
+**requestOptions:** `TransactionsClient.RequestOptions`
@@ -15570,7 +17562,7 @@ await client.hris.companies.list({
client.hris.companies.retrieve(id, { ...params }) -> Merge.Company
+client.accounting.transactions.retrieve(id, { ...params }) -> Merge.Transaction
-
@@ -15582,7 +17574,7 @@ await client.hris.companies.list({
-
-Returns a `Company` object with the given `id`.
+Returns a `Transaction` object with the given `id`.
@@ -15597,7 +17589,7 @@ Returns a `Company` object with the given `id`.
-
```typescript
-await client.hris.companies.retrieve("id", {
+await client.accounting.transactions.retrieve("id", {
includeRemoteData: true,
includeShellData: true
});
@@ -15624,7 +17616,7 @@ await client.hris.companies.retrieve("id", {
-
-**request:** `Merge.hris.CompaniesRetrieveRequest`
+**request:** `Merge.accounting.TransactionsRetrieveRequest`
@@ -15632,7 +17624,7 @@ await client.hris.companies.retrieve("id", {
-
-**requestOptions:** `CompaniesClient.RequestOptions`
+**requestOptions:** `TransactionsClient.RequestOptions`
@@ -15644,8 +17636,8 @@ await client.hris.companies.retrieve("id", {
client.hris.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
+## Accounting VendorCredits
+client.accounting.vendorCredits.list({ ...params }) -> core.Page
-
@@ -15657,7 +17649,7 @@ await client.hris.companies.retrieve("id", {
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a list of `VendorCredit` objects.
@@ -15672,7 +17664,47 @@ Get the default permissions for Merge Common Models and fields across all Linked
-
```typescript
-await client.hris.scopes.defaultScopesRetrieve();
+const pageableResponse = await client.accounting.vendorCredits.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounting.vendorCredits.list({
+ companyId: "company_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ transactionDateAfter: new Date("2024-01-15T09:30:00.000Z"),
+ transactionDateBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -15688,62 +17720,15 @@ await client.hris.scopes.defaultScopesRetrieve();
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**request:** `Merge.accounting.VendorCreditsListRequest`
-
-
-
-
-
-
-client.hris.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.hris.scopes.linkedAccountScopesRetrieve();
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**requestOptions:** `VendorCreditsClient.RequestOptions`
@@ -15755,7 +17740,7 @@ await client.hris.scopes.linkedAccountScopesRetrieve();
client.hris.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
+client.accounting.vendorCredits.create({ ...params }) -> Merge.VendorCreditResponse
-
@@ -15767,7 +17752,7 @@ await client.hris.scopes.linkedAccountScopesRetrieve();
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+Creates a `VendorCredit` object with the given values.
@@ -15782,29 +17767,10 @@ Update permissions for any Common Model or field for a single Linked Account. An
-
```typescript
-await client.hris.scopes.linkedAccountScopesCreate({
- commonModels: [{
- modelName: "Employee",
- modelPermissions: {
- "READ": {
- isEnabled: true
- },
- "WRITE": {
- isEnabled: false
- }
- },
- fieldPermissions: {
- enabledFields: ["avatar", "home_location"],
- disabledFields: ["work_location"]
- }
- }, {
- modelName: "Benefit",
- modelPermissions: {
- "WRITE": {
- isEnabled: false
- }
- }
- }]
+await client.accounting.vendorCredits.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -15821,7 +17787,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-
-**request:** `Merge.hris.LinkedAccountCommonModelScopeDeserializerRequest`
+**request:** `Merge.accounting.VendorCreditEndpointRequest`
@@ -15829,7 +17795,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**requestOptions:** `VendorCreditsClient.RequestOptions`
@@ -15841,8 +17807,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
client.hris.deleteAccount.delete() -> void
+client.accounting.vendorCredits.retrieve(id, { ...params }) -> Merge.VendorCredit
-
@@ -15854,7 +17819,7 @@ await client.hris.scopes.linkedAccountScopesCreate({
-
-Delete a linked account.
+Returns a `VendorCredit` object with the given `id`.
@@ -15869,7 +17834,10 @@ Delete a linked account.
-
```typescript
-await client.hris.deleteAccount.delete();
+await client.accounting.vendorCredits.retrieve("id", {
+ includeRemoteData: true,
+ includeShellData: true
+});
```
@@ -15885,76 +17853,15 @@ await client.hris.deleteAccount.delete();
-
-**requestOptions:** `DeleteAccountClient.RequestOptions`
+**id:** `string`
-
-
-
-
-
-
-client.hris.dependents.list({ ...params }) -> Merge.PaginatedDependentList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Dependent` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.hris.dependents.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employeeId: "employee_id",
- includeDeletedData: true,
- includeRemoteData: true,
- includeSensitiveFields: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteId: "remote_id"
-});
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-**request:** `Merge.hris.DependentsListRequest`
+**request:** `Merge.accounting.VendorCreditsRetrieveRequest`
@@ -15962,7 +17869,7 @@ await client.hris.dependents.list({
-
-**requestOptions:** `DependentsClient.RequestOptions`
+**requestOptions:** `VendorCreditsClient.RequestOptions`
@@ -15974,7 +17881,7 @@ await client.hris.dependents.list({
client.hris.dependents.retrieve(id, { ...params }) -> Merge.Dependent
+client.accounting.vendorCredits.partialUpdate(id, { ...params }) -> Merge.VendorCreditResponse
-
@@ -15986,7 +17893,7 @@ await client.hris.dependents.list({
-
-Returns a `Dependent` object with the given `id`.
+Updates a `VendorCredit` object with the given `id`.
@@ -16001,10 +17908,10 @@ Returns a `Dependent` object with the given `id`.
-
```typescript
-await client.hris.dependents.retrieve("id", {
- includeRemoteData: true,
- includeSensitiveFields: true,
- includeShellData: true
+await client.accounting.vendorCredits.partialUpdate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -16029,7 +17936,7 @@ await client.hris.dependents.retrieve("id", {
-
-**request:** `Merge.hris.DependentsRetrieveRequest`
+**request:** `Merge.accounting.PatchedVendorCreditEndpointRequest`
@@ -16037,7 +17944,7 @@ await client.hris.dependents.retrieve("id", {
-
-**requestOptions:** `DependentsClient.RequestOptions`
+**requestOptions:** `VendorCreditsClient.RequestOptions`
@@ -16049,8 +17956,7 @@ await client.hris.dependents.retrieve("id", {
client.hris.employeePayrollRuns.list({ ...params }) -> Merge.PaginatedEmployeePayrollRunList
+client.accounting.vendorCredits.applicationCreate(id, { ...params }) -> Merge.VendorCreditResponse
-
@@ -16062,7 +17968,7 @@ await client.hris.dependents.retrieve("id", {
-
-Returns a list of `EmployeePayrollRun` objects.
+Creates a new VendorCreditApplyLine to apply a vendor credit to an invoice
@@ -16077,24 +17983,11 @@ Returns a list of `EmployeePayrollRun` objects.
-
```typescript
-await client.hris.employeePayrollRuns.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employeeId: "employee_id",
- endedAfter: new Date("2024-01-15T09:30:00.000Z"),
- endedBefore: new Date("2024-01-15T09:30:00.000Z"),
- expand: "employee",
- includeDeletedData: true,
- includeRemoteData: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- payrollRunId: "payroll_run_id",
- remoteId: "remote_id",
- startedAfter: new Date("2024-01-15T09:30:00.000Z"),
- startedBefore: new Date("2024-01-15T09:30:00.000Z")
+await client.accounting.vendorCredits.applicationCreate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ appliedDate: new Date("2024-01-15T09:30:00.000Z"),
+ appliedAmount: "applied_amount"
});
```
@@ -16111,7 +18004,7 @@ await client.hris.employeePayrollRuns.list({
-
-**request:** `Merge.hris.EmployeePayrollRunsListRequest`
+**id:** `string`
@@ -16119,7 +18012,15 @@ await client.hris.employeePayrollRuns.list({
-
-**requestOptions:** `EmployeePayrollRunsClient.RequestOptions`
+**request:** `Merge.accounting.ApplyVendorCreditRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `VendorCreditsClient.RequestOptions`
@@ -16131,7 +18032,7 @@ await client.hris.employeePayrollRuns.list({
client.hris.employeePayrollRuns.retrieve(id, { ...params }) -> Merge.EmployeePayrollRun
+client.accounting.vendorCredits.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -16143,7 +18044,7 @@ await client.hris.employeePayrollRuns.list({
-
-Returns an `EmployeePayrollRun` object with the given `id`.
+Returns metadata for `VendorCredit` PATCHs.
@@ -16158,11 +18059,7 @@ Returns an `EmployeePayrollRun` object with the given `id`.
-
```typescript
-await client.hris.employeePayrollRuns.retrieve("id", {
- expand: "employee",
- includeRemoteData: true,
- includeShellData: true
-});
+await client.accounting.vendorCredits.metaPatchRetrieve("id");
```
@@ -16186,15 +18083,7 @@ await client.hris.employeePayrollRuns.retrieve("id", {
-
-**request:** `Merge.hris.EmployeePayrollRunsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `EmployeePayrollRunsClient.RequestOptions`
+**requestOptions:** `VendorCreditsClient.RequestOptions`
@@ -16206,8 +18095,7 @@ await client.hris.employeePayrollRuns.retrieve("id", {
client.hris.employees.list({ ...params }) -> Merge.PaginatedEmployeeList
+client.accounting.vendorCredits.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -16219,7 +18107,7 @@ await client.hris.employeePayrollRuns.retrieve("id", {
-
-Returns a list of `Employee` objects.
+Returns metadata for `VendorCredit` POSTs.
@@ -16234,42 +18122,7 @@ Returns a list of `Employee` objects.
-
```typescript
-await client.hris.employees.list({
- companyId: "company_id",
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- displayFullName: "display_full_name",
- employeeNumber: "employee_number",
- employmentStatus: "ACTIVE",
- employmentType: "employment_type",
- expand: "company",
- firstName: "first_name",
- groups: "groups",
- homeLocationId: "home_location_id",
- includeDeletedData: true,
- includeRemoteData: true,
- includeSensitiveFields: true,
- includeShellData: true,
- jobTitle: "job_title",
- lastName: "last_name",
- managerId: "manager_id",
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- payGroupId: "pay_group_id",
- personalEmail: "personal_email",
- remoteFields: "employment_status",
- remoteId: "remote_id",
- showEnumOrigins: "employment_status",
- startedAfter: new Date("2024-01-15T09:30:00.000Z"),
- startedBefore: new Date("2024-01-15T09:30:00.000Z"),
- teamId: "team_id",
- terminatedAfter: new Date("2024-01-15T09:30:00.000Z"),
- terminatedBefore: new Date("2024-01-15T09:30:00.000Z"),
- workEmail: "work_email",
- workLocationId: "work_location_id"
-});
+await client.accounting.vendorCredits.metaPostRetrieve();
```
@@ -16285,15 +18138,7 @@ await client.hris.employees.list({
-
-**request:** `Merge.hris.EmployeesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `EmployeesClient.RequestOptions`
+**requestOptions:** `VendorCreditsClient.RequestOptions`
@@ -16305,7 +18150,8 @@ await client.hris.employees.list({
client.hris.employees.create({ ...params }) -> Merge.EmployeeResponse
+## Accounting WebhookReceivers
+client.accounting.webhookReceivers.list() -> Merge.WebhookReceiver[]
-
@@ -16317,7 +18163,7 @@ await client.hris.employees.list({
-
-Creates an `Employee` object with the given values.
+Returns a list of `WebhookReceiver` objects.
@@ -16332,11 +18178,7 @@ Creates an `Employee` object with the given values.
-
```typescript
-await client.hris.employees.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
-});
+await client.accounting.webhookReceivers.list();
```
@@ -16352,15 +18194,7 @@ await client.hris.employees.create({
-
-**request:** `Merge.hris.EmployeeEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `EmployeesClient.RequestOptions`
+**requestOptions:** `WebhookReceiversClient.RequestOptions`
@@ -16372,7 +18206,7 @@ await client.hris.employees.create({
client.hris.employees.retrieve(id, { ...params }) -> Merge.Employee
+client.accounting.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
-
@@ -16384,7 +18218,7 @@ await client.hris.employees.create({
-
-Returns an `Employee` object with the given `id`.
+Creates a `WebhookReceiver` object with the given values.
@@ -16399,13 +18233,9 @@ Returns an `Employee` object with the given `id`.
-
```typescript
-await client.hris.employees.retrieve("id", {
- expand: "company",
- includeRemoteData: true,
- includeSensitiveFields: true,
- includeShellData: true,
- remoteFields: "employment_status",
- showEnumOrigins: "employment_status"
+await client.accounting.webhookReceivers.create({
+ event: "event",
+ isActive: true
});
```
@@ -16422,15 +18252,7 @@ await client.hris.employees.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.EmployeesRetrieveRequest`
+**request:** `Merge.accounting.WebhookReceiverRequest`
@@ -16438,7 +18260,7 @@ await client.hris.employees.retrieve("id", {
-
-**requestOptions:** `EmployeesClient.RequestOptions`
+**requestOptions:** `WebhookReceiversClient.RequestOptions`
@@ -16450,7 +18272,8 @@ await client.hris.employees.retrieve("id", {
client.hris.employees.ignoreCreate(model_id, { ...params }) -> void
+## Crm AccountDetails
+client.crm.accountDetails.retrieve() -> Merge.AccountDetails
-
@@ -16462,7 +18285,7 @@ await client.hris.employees.retrieve("id", {
-
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+Get details for a linked account.
@@ -16477,9 +18300,7 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
-
```typescript
-await client.hris.employees.ignoreCreate("model_id", {
- reason: "GENERAL_CUSTOMER_REQUEST"
-});
+await client.crm.accountDetails.retrieve();
```
@@ -16495,15 +18316,63 @@ await client.hris.employees.ignoreCreate("model_id", {
-
-**model_id:** `string`
+**requestOptions:** `AccountDetailsClient.RequestOptions`
+
+
+
+
+
+
+client.crm.accountToken.retrieve(public_token) -> Merge.AccountToken
+
+-
+
+#### 📝 Description
-
-**request:** `Merge.hris.IgnoreCommonModelRequest`
+
+-
+
+Returns the account token for the end user with the provided public token.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.accountToken.retrieve("public_token");
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**public_token:** `string`
@@ -16511,7 +18380,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-
-**requestOptions:** `EmployeesClient.RequestOptions`
+**requestOptions:** `AccountTokenClient.RequestOptions`
@@ -16523,7 +18392,7 @@ await client.hris.employees.ignoreCreate("model_id", {
client.hris.employees.metaPostRetrieve() -> Merge.MetaResponse
+client.crm.accountToken.regenerateCreate() -> Merge.RegenerateAccountToken
-
@@ -16535,7 +18404,7 @@ await client.hris.employees.ignoreCreate("model_id", {
-
-Returns metadata for `Employee` POSTs.
+Exchange Linked Account account tokens.
@@ -16550,7 +18419,7 @@ Returns metadata for `Employee` POSTs.
-
```typescript
-await client.hris.employees.metaPostRetrieve();
+await client.crm.accountToken.regenerateCreate();
```
@@ -16566,7 +18435,7 @@ await client.hris.employees.metaPostRetrieve();
-
-**requestOptions:** `EmployeesClient.RequestOptions`
+**requestOptions:** `AccountTokenClient.RequestOptions`
@@ -16578,8 +18447,8 @@ await client.hris.employees.metaPostRetrieve();
client.hris.employerBenefits.list({ ...params }) -> Merge.PaginatedEmployerBenefitList
+## Crm Accounts
+client.crm.accounts.list({ ...params }) -> core.Page
-
@@ -16591,7 +18460,7 @@ await client.hris.employees.metaPostRetrieve();
-
-Returns a list of `EmployerBenefit` objects.
+Returns a list of `Account` objects.
@@ -16606,18 +18475,47 @@ Returns a list of `EmployerBenefit` objects.
-
```typescript
-await client.hris.employerBenefits.list({
+const pageableResponse = await client.crm.accounts.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
includeDeletedData: true,
includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true,
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ ownerId: "owner_id",
pageSize: 1,
remoteId: "remote_id"
});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.accounts.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ name: "name",
+ ownerId: "owner_id",
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -16633,7 +18531,7 @@ await client.hris.employerBenefits.list({
-
-**request:** `Merge.hris.EmployerBenefitsListRequest`
+**request:** `Merge.crm.AccountsListRequest`
@@ -16641,7 +18539,7 @@ await client.hris.employerBenefits.list({
-
-**requestOptions:** `EmployerBenefitsClient.RequestOptions`
+**requestOptions:** `AccountsClient.RequestOptions`
@@ -16653,7 +18551,7 @@ await client.hris.employerBenefits.list({
client.hris.employerBenefits.retrieve(id, { ...params }) -> Merge.EmployerBenefit
+client.crm.accounts.create({ ...params }) -> Merge.CrmAccountResponse
-
@@ -16665,7 +18563,7 @@ await client.hris.employerBenefits.list({
-
-Returns an `EmployerBenefit` object with the given `id`.
+Creates an `Account` object with the given values.
@@ -16680,9 +18578,10 @@ Returns an `EmployerBenefit` object with the given `id`.
-
```typescript
-await client.hris.employerBenefits.retrieve("id", {
- includeRemoteData: true,
- includeShellData: true
+await client.crm.accounts.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -16699,15 +18598,7 @@ await client.hris.employerBenefits.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.EmployerBenefitsRetrieveRequest`
+**request:** `Merge.crm.CrmAccountEndpointRequest`
@@ -16715,7 +18606,7 @@ await client.hris.employerBenefits.retrieve("id", {
-
-**requestOptions:** `EmployerBenefitsClient.RequestOptions`
+**requestOptions:** `AccountsClient.RequestOptions`
@@ -16727,8 +18618,7 @@ await client.hris.employerBenefits.retrieve("id", {
client.hris.employments.list({ ...params }) -> Merge.PaginatedEmploymentList
+client.crm.accounts.retrieve(id, { ...params }) -> Merge.Account
-
@@ -16740,7 +18630,7 @@ await client.hris.employerBenefits.retrieve("id", {
-
-Returns a list of `Employment` objects.
+Returns an `Account` object with the given `id`.
@@ -16755,22 +18645,10 @@ Returns a list of `Employment` objects.
-
```typescript
-await client.hris.employments.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employeeId: "employee_id",
- expand: "employee",
- includeDeletedData: true,
+await client.crm.accounts.retrieve("id", {
includeRemoteData: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- orderBy: "-effective_date",
- pageSize: 1,
- remoteFields: "employment_type",
- remoteId: "remote_id",
- showEnumOrigins: "employment_type"
+ includeRemoteFields: true,
+ includeShellData: true
});
```
@@ -16787,7 +18665,7 @@ await client.hris.employments.list({
-
-**request:** `Merge.hris.EmploymentsListRequest`
+**id:** `string`
@@ -16795,7 +18673,15 @@ await client.hris.employments.list({
-
-**requestOptions:** `EmploymentsClient.RequestOptions`
+**request:** `Merge.crm.AccountsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AccountsClient.RequestOptions`
@@ -16807,7 +18693,7 @@ await client.hris.employments.list({
client.hris.employments.retrieve(id, { ...params }) -> Merge.Employment
+client.crm.accounts.partialUpdate(id, { ...params }) -> Merge.CrmAccountResponse
-
@@ -16819,7 +18705,7 @@ await client.hris.employments.list({
-
-Returns an `Employment` object with the given `id`.
+Updates an `Account` object with the given `id`.
@@ -16834,12 +18720,10 @@ Returns an `Employment` object with the given `id`.
-
```typescript
-await client.hris.employments.retrieve("id", {
- expand: "employee",
- includeRemoteData: true,
- includeShellData: true,
- remoteFields: "employment_type",
- showEnumOrigins: "employment_type"
+await client.crm.accounts.partialUpdate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -16864,7 +18748,7 @@ await client.hris.employments.retrieve("id", {
-
-**request:** `Merge.hris.EmploymentsRetrieveRequest`
+**request:** `Merge.crm.PatchedCrmAccountEndpointRequest`
@@ -16872,7 +18756,7 @@ await client.hris.employments.retrieve("id", {
-
-**requestOptions:** `EmploymentsClient.RequestOptions`
+**requestOptions:** `AccountsClient.RequestOptions`
@@ -16884,8 +18768,7 @@ await client.hris.employments.retrieve("id", {
client.hris.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
+client.crm.accounts.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -16897,7 +18780,7 @@ await client.hris.employments.retrieve("id", {
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns metadata for `CRMAccount` PATCHs.
@@ -16912,9 +18795,7 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
-
```typescript
-await client.hris.fieldMapping.fieldMappingsRetrieve({
- excludeRemoteFieldMetadata: true
-});
+await client.crm.accounts.metaPatchRetrieve("id");
```
@@ -16930,7 +18811,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve({
-
-**request:** `Merge.hris.FieldMappingsRetrieveRequest`
+**id:** `string`
@@ -16938,7 +18819,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve({
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `AccountsClient.RequestOptions`
@@ -16950,7 +18831,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve({
client.hris.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
+client.crm.accounts.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -16962,7 +18843,7 @@ await client.hris.fieldMapping.fieldMappingsRetrieve({
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns metadata for `CRMAccount` POSTs.
@@ -16977,15 +18858,7 @@ Create new Field Mappings that will be available after the next scheduled sync.
-
```typescript
-await client.hris.fieldMapping.fieldMappingsCreate({
- excludeRemoteFieldMetadata: true,
- targetFieldName: "example_target_field_name",
- targetFieldDescription: "this is a example description of the target field",
- remoteFieldTraversalPath: ["example_remote_field"],
- remoteMethod: "GET",
- remoteUrlPath: "/example-url-path",
- commonModelName: "ExampleCommonModel"
-});
+await client.crm.accounts.metaPostRetrieve();
```
@@ -17001,15 +18874,7 @@ await client.hris.fieldMapping.fieldMappingsCreate({
-
-**request:** `Merge.hris.CreateFieldMappingRequest`
-
-
-
-
-
--
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `AccountsClient.RequestOptions`
@@ -17021,7 +18886,7 @@ await client.hris.fieldMapping.fieldMappingsCreate({
client.hris.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> Merge.FieldMappingInstanceResponse
+client.crm.accounts.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -17033,7 +18898,7 @@ await client.hris.fieldMapping.fieldMappingsCreate({
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `RemoteFieldClass` objects.
@@ -17048,7 +18913,37 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
-
```typescript
-await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+const pageableResponse = await client.crm.accounts.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.accounts.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -17064,7 +18959,7 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**field_mapping_id:** `string`
+**request:** `Merge.crm.AccountsRemoteFieldClassesListRequest`
@@ -17072,7 +18967,7 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `AccountsClient.RequestOptions`
@@ -17084,7 +18979,8 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
client.hris.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...params }) -> Merge.FieldMappingInstanceResponse
+## Crm AsyncPassthrough
+client.crm.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
-
@@ -17096,7 +18992,7 @@ await client.hris.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -17111,7 +19007,10 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
-
```typescript
-await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+await client.crm.asyncPassthrough.create({
+ method: "GET",
+ path: "/scooters"
+});
```
@@ -17127,15 +19026,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-**field_mapping_id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.PatchedEditFieldMappingRequest`
+**request:** `Merge.DataPassthroughRequest`
@@ -17143,7 +19034,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `AsyncPassthroughClient.RequestOptions`
@@ -17155,7 +19046,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
client.hris.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
+client.crm.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
-
@@ -17167,7 +19058,7 @@ await client.hris.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Retrieves data from earlier async-passthrough POST request
@@ -17182,10 +19073,7 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
-
```typescript
-await client.hris.fieldMapping.remoteFieldsRetrieve({
- commonModels: "common_models",
- includeExampleValues: "include_example_values"
-});
+await client.crm.asyncPassthrough.retrieve("async_passthrough_receipt_id");
```
@@ -17201,7 +19089,7 @@ await client.hris.fieldMapping.remoteFieldsRetrieve({
-
-**request:** `Merge.hris.RemoteFieldsRetrieveRequest`
+**async_passthrough_receipt_id:** `string`
@@ -17209,7 +19097,7 @@ await client.hris.fieldMapping.remoteFieldsRetrieve({
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `AsyncPassthroughClient.RequestOptions`
@@ -17221,7 +19109,8 @@ await client.hris.fieldMapping.remoteFieldsRetrieve({
client.hris.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
+## Crm AuditTrail
+client.crm.auditTrail.list({ ...params }) -> core.Page
-
@@ -17233,7 +19122,7 @@ await client.hris.fieldMapping.remoteFieldsRetrieve({
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Gets a list of audit trail events.
@@ -17248,7 +19137,33 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
-
```typescript
-await client.hris.fieldMapping.targetFieldsRetrieve();
+const pageableResponse = await client.crm.auditTrail.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endDate: "end_date",
+ eventType: "event_type",
+ pageSize: 1,
+ startDate: "start_date",
+ userEmail: "user_email"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.auditTrail.list({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endDate: "end_date",
+ eventType: "event_type",
+ pageSize: 1,
+ startDate: "start_date",
+ userEmail: "user_email"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -17264,7 +19179,15 @@ await client.hris.fieldMapping.targetFieldsRetrieve();
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**request:** `Merge.crm.AuditTrailListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AuditTrailClient.RequestOptions`
@@ -17276,8 +19199,8 @@ await client.hris.fieldMapping.targetFieldsRetrieve();
client.hris.generateKey.create({ ...params }) -> Merge.RemoteKey
+## Crm AvailableActions
+client.crm.availableActions.retrieve() -> Merge.AvailableActions
-
@@ -17289,7 +19212,7 @@ await client.hris.fieldMapping.targetFieldsRetrieve();
-
-Create a remote key.
+Returns a list of models and actions available for an account.
@@ -17304,9 +19227,7 @@ Create a remote key.
-
```typescript
-await client.hris.generateKey.create({
- name: "Remote Deployment Key 1"
-});
+await client.crm.availableActions.retrieve();
```
@@ -17322,15 +19243,7 @@ await client.hris.generateKey.create({
-
-**request:** `Merge.hris.GenerateRemoteKeyRequest`
-
-
-
-
-
--
-
-**requestOptions:** `GenerateKeyClient.RequestOptions`
+**requestOptions:** `AvailableActionsClient.RequestOptions`
@@ -17342,8 +19255,8 @@ await client.hris.generateKey.create({
client.hris.groups.list({ ...params }) -> Merge.PaginatedGroupList
+## Crm Contacts
+client.crm.contacts.list({ ...params }) -> core.Page
-
@@ -17355,7 +19268,7 @@ await client.hris.generateKey.create({
-
-Returns a list of `Group` objects.
+Returns a list of `Contact` objects.
@@ -17370,23 +19283,49 @@ Returns a list of `Group` objects.
-
```typescript
-await client.hris.groups.list({
+const pageableResponse = await client.crm.contacts.list({
+ accountId: "account_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ emailAddresses: "email_addresses",
includeDeletedData: true,
includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true,
- isCommonlyUsedAsTeam: "is_commonly_used_as_team",
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- names: "names",
pageSize: 1,
- remoteFields: "type",
- remoteId: "remote_id",
- showEnumOrigins: "type",
- types: "types"
+ phoneNumbers: "phone_numbers",
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.contacts.list({
+ accountId: "account_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ emailAddresses: "email_addresses",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ phoneNumbers: "phone_numbers",
+ remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -17402,7 +19341,7 @@ await client.hris.groups.list({
-
-**request:** `Merge.hris.GroupsListRequest`
+**request:** `Merge.crm.ContactsListRequest`
@@ -17410,7 +19349,7 @@ await client.hris.groups.list({
-
-**requestOptions:** `GroupsClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -17422,7 +19361,7 @@ await client.hris.groups.list({
client.hris.groups.retrieve(id, { ...params }) -> Merge.Group
+client.crm.contacts.create({ ...params }) -> Merge.CrmContactResponse
-
@@ -17434,7 +19373,7 @@ await client.hris.groups.list({
-
-Returns a `Group` object with the given `id`.
+Creates a `Contact` object with the given values.
@@ -17449,11 +19388,10 @@ Returns a `Group` object with the given `id`.
-
```typescript
-await client.hris.groups.retrieve("id", {
- includeRemoteData: true,
- includeShellData: true,
- remoteFields: "type",
- showEnumOrigins: "type"
+await client.crm.contacts.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -17470,15 +19408,7 @@ await client.hris.groups.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.GroupsRetrieveRequest`
+**request:** `Merge.crm.CrmContactEndpointRequest`
@@ -17486,7 +19416,7 @@ await client.hris.groups.retrieve("id", {
-
-**requestOptions:** `GroupsClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -17498,8 +19428,7 @@ await client.hris.groups.retrieve("id", {
client.hris.issues.list({ ...params }) -> Merge.PaginatedIssueList
+client.crm.contacts.retrieve(id, { ...params }) -> Merge.Contact
-
@@ -17511,7 +19440,7 @@ await client.hris.groups.retrieve("id", {
-
-Gets all issues for Organization.
+Returns a `Contact` object with the given `id`.
@@ -17526,21 +19455,10 @@ Gets all issues for Organization.
-
```typescript
-await client.hris.issues.list({
- accountToken: "account_token",
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endDate: "end_date",
- endUserOrganizationName: "end_user_organization_name",
- firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
- firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
- includeMuted: "include_muted",
- integrationName: "integration_name",
- lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
- lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
- linkedAccountId: "linked_account_id",
- pageSize: 1,
- startDate: "start_date",
- status: "ONGOING"
+await client.crm.contacts.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true
});
```
@@ -17557,7 +19475,7 @@ await client.hris.issues.list({
-
-**request:** `Merge.hris.IssuesListRequest`
+**id:** `string`
@@ -17565,7 +19483,15 @@ await client.hris.issues.list({
-
-**requestOptions:** `IssuesClient.RequestOptions`
+**request:** `Merge.crm.ContactsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -17577,7 +19503,7 @@ await client.hris.issues.list({
client.hris.issues.retrieve(id) -> Merge.Issue
+client.crm.contacts.partialUpdate(id, { ...params }) -> Merge.CrmContactResponse
-
@@ -17589,7 +19515,7 @@ await client.hris.issues.list({
-
-Get a specific issue.
+Updates a `Contact` object with the given `id`.
@@ -17604,7 +19530,11 @@ Get a specific issue.
-
```typescript
-await client.hris.issues.retrieve("id");
+await client.crm.contacts.partialUpdate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
+});
```
@@ -17628,68 +19558,7 @@ await client.hris.issues.retrieve("id");
-
-**requestOptions:** `IssuesClient.RequestOptions`
-
-
-
-
-
-
-
-
-
-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`
+**request:** `Merge.crm.PatchedCrmContactEndpointRequest`
@@ -17697,7 +19566,7 @@ await client.hris.linkToken.create({
-
-**requestOptions:** `LinkTokenClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -17709,8 +19578,7 @@ await client.hris.linkToken.create({
client.hris.linkedAccounts.list({ ...params }) -> Merge.PaginatedAccountDetailsAndActionsList
+client.crm.contacts.ignoreCreate(model_id, { ...params }) -> void
-
@@ -17722,7 +19590,7 @@ await client.hris.linkToken.create({
-
-List linked accounts for your organization.
+Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
@@ -17737,20 +19605,8 @@ List linked accounts for your organization.
-
```typescript
-await client.hris.linkedAccounts.list({
- category: "accounting",
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endUserEmailAddress: "end_user_email_address",
- endUserOrganizationName: "end_user_organization_name",
- endUserOriginId: "end_user_origin_id",
- endUserOriginIds: "end_user_origin_ids",
- id: "id",
- ids: "ids",
- includeDuplicates: true,
- integrationName: "integration_name",
- isTestAccount: "is_test_account",
- pageSize: 1,
- status: "status"
+await client.crm.contacts.ignoreCreate("model_id", {
+ reason: "GENERAL_CUSTOMER_REQUEST"
});
```
@@ -17767,7 +19623,7 @@ await client.hris.linkedAccounts.list({
-
-**request:** `Merge.hris.LinkedAccountsListRequest`
+**model_id:** `string`
@@ -17775,7 +19631,15 @@ await client.hris.linkedAccounts.list({
-
-**requestOptions:** `LinkedAccountsClient.RequestOptions`
+**request:** `Merge.IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -17787,8 +19651,7 @@ await client.hris.linkedAccounts.list({
client.hris.locations.list({ ...params }) -> Merge.PaginatedLocationList
+client.crm.contacts.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -17800,7 +19663,7 @@ await client.hris.linkedAccounts.list({
-
-Returns a list of `Location` objects.
+Returns metadata for `CRMContact` PATCHs.
@@ -17815,21 +19678,7 @@ Returns a list of `Location` objects.
-
```typescript
-await client.hris.locations.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
- includeRemoteData: true,
- includeShellData: true,
- locationType: "HOME",
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteFields: "country",
- remoteId: "remote_id",
- showEnumOrigins: "country"
-});
+await client.crm.contacts.metaPatchRetrieve("id");
```
@@ -17845,7 +19694,7 @@ await client.hris.locations.list({
-
-**request:** `Merge.hris.LocationsListRequest`
+**id:** `string`
@@ -17853,7 +19702,7 @@ await client.hris.locations.list({
-
-**requestOptions:** `LocationsClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -17865,7 +19714,7 @@ await client.hris.locations.list({
client.hris.locations.retrieve(id, { ...params }) -> Merge.Location
+client.crm.contacts.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -17877,7 +19726,7 @@ await client.hris.locations.list({
-
-Returns a `Location` object with the given `id`.
+Returns metadata for `CRMContact` POSTs.
@@ -17892,12 +19741,7 @@ Returns a `Location` object with the given `id`.
-
```typescript
-await client.hris.locations.retrieve("id", {
- includeRemoteData: true,
- includeShellData: true,
- remoteFields: "country",
- showEnumOrigins: "country"
-});
+await client.crm.contacts.metaPostRetrieve();
```
@@ -17913,23 +19757,7 @@ await client.hris.locations.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.LocationsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `LocationsClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -17941,8 +19769,7 @@ await client.hris.locations.retrieve("id", {
client.hris.passthrough.create({ ...params }) -> Merge.RemoteResponse
+client.crm.contacts.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -17954,7 +19781,7 @@ await client.hris.locations.retrieve("id", {
-
-Pull data from an endpoint not currently supported by Merge.
+Returns a list of `RemoteFieldClass` objects.
@@ -17969,10 +19796,37 @@ Pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.hris.passthrough.create({
- method: "GET",
- path: "/scooters"
+const pageableResponse = await client.crm.contacts.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.contacts.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -17988,7 +19842,7 @@ await client.hris.passthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
+**request:** `Merge.crm.ContactsRemoteFieldClassesListRequest`
@@ -17996,7 +19850,7 @@ await client.hris.passthrough.create({
-
-**requestOptions:** `PassthroughClient.RequestOptions`
+**requestOptions:** `ContactsClient.RequestOptions`
@@ -18008,8 +19862,8 @@ await client.hris.passthrough.create({
client.hris.payGroups.list({ ...params }) -> Merge.PaginatedPayGroupList
+## Crm CustomObjectClasses
+client.crm.customObjectClasses.list({ ...params }) -> core.Page
-
@@ -18021,7 +19875,7 @@ await client.hris.passthrough.create({
-
-Returns a list of `PayGroup` objects.
+Returns a list of `CustomObjectClass` objects.
@@ -18036,7 +19890,24 @@ Returns a list of `PayGroup` objects.
-
```typescript
-await client.hris.payGroups.list({
+const pageableResponse = await client.crm.customObjectClasses.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.customObjectClasses.list({
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
@@ -18048,6 +19919,12 @@ await client.hris.payGroups.list({
pageSize: 1,
remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -18063,7 +19940,7 @@ await client.hris.payGroups.list({
-
-**request:** `Merge.hris.PayGroupsListRequest`
+**request:** `Merge.crm.CustomObjectClassesListRequest`
@@ -18071,7 +19948,7 @@ await client.hris.payGroups.list({
-
-**requestOptions:** `PayGroupsClient.RequestOptions`
+**requestOptions:** `CustomObjectClassesClient.RequestOptions`
@@ -18083,7 +19960,7 @@ await client.hris.payGroups.list({
client.hris.payGroups.retrieve(id, { ...params }) -> Merge.PayGroup
+client.crm.customObjectClasses.retrieve(id, { ...params }) -> Merge.CustomObjectClass
-
@@ -18095,7 +19972,7 @@ await client.hris.payGroups.list({
-
-Returns a `PayGroup` object with the given `id`.
+Returns a `CustomObjectClass` object with the given `id`.
@@ -18110,7 +19987,7 @@ Returns a `PayGroup` object with the given `id`.
-
```typescript
-await client.hris.payGroups.retrieve("id", {
+await client.crm.customObjectClasses.retrieve("id", {
includeRemoteData: true,
includeShellData: true
});
@@ -18137,7 +20014,7 @@ await client.hris.payGroups.retrieve("id", {
-
-**request:** `Merge.hris.PayGroupsRetrieveRequest`
+**request:** `Merge.crm.CustomObjectClassesRetrieveRequest`
@@ -18145,7 +20022,7 @@ await client.hris.payGroups.retrieve("id", {
-
-**requestOptions:** `PayGroupsClient.RequestOptions`
+**requestOptions:** `CustomObjectClassesClient.RequestOptions`
@@ -18157,8 +20034,8 @@ await client.hris.payGroups.retrieve("id", {
client.hris.payrollRuns.list({ ...params }) -> Merge.PaginatedPayrollRunList
+## Crm AssociationTypes
+client.crm.associationTypes.customObjectClassesAssociationTypesList(custom_object_class_id, { ...params }) -> core.Page
-
@@ -18170,7 +20047,7 @@ await client.hris.payGroups.retrieve("id", {
-
-Returns a list of `PayrollRun` objects.
+Returns a list of `AssociationType` objects.
@@ -18185,25 +20062,41 @@ Returns a list of `PayrollRun` objects.
-
```typescript
-await client.hris.payrollRuns.list({
+const pageableResponse = await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id", {
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endedAfter: new Date("2024-01-15T09:30:00.000Z"),
- endedBefore: new Date("2024-01-15T09:30:00.000Z"),
includeDeletedData: true,
includeRemoteData: true,
includeShellData: true,
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
pageSize: 1,
- remoteFields: "run_state",
- remoteId: "remote_id",
- runType: "CORRECTION",
- showEnumOrigins: "run_state",
- startedAfter: new Date("2024-01-15T09:30:00.000Z"),
- startedBefore: new Date("2024-01-15T09:30:00.000Z")
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.associationTypes.customObjectClassesAssociationTypesList("custom_object_class_id", {
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -18219,7 +20112,7 @@ await client.hris.payrollRuns.list({
-
-**request:** `Merge.hris.PayrollRunsListRequest`
+**custom_object_class_id:** `string`
@@ -18227,7 +20120,15 @@ await client.hris.payrollRuns.list({
-
-**requestOptions:** `PayrollRunsClient.RequestOptions`
+**request:** `Merge.crm.CustomObjectClassesAssociationTypesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AssociationTypesClient.RequestOptions`
@@ -18239,7 +20140,7 @@ await client.hris.payrollRuns.list({
client.hris.payrollRuns.retrieve(id, { ...params }) -> Merge.PayrollRun
+client.crm.associationTypes.customObjectClassesAssociationTypesCreate(custom_object_class_id, { ...params }) -> Merge.CrmAssociationTypeResponse
-
@@ -18251,7 +20152,7 @@ await client.hris.payrollRuns.list({
-
-Returns a `PayrollRun` object with the given `id`.
+Creates an `AssociationType` object with the given values.
@@ -18266,11 +20167,20 @@ Returns a `PayrollRun` object with the given `id`.
-
```typescript
-await client.hris.payrollRuns.retrieve("id", {
- includeRemoteData: true,
- includeShellData: true,
- remoteFields: "run_state",
- showEnumOrigins: "run_state"
+await client.crm.associationTypes.customObjectClassesAssociationTypesCreate("custom_object_class_id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {
+ sourceObjectClass: {
+ id: "id",
+ originType: "CUSTOM_OBJECT"
+ },
+ targetObjectClasses: [{
+ id: "id",
+ originType: "CUSTOM_OBJECT"
+ }],
+ remoteKeyName: "remote_key_name"
+ }
});
```
@@ -18287,7 +20197,7 @@ await client.hris.payrollRuns.retrieve("id", {
-
-**id:** `string`
+**custom_object_class_id:** `string`
@@ -18295,7 +20205,7 @@ await client.hris.payrollRuns.retrieve("id", {
-
-**request:** `Merge.hris.PayrollRunsRetrieveRequest`
+**request:** `Merge.crm.CrmAssociationTypeEndpointRequest`
@@ -18303,7 +20213,7 @@ await client.hris.payrollRuns.retrieve("id", {
-
-**requestOptions:** `PayrollRunsClient.RequestOptions`
+**requestOptions:** `AssociationTypesClient.RequestOptions`
@@ -18315,8 +20225,7 @@ await client.hris.payrollRuns.retrieve("id", {
client.hris.regenerateKey.create({ ...params }) -> Merge.RemoteKey
+client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve(custom_object_class_id, id, { ...params }) -> Merge.AssociationType
-
@@ -18328,7 +20237,7 @@ await client.hris.payrollRuns.retrieve("id", {
-
-Exchange remote keys.
+Returns an `AssociationType` object with the given `id`.
@@ -18343,8 +20252,9 @@ Exchange remote keys.
-
```typescript
-await client.hris.regenerateKey.create({
- name: "Remote Deployment Key 1"
+await client.crm.associationTypes.customObjectClassesAssociationTypesRetrieve("custom_object_class_id", "id", {
+ includeRemoteData: true,
+ includeShellData: true
});
```
@@ -18361,7 +20271,7 @@ await client.hris.regenerateKey.create({
-
-**request:** `Merge.hris.RemoteKeyForRegenerationRequest`
+**custom_object_class_id:** `string`
@@ -18369,66 +20279,15 @@ await client.hris.regenerateKey.create({
-
-**requestOptions:** `RegenerateKeyClient.RequestOptions`
+**id:** `string`
-
-
-
-
-
-
-client.hris.syncStatus.list({ ...params }) -> Merge.PaginatedSyncStatusList
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.hris.syncStatus.list({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- pageSize: 1
-});
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-**request:** `Merge.hris.SyncStatusListRequest`
+**request:** `Merge.crm.CustomObjectClassesAssociationTypesRetrieveRequest`
@@ -18436,7 +20295,7 @@ await client.hris.syncStatus.list({
-
-**requestOptions:** `SyncStatusClient.RequestOptions`
+**requestOptions:** `AssociationTypesClient.RequestOptions`
@@ -18448,8 +20307,7 @@ await client.hris.syncStatus.list({
client.hris.forceResync.syncStatusResyncCreate() -> Merge.SyncStatus[]
+client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve(custom_object_class_id) -> Merge.MetaResponse
-
@@ -18461,7 +20319,7 @@ await client.hris.syncStatus.list({
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+Returns metadata for `CRMAssociationType` POSTs.
@@ -18476,7 +20334,7 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
-
```typescript
-await client.hris.forceResync.syncStatusResyncCreate();
+await client.crm.associationTypes.customObjectClassesAssociationTypesMetaPostRetrieve("custom_object_class_id");
```
@@ -18492,7 +20350,15 @@ await client.hris.forceResync.syncStatusResyncCreate();
-
-**requestOptions:** `ForceResyncClient.RequestOptions`
+**custom_object_class_id:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `AssociationTypesClient.RequestOptions`
@@ -18504,8 +20370,8 @@ await client.hris.forceResync.syncStatusResyncCreate();
client.hris.teams.list({ ...params }) -> Merge.PaginatedTeamList
+## Crm CustomObjects
+client.crm.customObjects.customObjectClassesCustomObjectsList(custom_object_class_id, { ...params }) -> core.Page
-
@@ -18517,7 +20383,7 @@ await client.hris.forceResync.syncStatusResyncCreate();
-
-Returns a list of `Team` objects.
+Returns a list of `CustomObject` objects.
@@ -18532,20 +20398,43 @@ Returns a list of `Team` objects.
-
```typescript
-await client.hris.teams.list({
+const pageableResponse = await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id", {
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "parent_team",
includeDeletedData: true,
includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.customObjects.customObjectClassesCustomObjectsList("custom_object_class_id", {
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true,
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
pageSize: 1,
- parentTeamId: "parent_team_id",
remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -18561,7 +20450,7 @@ await client.hris.teams.list({
-
-**request:** `Merge.hris.TeamsListRequest`
+**custom_object_class_id:** `string`
@@ -18569,7 +20458,15 @@ await client.hris.teams.list({
-
-**requestOptions:** `TeamsClient.RequestOptions`
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjectsClient.RequestOptions`
@@ -18581,7 +20478,7 @@ await client.hris.teams.list({
client.hris.teams.retrieve(id, { ...params }) -> Merge.Team
+client.crm.customObjects.customObjectClassesCustomObjectsCreate(custom_object_class_id, { ...params }) -> Merge.CrmCustomObjectResponse
-
@@ -18593,7 +20490,7 @@ await client.hris.teams.list({
-
-Returns a `Team` object with the given `id`.
+Creates a `CustomObject` object with the given values.
@@ -18608,10 +20505,14 @@ Returns a `Team` object with the given `id`.
-
```typescript
-await client.hris.teams.retrieve("id", {
- expand: "parent_team",
- includeRemoteData: true,
- includeShellData: true
+await client.crm.customObjects.customObjectClassesCustomObjectsCreate("custom_object_class_id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {
+ fields: {
+ "test_field": "hello"
+ }
+ }
});
```
@@ -18628,7 +20529,7 @@ await client.hris.teams.retrieve("id", {
-
-**id:** `string`
+**custom_object_class_id:** `string`
@@ -18636,7 +20537,7 @@ await client.hris.teams.retrieve("id", {
-
-**request:** `Merge.hris.TeamsRetrieveRequest`
+**request:** `Merge.crm.CrmCustomObjectEndpointRequest`
@@ -18644,7 +20545,7 @@ await client.hris.teams.retrieve("id", {
-
-**requestOptions:** `TeamsClient.RequestOptions`
+**requestOptions:** `CustomObjectsClient.RequestOptions`
@@ -18656,8 +20557,7 @@ await client.hris.teams.retrieve("id", {
client.hris.timeOff.list({ ...params }) -> Merge.PaginatedTimeOffList
+client.crm.customObjects.customObjectClassesCustomObjectsRetrieve(custom_object_class_id, id, { ...params }) -> Merge.CustomObject
-
@@ -18669,7 +20569,7 @@ await client.hris.teams.retrieve("id", {
-
-Returns a list of `TimeOff` objects.
+Returns a `CustomObject` object with the given `id`.
@@ -18684,28 +20584,10 @@ Returns a list of `TimeOff` objects.
-
```typescript
-await client.hris.timeOff.list({
- approverId: "approver_id",
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employeeId: "employee_id",
- endedAfter: new Date("2024-01-15T09:30:00.000Z"),
- endedBefore: new Date("2024-01-15T09:30:00.000Z"),
- expand: "approver",
- includeDeletedData: true,
+await client.crm.customObjects.customObjectClassesCustomObjectsRetrieve("custom_object_class_id", "id", {
includeRemoteData: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteFields: "request_type",
- remoteId: "remote_id",
- requestType: "BEREAVEMENT",
- showEnumOrigins: "request_type",
- startedAfter: new Date("2024-01-15T09:30:00.000Z"),
- startedBefore: new Date("2024-01-15T09:30:00.000Z"),
- status: "APPROVED"
+ includeRemoteFields: true,
+ includeShellData: true
});
```
@@ -18722,7 +20604,7 @@ await client.hris.timeOff.list({
-
-**request:** `Merge.hris.TimeOffListRequest`
+**custom_object_class_id:** `string`
@@ -18730,7 +20612,23 @@ await client.hris.timeOff.list({
-
-**requestOptions:** `TimeOffClient.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `CustomObjectsClient.RequestOptions`
@@ -18742,7 +20640,7 @@ await client.hris.timeOff.list({
client.hris.timeOff.create({ ...params }) -> Merge.TimeOffResponse
+client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve(custom_object_class_id) -> Merge.MetaResponse
-
@@ -18754,7 +20652,7 @@ await client.hris.timeOff.list({
-
-Creates a `TimeOff` object with the given values.
+Returns metadata for `CRMCustomObject` POSTs.
@@ -18769,11 +20667,7 @@ Creates a `TimeOff` object with the given values.
-
```typescript
-await client.hris.timeOff.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
-});
+await client.crm.customObjects.customObjectClassesCustomObjectsMetaPostRetrieve("custom_object_class_id");
```
@@ -18789,7 +20683,7 @@ await client.hris.timeOff.create({
-
-**request:** `Merge.hris.TimeOffEndpointRequest`
+**custom_object_class_id:** `string`
@@ -18797,7 +20691,7 @@ await client.hris.timeOff.create({
-
-**requestOptions:** `TimeOffClient.RequestOptions`
+**requestOptions:** `CustomObjectsClient.RequestOptions`
@@ -18809,7 +20703,7 @@ await client.hris.timeOff.create({
client.hris.timeOff.retrieve(id, { ...params }) -> Merge.TimeOff
+client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({ ...params }) -> core.Page
-
@@ -18821,7 +20715,7 @@ await client.hris.timeOff.create({
-
-Returns a `TimeOff` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -18836,13 +20730,37 @@ Returns a `TimeOff` object with the given `id`.
-
```typescript
-await client.hris.timeOff.retrieve("id", {
- expand: "approver",
+const pageableResponse = await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true,
- remoteFields: "request_type",
- showEnumOrigins: "request_type"
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.customObjects.customObjectClassesCustomObjectsRemoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -18858,15 +20776,7 @@ await client.hris.timeOff.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.TimeOffRetrieveRequest`
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsRemoteFieldClassesListRequest`
@@ -18874,7 +20784,7 @@ await client.hris.timeOff.retrieve("id", {
-
-**requestOptions:** `TimeOffClient.RequestOptions`
+**requestOptions:** `CustomObjectsClient.RequestOptions`
@@ -18886,7 +20796,8 @@ await client.hris.timeOff.retrieve("id", {
client.hris.timeOff.metaPostRetrieve() -> Merge.MetaResponse
+## Crm Associations
+client.crm.associations.customObjectClassesCustomObjectsAssociationsList(custom_object_class_id, object_id, { ...params }) -> core.Page
-
@@ -18898,7 +20809,7 @@ await client.hris.timeOff.retrieve("id", {
-
-Returns metadata for `TimeOff` POSTs.
+Returns a list of `Association` objects.
@@ -18913,7 +20824,43 @@ Returns metadata for `TimeOff` POSTs.
-
```typescript
-await client.hris.timeOff.metaPostRetrieve();
+const pageableResponse = await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id", {
+ associationTypeId: "association_type_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.associations.customObjectClassesCustomObjectsAssociationsList("custom_object_class_id", "object_id", {
+ associationTypeId: "association_type_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -18929,7 +20876,31 @@ await client.hris.timeOff.metaPostRetrieve();
-
-**requestOptions:** `TimeOffClient.RequestOptions`
+**custom_object_class_id:** `string`
+
+
+
+
+
+-
+
+**object_id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `AssociationsClient.RequestOptions`
@@ -18941,8 +20912,7 @@ await client.hris.timeOff.metaPostRetrieve();
client.hris.timeOffBalances.list({ ...params }) -> Merge.PaginatedTimeOffBalanceList
+client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate(source_class_id, source_object_id, target_class_id, target_object_id, association_type_id, { ...params }) -> Merge.Association
-
@@ -18954,7 +20924,7 @@ await client.hris.timeOff.metaPostRetrieve();
-
-Returns a list of `TimeOffBalance` objects.
+Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -18969,22 +20939,9 @@ Returns a list of `TimeOffBalance` objects.
-
```typescript
-await client.hris.timeOffBalances.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employeeId: "employee_id",
- expand: "employee",
- includeDeletedData: true,
- includeRemoteData: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- policyType: "BEREAVEMENT",
- remoteFields: "policy_type",
- remoteId: "remote_id",
- showEnumOrigins: "policy_type"
+await client.crm.associations.customObjectClassesCustomObjectsAssociationsUpdate("source_class_id", "source_object_id", "target_class_id", "target_object_id", "association_type_id", {
+ isDebugMode: true,
+ runAsync: true
});
```
@@ -19001,7 +20958,7 @@ await client.hris.timeOffBalances.list({
-
-**request:** `Merge.hris.TimeOffBalancesListRequest`
+**source_class_id:** `string`
@@ -19009,68 +20966,31 @@ await client.hris.timeOffBalances.list({
-
-**requestOptions:** `TimeOffBalancesClient.RequestOptions`
+**source_object_id:** `string`
-
-
-
-
-
-client.hris.timeOffBalances.retrieve(id, { ...params }) -> Merge.TimeOffBalance
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `TimeOffBalance` object with the given `id`.
-
-
+**target_class_id:** `string`
+
-#### 🔌 Usage
-
-
-
--
-
-```typescript
-await client.hris.timeOffBalances.retrieve("id", {
- expand: "employee",
- includeRemoteData: true,
- includeShellData: true,
- remoteFields: "policy_type",
- showEnumOrigins: "policy_type"
-});
-
-```
-
-
+**target_object_id:** `string`
+
-#### ⚙️ Parameters
-
-
--
-
-
-**id:** `string`
+**association_type_id:** `string`
@@ -19078,7 +20998,7 @@ await client.hris.timeOffBalances.retrieve("id", {
-
-**request:** `Merge.hris.TimeOffBalancesRetrieveRequest`
+**request:** `Merge.crm.CustomObjectClassesCustomObjectsAssociationsUpdateRequest`
@@ -19086,7 +21006,7 @@ await client.hris.timeOffBalances.retrieve("id", {
-
-**requestOptions:** `TimeOffBalancesClient.RequestOptions`
+**requestOptions:** `AssociationsClient.RequestOptions`
@@ -19098,8 +21018,8 @@ await client.hris.timeOffBalances.retrieve("id", {
client.hris.timesheetEntries.list({ ...params }) -> Merge.PaginatedTimesheetEntryList
+## Crm Scopes
+client.crm.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
-
@@ -19111,7 +21031,7 @@ await client.hris.timeOffBalances.retrieve("id", {
-
-Returns a list of `TimesheetEntry` objects.
+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).
@@ -19126,25 +21046,7 @@ Returns a list of `TimesheetEntry` objects.
-
```typescript
-await client.hris.timesheetEntries.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employeeId: "employee_id",
- endedAfter: new Date("2024-01-15T09:30:00.000Z"),
- endedBefore: new Date("2024-01-15T09:30:00.000Z"),
- expand: "employee",
- includeDeletedData: true,
- includeRemoteData: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- orderBy: "-start_time",
- pageSize: 1,
- remoteId: "remote_id",
- startedAfter: new Date("2024-01-15T09:30:00.000Z"),
- startedBefore: new Date("2024-01-15T09:30:00.000Z")
-});
+await client.crm.scopes.defaultScopesRetrieve();
```
@@ -19160,15 +21062,7 @@ await client.hris.timesheetEntries.list({
-
-**request:** `Merge.hris.TimesheetEntriesListRequest`
-
-
-
-
-
--
-
-**requestOptions:** `TimesheetEntriesClient.RequestOptions`
+**requestOptions:** `ScopesClient.RequestOptions`
@@ -19180,7 +21074,7 @@ await client.hris.timesheetEntries.list({
client.hris.timesheetEntries.create({ ...params }) -> Merge.TimesheetEntryResponse
+client.crm.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
-
@@ -19192,7 +21086,7 @@ await client.hris.timesheetEntries.list({
-
-Creates a `TimesheetEntry` object with the given values.
+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).
@@ -19207,11 +21101,7 @@ Creates a `TimesheetEntry` object with the given values.
-
```typescript
-await client.hris.timesheetEntries.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
-});
+await client.crm.scopes.linkedAccountScopesRetrieve();
```
@@ -19227,15 +21117,7 @@ await client.hris.timesheetEntries.create({
-
-**request:** `Merge.hris.TimesheetEntryEndpointRequest`
-
-
-
-
-
--
-
-**requestOptions:** `TimesheetEntriesClient.RequestOptions`
+**requestOptions:** `ScopesClient.RequestOptions`
@@ -19247,7 +21129,7 @@ await client.hris.timesheetEntries.create({
client.hris.timesheetEntries.retrieve(id, { ...params }) -> Merge.TimesheetEntry
+client.crm.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
-
@@ -19259,7 +21141,7 @@ await client.hris.timesheetEntries.create({
-
-Returns a `TimesheetEntry` object with the given `id`.
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -19274,10 +21156,29 @@ Returns a `TimesheetEntry` object with the given `id`.
-
```typescript
-await client.hris.timesheetEntries.retrieve("id", {
- expand: "employee",
- includeRemoteData: true,
- includeShellData: true
+await client.crm.scopes.linkedAccountScopesCreate({
+ commonModels: [{
+ modelName: "Employee",
+ modelPermissions: {
+ "READ": {
+ isEnabled: true
+ },
+ "WRITE": {
+ isEnabled: false
+ }
+ },
+ fieldPermissions: {
+ enabledFields: ["avatar", "home_location"],
+ disabledFields: ["work_location"]
+ }
+ }, {
+ modelName: "Benefit",
+ modelPermissions: {
+ "WRITE": {
+ isEnabled: false
+ }
+ }
+ }]
});
```
@@ -19294,15 +21195,7 @@ await client.hris.timesheetEntries.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.hris.TimesheetEntriesRetrieveRequest`
+**request:** `Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest`
@@ -19310,7 +21203,7 @@ await client.hris.timesheetEntries.retrieve("id", {
-
-**requestOptions:** `TimesheetEntriesClient.RequestOptions`
+**requestOptions:** `ScopesClient.RequestOptions`
@@ -19322,7 +21215,8 @@ await client.hris.timesheetEntries.retrieve("id", {
client.hris.timesheetEntries.metaPostRetrieve() -> Merge.MetaResponse
+## Crm DeleteAccount
+client.crm.deleteAccount.delete() -> void
-
@@ -19334,7 +21228,7 @@ await client.hris.timesheetEntries.retrieve("id", {
-
-Returns metadata for `TimesheetEntry` POSTs.
+Delete a linked account.
@@ -19349,7 +21243,7 @@ Returns metadata for `TimesheetEntry` POSTs.
-
```typescript
-await client.hris.timesheetEntries.metaPostRetrieve();
+await client.crm.deleteAccount.delete();
```
@@ -19365,7 +21259,7 @@ await client.hris.timesheetEntries.metaPostRetrieve();
-
-**requestOptions:** `TimesheetEntriesClient.RequestOptions`
+**requestOptions:** `DeleteAccountClient.RequestOptions`
@@ -19377,8 +21271,8 @@ await client.hris.timesheetEntries.metaPostRetrieve();
client.hris.webhookReceivers.list() -> Merge.WebhookReceiver[]
+## Crm EngagementTypes
+client.crm.engagementTypes.list({ ...params }) -> core.Page
-
@@ -19390,7 +21284,7 @@ await client.hris.timesheetEntries.metaPostRetrieve();
-
-Returns a list of `WebhookReceiver` objects.
+Returns a list of `EngagementType` objects.
@@ -19405,7 +21299,43 @@ Returns a list of `WebhookReceiver` objects.
-
```typescript
-await client.hris.webhookReceivers.list();
+const pageableResponse = await client.crm.engagementTypes.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.engagementTypes.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -19421,7 +21351,15 @@ await client.hris.webhookReceivers.list();
-
-**requestOptions:** `WebhookReceiversClient.RequestOptions`
+**request:** `Merge.crm.EngagementTypesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EngagementTypesClient.RequestOptions`
@@ -19433,7 +21371,7 @@ await client.hris.webhookReceivers.list();
client.hris.webhookReceivers.create({ ...params }) -> Merge.WebhookReceiver
+client.crm.engagementTypes.retrieve(id, { ...params }) -> Merge.EngagementType
-
@@ -19445,7 +21383,7 @@ await client.hris.webhookReceivers.list();
-
-Creates a `WebhookReceiver` object with the given values.
+Returns an `EngagementType` object with the given `id`.
@@ -19460,9 +21398,10 @@ Creates a `WebhookReceiver` object with the given values.
-
```typescript
-await client.hris.webhookReceivers.create({
- event: "event",
- isActive: true
+await client.crm.engagementTypes.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true
});
```
@@ -19479,7 +21418,7 @@ await client.hris.webhookReceivers.create({
-
-**request:** `Merge.hris.WebhookReceiverRequest`
+**id:** `string`
@@ -19487,7 +21426,15 @@ await client.hris.webhookReceivers.create({
-
-**requestOptions:** `WebhookReceiversClient.RequestOptions`
+**request:** `Merge.crm.EngagementTypesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EngagementTypesClient.RequestOptions`
@@ -19499,8 +21446,7 @@ await client.hris.webhookReceivers.create({
client.ticketing.accountDetails.retrieve() -> Merge.AccountDetails
+client.crm.engagementTypes.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -19512,7 +21458,7 @@ await client.hris.webhookReceivers.create({
-
-Get details for a linked account.
+Returns a list of `RemoteFieldClass` objects.
@@ -19527,7 +21473,37 @@ Get details for a linked account.
-
```typescript
-await client.ticketing.accountDetails.retrieve();
+const pageableResponse = await client.crm.engagementTypes.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.engagementTypes.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -19543,7 +21519,15 @@ await client.ticketing.accountDetails.retrieve();
-
-**requestOptions:** `AccountDetailsClient.RequestOptions`
+**request:** `Merge.crm.EngagementTypesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EngagementTypesClient.RequestOptions`
@@ -19555,8 +21539,8 @@ await client.ticketing.accountDetails.retrieve();
client.ticketing.accountToken.retrieve(public_token) -> Merge.AccountToken
+## Crm Engagements
+client.crm.engagements.list({ ...params }) -> core.Page
-
@@ -19568,7 +21552,7 @@ await client.ticketing.accountDetails.retrieve();
-
-Returns the account token for the end user with the provided public token.
+Returns a list of `Engagement` objects.
@@ -19583,7 +21567,47 @@ Returns the account token for the end user with the provided public token.
-
```typescript
-await client.ticketing.accountToken.retrieve("public_token");
+const pageableResponse = await client.crm.engagements.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ startedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ startedBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.engagements.list({
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ pageSize: 1,
+ remoteId: "remote_id",
+ startedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ startedBefore: new Date("2024-01-15T09:30:00.000Z")
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -19599,7 +21623,7 @@ await client.ticketing.accountToken.retrieve("public_token");
-
-**public_token:** `string`
+**request:** `Merge.crm.EngagementsListRequest`
@@ -19607,7 +21631,7 @@ await client.ticketing.accountToken.retrieve("public_token");
-
-**requestOptions:** `AccountTokenClient.RequestOptions`
+**requestOptions:** `EngagementsClient.RequestOptions`
@@ -19619,8 +21643,7 @@ await client.ticketing.accountToken.retrieve("public_token");
client.ticketing.accounts.list({ ...params }) -> Merge.PaginatedAccountList
+client.crm.engagements.create({ ...params }) -> Merge.EngagementResponse
-
@@ -19632,7 +21655,7 @@ await client.ticketing.accountToken.retrieve("public_token");
-
-Returns a list of `Account` objects.
+Creates an `Engagement` object with the given values.
@@ -19647,17 +21670,10 @@ Returns a list of `Account` objects.
-
```typescript
-await client.ticketing.accounts.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- includeDeletedData: true,
- includeRemoteData: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteId: "remote_id"
+await client.crm.engagements.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -19674,7 +21690,7 @@ await client.ticketing.accounts.list({
-
-**request:** `Merge.ticketing.AccountsListRequest`
+**request:** `Merge.crm.EngagementEndpointRequest`
@@ -19682,7 +21698,7 @@ await client.ticketing.accounts.list({
-
-**requestOptions:** `AccountsClient.RequestOptions`
+**requestOptions:** `EngagementsClient.RequestOptions`
@@ -19694,7 +21710,7 @@ await client.ticketing.accounts.list({
client.ticketing.accounts.retrieve(id, { ...params }) -> Merge.Account
+client.crm.engagements.retrieve(id, { ...params }) -> Merge.Engagement
-
@@ -19706,7 +21722,7 @@ await client.ticketing.accounts.list({
-
-Returns an `Account` object with the given `id`.
+Returns an `Engagement` object with the given `id`.
@@ -19721,8 +21737,9 @@ Returns an `Account` object with the given `id`.
-
```typescript
-await client.ticketing.accounts.retrieve("id", {
+await client.crm.engagements.retrieve("id", {
includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true
});
@@ -19748,7 +21765,7 @@ await client.ticketing.accounts.retrieve("id", {
-
-**request:** `Merge.ticketing.AccountsRetrieveRequest`
+**request:** `Merge.crm.EngagementsRetrieveRequest`
@@ -19756,7 +21773,7 @@ await client.ticketing.accounts.retrieve("id", {
-
-**requestOptions:** `AccountsClient.RequestOptions`
+**requestOptions:** `EngagementsClient.RequestOptions`
@@ -19768,8 +21785,7 @@ await client.ticketing.accounts.retrieve("id", {
client.ticketing.asyncPassthrough.create({ ...params }) -> Merge.AsyncPassthroughReciept
+client.crm.engagements.partialUpdate(id, { ...params }) -> Merge.EngagementResponse
-
@@ -19781,7 +21797,7 @@ await client.ticketing.accounts.retrieve("id", {
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Updates an `Engagement` object with the given `id`.
@@ -19796,9 +21812,10 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
-
```typescript
-await client.ticketing.asyncPassthrough.create({
- method: "GET",
- path: "/scooters"
+await client.crm.engagements.partialUpdate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -19815,7 +21832,7 @@ await client.ticketing.asyncPassthrough.create({
-
-**request:** `Merge.DataPassthroughRequest`
+**id:** `string`
@@ -19823,7 +21840,15 @@ await client.ticketing.asyncPassthrough.create({
-
-**requestOptions:** `AsyncPassthroughClient.RequestOptions`
+**request:** `Merge.crm.PatchedEngagementEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `EngagementsClient.RequestOptions`
@@ -19835,7 +21860,7 @@ await client.ticketing.asyncPassthrough.create({
client.ticketing.asyncPassthrough.retrieve(async_passthrough_receipt_id) -> Merge.AsyncPassthroughRetrieveResponse
+client.crm.engagements.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -19847,7 +21872,7 @@ await client.ticketing.asyncPassthrough.create({
-
-Retrieves data from earlier async-passthrough POST request
+Returns metadata for `Engagement` PATCHs.
@@ -19862,7 +21887,7 @@ Retrieves data from earlier async-passthrough POST request
-
```typescript
-await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id");
+await client.crm.engagements.metaPatchRetrieve("id");
```
@@ -19878,7 +21903,7 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
-
-**async_passthrough_receipt_id:** `string`
+**id:** `string`
@@ -19886,7 +21911,7 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
-
-**requestOptions:** `AsyncPassthroughClient.RequestOptions`
+**requestOptions:** `EngagementsClient.RequestOptions`
@@ -19898,8 +21923,7 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
client.ticketing.attachments.list({ ...params }) -> Merge.PaginatedAttachmentList
+client.crm.engagements.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -19911,7 +21935,7 @@ await client.ticketing.asyncPassthrough.retrieve("async_passthrough_receipt_id")
-
-Returns a list of `Attachment` objects.
+Returns metadata for `Engagement` POSTs.
@@ -19926,21 +21950,92 @@ Returns a list of `Attachment` objects.
-
```typescript
-await client.ticketing.attachments.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+await client.crm.engagements.metaPostRetrieve();
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**requestOptions:** `EngagementsClient.RequestOptions`
+
+
+
+
+
+
+
+
+
+client.crm.engagements.remoteFieldClassesList({ ...params }) -> core.Page
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+const pageableResponse = await client.crm.engagements.remoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "ticket",
includeDeletedData: true,
includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"),
- remoteId: "remote_id",
- ticketId: "ticket_id"
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.engagements.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -19956,7 +22051,7 @@ await client.ticketing.attachments.list({
-
-**request:** `Merge.ticketing.AttachmentsListRequest`
+**request:** `Merge.crm.EngagementsRemoteFieldClassesListRequest`
@@ -19964,7 +22059,7 @@ await client.ticketing.attachments.list({
-
-**requestOptions:** `AttachmentsClient.RequestOptions`
+**requestOptions:** `EngagementsClient.RequestOptions`
@@ -19976,7 +22071,8 @@ await client.ticketing.attachments.list({
client.ticketing.attachments.create({ ...params }) -> Merge.TicketingAttachmentResponse
+## Crm FieldMapping
+client.crm.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
-
@@ -19988,7 +22084,7 @@ await client.ticketing.attachments.list({
-
-Creates an `Attachment` object with the given values.
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -20003,10 +22099,8 @@ Creates an `Attachment` object with the given values.
-
```typescript
-await client.ticketing.attachments.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
+await client.crm.fieldMapping.fieldMappingsRetrieve({
+ excludeRemoteFieldMetadata: true
});
```
@@ -20023,7 +22117,7 @@ await client.ticketing.attachments.create({
-
-**request:** `Merge.ticketing.TicketingAttachmentEndpointRequest`
+**request:** `Merge.crm.FieldMappingsRetrieveRequest`
@@ -20031,7 +22125,7 @@ await client.ticketing.attachments.create({
-
-**requestOptions:** `AttachmentsClient.RequestOptions`
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -20043,7 +22137,7 @@ await client.ticketing.attachments.create({
client.ticketing.attachments.retrieve(id, { ...params }) -> Merge.Attachment
+client.crm.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
-
@@ -20055,7 +22149,7 @@ await client.ticketing.attachments.create({
-
-Returns an `Attachment` object with the given `id`.
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -20070,10 +22164,15 @@ Returns an `Attachment` object with the given `id`.
-
```typescript
-await client.ticketing.attachments.retrieve("id", {
- expand: "ticket",
- includeRemoteData: true,
- includeShellData: true
+await client.crm.fieldMapping.fieldMappingsCreate({
+ excludeRemoteFieldMetadata: true,
+ remoteDataIterationCount: 1,
+ targetFieldName: "example_target_field_name",
+ targetFieldDescription: "this is a example description of the target field",
+ remoteFieldTraversalPath: ["example_remote_field"],
+ remoteMethod: "GET",
+ remoteUrlPath: "/example-url-path",
+ commonModelName: "ExampleCommonModel"
});
```
@@ -20090,7 +22189,7 @@ await client.ticketing.attachments.retrieve("id", {
-
-**id:** `string`
+**request:** `Merge.crm.CreateFieldMappingRequest`
@@ -20098,15 +22197,70 @@ await client.ticketing.attachments.retrieve("id", {
-
-**request:** `Merge.ticketing.AttachmentsRetrieveRequest`
+**requestOptions:** `FieldMappingClient.RequestOptions`
+
+
+
+
+
+client.crm.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> Merge.FieldMappingInstanceResponse
-
-**requestOptions:** `AttachmentsClient.RequestOptions`
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.crm.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `string`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -20118,7 +22272,7 @@ await client.ticketing.attachments.retrieve("id", {
client.ticketing.attachments.metaPostRetrieve() -> Merge.MetaResponse
+client.crm.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...params }) -> Merge.FieldMappingInstanceResponse
-
@@ -20130,7 +22284,7 @@ await client.ticketing.attachments.retrieve("id", {
-
-Returns metadata for `TicketingAttachment` POSTs.
+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.
@@ -20145,7 +22299,9 @@ Returns metadata for `TicketingAttachment` POSTs.
-
```typescript
-await client.ticketing.attachments.metaPostRetrieve();
+await client.crm.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", {
+ remoteDataIterationCount: 1
+});
```
@@ -20161,7 +22317,23 @@ await client.ticketing.attachments.metaPostRetrieve();
-
-**requestOptions:** `AttachmentsClient.RequestOptions`
+**field_mapping_id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.PatchedEditFieldMappingRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -20173,8 +22345,7 @@ await client.ticketing.attachments.metaPostRetrieve();
client.ticketing.auditTrail.list({ ...params }) -> Merge.PaginatedAuditLogEventList
+client.crm.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
-
@@ -20186,7 +22357,7 @@ await client.ticketing.attachments.metaPostRetrieve();
-
-Gets a list of audit trail events.
+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/).
@@ -20201,13 +22372,9 @@ Gets a list of audit trail events.
-
```typescript
-await client.ticketing.auditTrail.list({
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- endDate: "end_date",
- eventType: "event_type",
- pageSize: 1,
- startDate: "start_date",
- userEmail: "user_email"
+await client.crm.fieldMapping.remoteFieldsRetrieve({
+ commonModels: "common_models",
+ includeExampleValues: "include_example_values"
});
```
@@ -20224,7 +22391,7 @@ await client.ticketing.auditTrail.list({
-
-**request:** `Merge.ticketing.AuditTrailListRequest`
+**request:** `Merge.crm.RemoteFieldsRetrieveRequest`
@@ -20232,7 +22399,7 @@ await client.ticketing.auditTrail.list({
-
-**requestOptions:** `AuditTrailClient.RequestOptions`
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -20244,8 +22411,7 @@ await client.ticketing.auditTrail.list({
client.ticketing.availableActions.retrieve() -> Merge.AvailableActions
+client.crm.fieldMapping.targetFieldsRetrieve() -> Merge.ExternalTargetFieldApiResponse
-
@@ -20257,7 +22423,7 @@ await client.ticketing.auditTrail.list({
-
-Returns a list of models and actions available for an account.
+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/).
@@ -20272,7 +22438,7 @@ Returns a list of models and actions available for an account.
-
```typescript
-await client.ticketing.availableActions.retrieve();
+await client.crm.fieldMapping.targetFieldsRetrieve();
```
@@ -20288,7 +22454,7 @@ await client.ticketing.availableActions.retrieve();
-
-**requestOptions:** `AvailableActionsClient.RequestOptions`
+**requestOptions:** `FieldMappingClient.RequestOptions`
@@ -20300,8 +22466,8 @@ await client.ticketing.availableActions.retrieve();
client.ticketing.collections.list({ ...params }) -> Merge.PaginatedCollectionList
+## Crm GenerateKey
+client.crm.generateKey.create({ ...params }) -> Merge.RemoteKey
-
@@ -20313,7 +22479,7 @@ await client.ticketing.availableActions.retrieve();
-
-Returns a list of `Collection` objects.
+Create a remote key.
@@ -20328,23 +22494,8 @@ Returns a list of `Collection` objects.
-
```typescript
-await client.ticketing.collections.list({
- collectionType: "",
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
- cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "parent_collection",
- includeDeletedData: true,
- includeRemoteData: true,
- includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- name: "name",
- pageSize: 1,
- parentCollectionId: "parent_collection_id",
- remoteFields: "collection_type",
- remoteId: "remote_id",
- showEnumOrigins: "collection_type"
+await client.crm.generateKey.create({
+ name: "Remote Deployment Key 1"
});
```
@@ -20361,7 +22512,7 @@ await client.ticketing.collections.list({
-
-**request:** `Merge.ticketing.CollectionsListRequest`
+**request:** `Merge.crm.GenerateRemoteKeyRequest`
@@ -20369,7 +22520,7 @@ await client.ticketing.collections.list({
-
-**requestOptions:** `CollectionsClient.RequestOptions`
+**requestOptions:** `GenerateKeyClient.RequestOptions`
@@ -20381,7 +22532,8 @@ await client.ticketing.collections.list({
client.ticketing.collections.viewersList(collection_id, { ...params }) -> Merge.PaginatedViewerList
+## Crm Issues
+client.crm.issues.list({ ...params }) -> core.Page
-
@@ -20393,7 +22545,7 @@ await client.ticketing.collections.list({
-
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
+Gets all issues for Organization.
@@ -20408,14 +22560,49 @@ Returns a list of `Viewer` objects that point to a User id or Team id that is ei
-
```typescript
-await client.ticketing.collections.viewersList("collection_id", {
+const pageableResponse = await client.crm.issues.list({
+ accountToken: "account_token",
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "team",
- includeDeletedData: true,
- includeRemoteData: true,
- includeShellData: true,
- pageSize: 1
+ endDate: "end_date",
+ endUserOrganizationName: "end_user_organization_name",
+ firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
+ includeMuted: "include_muted",
+ integrationName: "integration_name",
+ lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
+ linkedAccountId: "linked_account_id",
+ pageSize: 1,
+ startDate: "start_date",
+ status: "ONGOING"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.issues.list({
+ accountToken: "account_token",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endDate: "end_date",
+ endUserOrganizationName: "end_user_organization_name",
+ firstIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ firstIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
+ includeMuted: "include_muted",
+ integrationName: "integration_name",
+ lastIncidentTimeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ lastIncidentTimeBefore: new Date("2024-01-15T09:30:00.000Z"),
+ linkedAccountId: "linked_account_id",
+ pageSize: 1,
+ startDate: "start_date",
+ status: "ONGOING"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -20431,15 +22618,7 @@ await client.ticketing.collections.viewersList("collection_id", {
-
-**collection_id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.CollectionsViewersListRequest`
+**request:** `Merge.crm.IssuesListRequest`
@@ -20447,7 +22626,7 @@ await client.ticketing.collections.viewersList("collection_id", {
-
-**requestOptions:** `CollectionsClient.RequestOptions`
+**requestOptions:** `IssuesClient.RequestOptions`
@@ -20459,7 +22638,7 @@ await client.ticketing.collections.viewersList("collection_id", {
client.ticketing.collections.retrieve(id, { ...params }) -> Merge.Collection
+client.crm.issues.retrieve(id) -> Merge.Issue
-
@@ -20471,7 +22650,7 @@ await client.ticketing.collections.viewersList("collection_id", {
-
-Returns a `Collection` object with the given `id`.
+Get a specific issue.
@@ -20486,13 +22665,7 @@ Returns a `Collection` object with the given `id`.
-
```typescript
-await client.ticketing.collections.retrieve("id", {
- expand: "parent_collection",
- includeRemoteData: true,
- includeShellData: true,
- remoteFields: "collection_type",
- showEnumOrigins: "collection_type"
-});
+await client.crm.issues.retrieve("id");
```
@@ -20516,15 +22689,7 @@ await client.ticketing.collections.retrieve("id", {
-
-**request:** `Merge.ticketing.CollectionsRetrieveRequest`
-
-
-
-
-
--
-
-**requestOptions:** `CollectionsClient.RequestOptions`
+**requestOptions:** `IssuesClient.RequestOptions`
@@ -20536,8 +22701,8 @@ await client.ticketing.collections.retrieve("id", {
client.ticketing.comments.list({ ...params }) -> Merge.PaginatedCommentList
+## Crm Leads
+client.crm.leads.list({ ...params }) -> core.Page
-
@@ -20549,7 +22714,7 @@ await client.ticketing.collections.retrieve("id", {
-
-Returns a list of `Comment` objects.
+Returns a list of `Lead` objects.
@@ -20564,21 +22729,53 @@ Returns a list of `Comment` objects.
-
```typescript
-await client.ticketing.comments.list({
+const pageableResponse = await client.crm.leads.list({
+ convertedAccountId: "converted_account_id",
+ convertedContactId: "converted_contact_id",
createdAfter: new Date("2024-01-15T09:30:00.000Z"),
createdBefore: new Date("2024-01-15T09:30:00.000Z"),
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand: "contact",
+ emailAddresses: "email_addresses",
includeDeletedData: true,
includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true,
modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ ownerId: "owner_id",
pageSize: 1,
- remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"),
- remoteId: "remote_id",
- ticketId: "ticket_id"
+ phoneNumbers: "phone_numbers",
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.leads.list({
+ convertedAccountId: "converted_account_id",
+ convertedContactId: "converted_contact_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ emailAddresses: "email_addresses",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ ownerId: "owner_id",
+ pageSize: 1,
+ phoneNumbers: "phone_numbers",
+ remoteId: "remote_id"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -20594,7 +22791,7 @@ await client.ticketing.comments.list({
-
-**request:** `Merge.ticketing.CommentsListRequest`
+**request:** `Merge.crm.LeadsListRequest`
@@ -20602,7 +22799,7 @@ await client.ticketing.comments.list({
-
-**requestOptions:** `CommentsClient.RequestOptions`
+**requestOptions:** `LeadsClient.RequestOptions`
@@ -20614,7 +22811,7 @@ await client.ticketing.comments.list({
client.ticketing.comments.create({ ...params }) -> Merge.CommentResponse
+client.crm.leads.create({ ...params }) -> Merge.LeadResponse
-
@@ -20626,7 +22823,7 @@ await client.ticketing.comments.list({
-
-Creates a `Comment` object with the given values.
+Creates a `Lead` object with the given values.
@@ -20641,7 +22838,7 @@ Creates a `Comment` object with the given values.
-
```typescript
-await client.ticketing.comments.create({
+await client.crm.leads.create({
isDebugMode: true,
runAsync: true,
model: {}
@@ -20661,7 +22858,7 @@ await client.ticketing.comments.create({
-
-**request:** `Merge.ticketing.CommentEndpointRequest`
+**request:** `Merge.crm.LeadEndpointRequest`
@@ -20669,7 +22866,7 @@ await client.ticketing.comments.create({
-
-**requestOptions:** `CommentsClient.RequestOptions`
+**requestOptions:** `LeadsClient.RequestOptions`
@@ -20681,7 +22878,7 @@ await client.ticketing.comments.create({
client.ticketing.comments.retrieve(id, { ...params }) -> Merge.Comment
+client.crm.leads.retrieve(id, { ...params }) -> Merge.Lead
-
@@ -20693,7 +22890,7 @@ await client.ticketing.comments.create({
-
-Returns a `Comment` object with the given `id`.
+Returns a `Lead` object with the given `id`.
@@ -20708,9 +22905,9 @@ Returns a `Comment` object with the given `id`.
-
```typescript
-await client.ticketing.comments.retrieve("id", {
- expand: "contact",
+await client.crm.leads.retrieve("id", {
includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true
});
@@ -20736,7 +22933,7 @@ await client.ticketing.comments.retrieve("id", {
-
-**request:** `Merge.ticketing.CommentsRetrieveRequest`
+**request:** `Merge.crm.LeadsRetrieveRequest`
@@ -20744,7 +22941,7 @@ await client.ticketing.comments.retrieve("id", {
-
-**requestOptions:** `CommentsClient.RequestOptions`
+**requestOptions:** `LeadsClient.RequestOptions`
@@ -20756,7 +22953,7 @@ await client.ticketing.comments.retrieve("id", {
client.ticketing.comments.metaPostRetrieve() -> Merge.MetaResponse
+client.crm.leads.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -20768,7 +22965,7 @@ await client.ticketing.comments.retrieve("id", {
-
-Returns metadata for `Comment` POSTs.
+Returns metadata for `Lead` POSTs.
@@ -20783,7 +22980,7 @@ Returns metadata for `Comment` POSTs.
-
```typescript
-await client.ticketing.comments.metaPostRetrieve();
+await client.crm.leads.metaPostRetrieve();
```
@@ -20799,7 +22996,7 @@ await client.ticketing.comments.metaPostRetrieve();
-
-**requestOptions:** `CommentsClient.RequestOptions`
+**requestOptions:** `LeadsClient.RequestOptions`
@@ -20811,8 +23008,7 @@ await client.ticketing.comments.metaPostRetrieve();
client.ticketing.contacts.list({ ...params }) -> Merge.PaginatedContactList
+client.crm.leads.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -20824,7 +23020,7 @@ await client.ticketing.comments.metaPostRetrieve();
-
-Returns a list of `Contact` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -20839,20 +23035,37 @@ Returns a list of `Contact` objects.
-
```typescript
-await client.ticketing.contacts.list({
- createdAfter: new Date("2024-01-15T09:30:00.000Z"),
- createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+const pageableResponse = await client.crm.leads.remoteFieldClassesList({
cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- emailAddress: "email_address",
- expand: "account",
includeDeletedData: true,
includeRemoteData: true,
+ includeRemoteFields: true,
includeShellData: true,
- modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
- modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
- pageSize: 1,
- remoteId: "remote_id"
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.leads.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -20868,7 +23081,7 @@ await client.ticketing.contacts.list({
-
-**request:** `Merge.ticketing.ContactsListRequest`
+**request:** `Merge.crm.LeadsRemoteFieldClassesListRequest`
@@ -20876,7 +23089,7 @@ await client.ticketing.contacts.list({
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**requestOptions:** `LeadsClient.RequestOptions`
@@ -20888,7 +23101,8 @@ await client.ticketing.contacts.list({
client.ticketing.contacts.create({ ...params }) -> Merge.TicketingContactResponse
+## Crm LinkToken
+client.crm.linkToken.create({ ...params }) -> Merge.LinkToken
-
@@ -20900,7 +23114,7 @@ await client.ticketing.contacts.list({
-
-Creates a `Contact` object with the given values.
+Creates a link token to be used when linking a new end user. The link token expires after single use.
@@ -20915,10 +23129,11 @@ Creates a `Contact` object with the given values.
-
```typescript
-await client.ticketing.contacts.create({
- isDebugMode: true,
- runAsync: true,
- model: {}
+await client.crm.linkToken.create({
+ endUserEmailAddress: "example@gmail.com",
+ endUserOrganizationName: "Test Organization",
+ endUserOriginId: "12345",
+ categories: ["hris", "ats"]
});
```
@@ -20935,7 +23150,7 @@ await client.ticketing.contacts.create({
-
-**request:** `Merge.ticketing.TicketingContactEndpointRequest`
+**request:** `Merge.crm.EndUserDetailsRequest`
@@ -20943,7 +23158,7 @@ await client.ticketing.contacts.create({
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**requestOptions:** `LinkTokenClient.RequestOptions`
@@ -20955,7 +23170,8 @@ await client.ticketing.contacts.create({
client.ticketing.contacts.retrieve(id, { ...params }) -> Merge.Contact
+## Crm LinkedAccounts
+client.crm.linkedAccounts.list({ ...params }) -> core.Page
-
@@ -20967,7 +23183,7 @@ await client.ticketing.contacts.create({
-
-Returns a `Contact` object with the given `id`.
+List linked accounts for your organization.
@@ -20982,11 +23198,47 @@ Returns a `Contact` object with the given `id`.
-
```typescript
-await client.ticketing.contacts.retrieve("id", {
- expand: "account",
- includeRemoteData: true,
- includeShellData: true
+const pageableResponse = await client.crm.linkedAccounts.list({
+ category: "accounting",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endUserEmailAddress: "end_user_email_address",
+ endUserOrganizationName: "end_user_organization_name",
+ endUserOriginId: "end_user_origin_id",
+ endUserOriginIds: "end_user_origin_ids",
+ id: "id",
+ ids: "ids",
+ includeDuplicates: true,
+ integrationName: "integration_name",
+ isTestAccount: "is_test_account",
+ pageSize: 1,
+ status: "status"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.linkedAccounts.list({
+ category: "accounting",
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ endUserEmailAddress: "end_user_email_address",
+ endUserOrganizationName: "end_user_organization_name",
+ endUserOriginId: "end_user_origin_id",
+ endUserOriginIds: "end_user_origin_ids",
+ id: "id",
+ ids: "ids",
+ includeDuplicates: true,
+ integrationName: "integration_name",
+ isTestAccount: "is_test_account",
+ pageSize: 1,
+ status: "status"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -21002,15 +23254,7 @@ await client.ticketing.contacts.retrieve("id", {
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Merge.ticketing.ContactsRetrieveRequest`
+**request:** `Merge.crm.LinkedAccountsListRequest`
@@ -21018,7 +23262,7 @@ await client.ticketing.contacts.retrieve("id", {
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**requestOptions:** `LinkedAccountsClient.RequestOptions`
@@ -21030,7 +23274,8 @@ await client.ticketing.contacts.retrieve("id", {
client.ticketing.contacts.metaPostRetrieve() -> Merge.MetaResponse
+## Crm Notes
+client.crm.notes.list({ ...params }) -> core.Page
-
@@ -21042,7 +23287,7 @@ await client.ticketing.contacts.retrieve("id", {
-
-Returns metadata for `TicketingContact` POSTs.
+Returns a list of `Note` objects.
@@ -21057,7 +23302,51 @@ Returns metadata for `TicketingContact` POSTs.
-
```typescript
-await client.ticketing.contacts.metaPostRetrieve();
+const pageableResponse = await client.crm.notes.list({
+ accountId: "account_id",
+ contactId: "contact_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ opportunityId: "opportunity_id",
+ ownerId: "owner_id",
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.notes.list({
+ accountId: "account_id",
+ contactId: "contact_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ opportunityId: "opportunity_id",
+ ownerId: "owner_id",
+ pageSize: 1,
+ remoteId: "remote_id"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -21073,7 +23362,15 @@ await client.ticketing.contacts.metaPostRetrieve();
-
-**requestOptions:** `ContactsClient.RequestOptions`
+**request:** `Merge.crm.NotesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `NotesClient.RequestOptions`
@@ -21085,8 +23382,7 @@ await client.ticketing.contacts.metaPostRetrieve();
client.ticketing.scopes.defaultScopesRetrieve() -> Merge.CommonModelScopeApi
+client.crm.notes.create({ ...params }) -> Merge.NoteResponse
-
@@ -21098,7 +23394,7 @@ await client.ticketing.contacts.metaPostRetrieve();
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Creates a `Note` object with the given values.
@@ -21113,7 +23409,11 @@ Get the default permissions for Merge Common Models and fields across all Linked
-
```typescript
-await client.ticketing.scopes.defaultScopesRetrieve();
+await client.crm.notes.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
+});
```
@@ -21129,7 +23429,15 @@ await client.ticketing.scopes.defaultScopesRetrieve();
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**request:** `Merge.crm.NoteEndpointRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `NotesClient.RequestOptions`
@@ -21141,7 +23449,7 @@ await client.ticketing.scopes.defaultScopesRetrieve();
client.ticketing.scopes.linkedAccountScopesRetrieve() -> Merge.CommonModelScopeApi
+client.crm.notes.retrieve(id, { ...params }) -> Merge.Note
-
@@ -21153,7 +23461,7 @@ await client.ticketing.scopes.defaultScopesRetrieve();
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a `Note` object with the given `id`.
@@ -21168,7 +23476,11 @@ Get all available permissions for Merge Common Models and fields for a single Li
-
```typescript
-await client.ticketing.scopes.linkedAccountScopesRetrieve();
+await client.crm.notes.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true
+});
```
@@ -21184,7 +23496,23 @@ await client.ticketing.scopes.linkedAccountScopesRetrieve();
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**id:** `string`
+
+
+
+
+
+-
+
+**request:** `Merge.crm.NotesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `NotesClient.RequestOptions`
@@ -21196,7 +23524,7 @@ await client.ticketing.scopes.linkedAccountScopesRetrieve();
client.ticketing.scopes.linkedAccountScopesCreate({ ...params }) -> Merge.CommonModelScopeApi
+client.crm.notes.metaPostRetrieve() -> Merge.MetaResponse
-
@@ -21208,7 +23536,7 @@ await client.ticketing.scopes.linkedAccountScopesRetrieve();
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+Returns metadata for `Note` POSTs.
@@ -21223,30 +23551,7 @@ Update permissions for any Common Model or field for a single Linked Account. An
-
```typescript
-await client.ticketing.scopes.linkedAccountScopesCreate({
- commonModels: [{
- modelName: "Employee",
- modelPermissions: {
- "READ": {
- isEnabled: true
- },
- "WRITE": {
- isEnabled: false
- }
- },
- fieldPermissions: {
- enabledFields: ["avatar", "home_location"],
- disabledFields: ["work_location"]
- }
- }, {
- modelName: "Benefit",
- modelPermissions: {
- "WRITE": {
- isEnabled: false
- }
- }
- }]
-});
+await client.crm.notes.metaPostRetrieve();
```
@@ -21262,15 +23567,7 @@ await client.ticketing.scopes.linkedAccountScopesCreate({
-
-**request:** `Merge.ticketing.LinkedAccountCommonModelScopeDeserializerRequest`
-
-
-
-
-
--
-
-**requestOptions:** `ScopesClient.RequestOptions`
+**requestOptions:** `NotesClient.RequestOptions`
@@ -21282,8 +23579,7 @@ await client.ticketing.scopes.linkedAccountScopesCreate({
client.ticketing.deleteAccount.delete() -> void
+client.crm.notes.remoteFieldClassesList({ ...params }) -> core.Page
-
@@ -21295,7 +23591,7 @@ await client.ticketing.scopes.linkedAccountScopesCreate({
-
-Delete a linked account.
+Returns a list of `RemoteFieldClass` objects.
@@ -21310,7 +23606,37 @@ Delete a linked account.
-
```typescript
-await client.ticketing.deleteAccount.delete();
+const pageableResponse = await client.crm.notes.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.notes.remoteFieldClassesList({
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ isCommonModelField: true,
+ isCustom: true,
+ pageSize: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -21326,7 +23652,15 @@ await client.ticketing.deleteAccount.delete();
-
-**requestOptions:** `DeleteAccountClient.RequestOptions`
+**request:** `Merge.crm.NotesRemoteFieldClassesListRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `NotesClient.RequestOptions`
@@ -21338,8 +23672,8 @@ await client.ticketing.deleteAccount.delete();
client.ticketing.fieldMapping.fieldMappingsRetrieve({ ...params }) -> Merge.FieldMappingApiInstanceResponse
+## Crm Opportunities
+client.crm.opportunities.list({ ...params }) -> core.Page
-
@@ -21351,7 +23685,7 @@ await client.ticketing.deleteAccount.delete();
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns a list of `Opportunity` objects.
@@ -21366,9 +23700,57 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
-
```typescript
-await client.ticketing.fieldMapping.fieldMappingsRetrieve({
- excludeRemoteFieldMetadata: true
+const pageableResponse = await client.crm.opportunities.list({
+ accountId: "account_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ ownerId: "owner_id",
+ pageSize: 1,
+ remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status",
+ stageId: "stage_id",
+ status: "LOST"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.crm.opportunities.list({
+ accountId: "account_id",
+ createdAfter: new Date("2024-01-15T09:30:00.000Z"),
+ createdBefore: new Date("2024-01-15T09:30:00.000Z"),
+ cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ includeDeletedData: true,
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
+ ownerId: "owner_id",
+ pageSize: 1,
+ remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"),
+ remoteFields: "status",
+ remoteId: "remote_id",
+ showEnumOrigins: "status",
+ stageId: "stage_id",
+ status: "LOST"
});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
```
@@ -21384,7 +23766,7 @@ await client.ticketing.fieldMapping.fieldMappingsRetrieve({
-
-**request:** `Merge.ticketing.FieldMappingsRetrieveRequest`
+**request:** `Merge.crm.OpportunitiesListRequest`
@@ -21392,7 +23774,7 @@ await client.ticketing.fieldMapping.fieldMappingsRetrieve({
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `OpportunitiesClient.RequestOptions`
@@ -21404,7 +23786,7 @@ await client.ticketing.fieldMapping.fieldMappingsRetrieve({
client.ticketing.fieldMapping.fieldMappingsCreate({ ...params }) -> Merge.FieldMappingInstanceResponse
+client.crm.opportunities.create({ ...params }) -> Merge.OpportunityResponse
-
@@ -21416,7 +23798,7 @@ await client.ticketing.fieldMapping.fieldMappingsRetrieve({
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Creates an `Opportunity` object with the given values.
@@ -21431,14 +23813,10 @@ Create new Field Mappings that will be available after the next scheduled sync.
-
```typescript
-await client.ticketing.fieldMapping.fieldMappingsCreate({
- excludeRemoteFieldMetadata: true,
- targetFieldName: "example_target_field_name",
- targetFieldDescription: "this is a example description of the target field",
- remoteFieldTraversalPath: ["example_remote_field"],
- remoteMethod: "GET",
- remoteUrlPath: "/example-url-path",
- commonModelName: "ExampleCommonModel"
+await client.crm.opportunities.create({
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
});
```
@@ -21455,7 +23833,7 @@ await client.ticketing.fieldMapping.fieldMappingsCreate({
-
-**request:** `Merge.ticketing.CreateFieldMappingRequest`
+**request:** `Merge.crm.OpportunityEndpointRequest`
@@ -21463,7 +23841,7 @@ await client.ticketing.fieldMapping.fieldMappingsCreate({
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `OpportunitiesClient.RequestOptions`
@@ -21475,7 +23853,7 @@ await client.ticketing.fieldMapping.fieldMappingsCreate({
client.ticketing.fieldMapping.fieldMappingsDestroy(field_mapping_id) -> Merge.FieldMappingInstanceResponse
+client.crm.opportunities.retrieve(id, { ...params }) -> Merge.Opportunity
-
@@ -21487,7 +23865,7 @@ await client.ticketing.fieldMapping.fieldMappingsCreate({
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns an `Opportunity` object with the given `id`.
@@ -21502,7 +23880,13 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
-
```typescript
-await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id");
+await client.crm.opportunities.retrieve("id", {
+ includeRemoteData: true,
+ includeRemoteFields: true,
+ includeShellData: true,
+ remoteFields: "status",
+ showEnumOrigins: "status"
+});
```
@@ -21518,7 +23902,7 @@ await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**field_mapping_id:** `string`
+**id:** `string`
@@ -21526,7 +23910,15 @@ await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**request:** `Merge.crm.OpportunitiesRetrieveRequest`
+
+
+
+
+
+-
+
+**requestOptions:** `OpportunitiesClient.RequestOptions`
@@ -21538,7 +23930,7 @@ await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id");
client.ticketing.fieldMapping.fieldMappingsPartialUpdate(field_mapping_id, { ...params }) -> Merge.FieldMappingInstanceResponse
+client.crm.opportunities.partialUpdate(id, { ...params }) -> Merge.OpportunityResponse
-
@@ -21550,7 +23942,7 @@ await client.ticketing.fieldMapping.fieldMappingsDestroy("field_mapping_id");
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Updates an `Opportunity` object with the given `id`.
@@ -21565,7 +23957,11 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
-
```typescript
-await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id");
+await client.crm.opportunities.partialUpdate("id", {
+ isDebugMode: true,
+ runAsync: true,
+ model: {}
+});
```
@@ -21581,7 +23977,7 @@ await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id
-
-**field_mapping_id:** `string`
+**id:** `string`
@@ -21589,7 +23985,7 @@ await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id
-
-**request:** `Merge.ticketing.PatchedEditFieldMappingRequest`
+**request:** `Merge.crm.PatchedOpportunityEndpointRequest`
@@ -21597,7 +23993,7 @@ await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id
-
-**requestOptions:** `FieldMappingClient.RequestOptions`
+**requestOptions:** `OpportunitiesClient.RequestOptions`
@@ -21609,7 +24005,7 @@ await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id
client.ticketing.fieldMapping.remoteFieldsRetrieve({ ...params }) -> Merge.RemoteFieldApiResponse
+client.crm.opportunities.metaPatchRetrieve(id) -> Merge.MetaResponse
-
@@ -21621,7 +24017,7 @@ await client.ticketing.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id