@wix/auto_sdk_crm_tasks 1.0.7 → 1.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.context.d.ts +32 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.context.js +40 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.context.js.map +1 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.http.d.ts +47 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.http.js +264 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.http.js.map +1 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.meta.d.ts +27 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.meta.js +161 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.meta.js.map +1 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.public.d.ts +94 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.public.js +102 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.public.js.map +1 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.types.d.ts +528 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.types.js +41 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.types.js.map +1 -0
- package/build/{crm-tasks-v2-task-tasks.universal-DHOV27KP.d.mts → cjs/src/crm-tasks-v2-task-tasks.universal.d.ts} +238 -67
- package/build/cjs/src/crm-tasks-v2-task-tasks.universal.js +363 -0
- package/build/cjs/src/crm-tasks-v2-task-tasks.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/crm-tasks-v2-task-tasks.context.d.ts +32 -0
- package/build/es/src/crm-tasks-v2-task-tasks.context.js +32 -0
- package/build/es/src/crm-tasks-v2-task-tasks.context.js.map +1 -0
- package/build/es/src/crm-tasks-v2-task-tasks.http.d.ts +47 -0
- package/build/es/src/crm-tasks-v2-task-tasks.http.js +254 -0
- package/build/es/src/crm-tasks-v2-task-tasks.http.js.map +1 -0
- package/build/es/src/crm-tasks-v2-task-tasks.meta.d.ts +27 -0
- package/build/es/src/crm-tasks-v2-task-tasks.meta.js +128 -0
- package/build/es/src/crm-tasks-v2-task-tasks.meta.js.map +1 -0
- package/build/es/src/crm-tasks-v2-task-tasks.public.d.ts +94 -0
- package/build/es/src/crm-tasks-v2-task-tasks.public.js +87 -0
- package/build/es/src/crm-tasks-v2-task-tasks.public.js.map +1 -0
- package/build/es/src/crm-tasks-v2-task-tasks.types.d.ts +528 -0
- package/build/es/src/crm-tasks-v2-task-tasks.types.js +38 -0
- package/build/es/src/crm-tasks-v2-task-tasks.types.js.map +1 -0
- package/build/{crm-tasks-v2-task-tasks.universal-DHOV27KP.d.ts → es/src/crm-tasks-v2-task-tasks.universal.d.ts} +238 -67
- package/build/es/src/crm-tasks-v2-task-tasks.universal.js +330 -0
- package/build/es/src/crm-tasks-v2-task-tasks.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.context.d.ts +32 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.context.js +40 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.context.js.map +1 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.http.d.ts +47 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.http.js +264 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.http.js.map +1 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.meta.d.ts +27 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.meta.js +161 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.meta.js.map +1 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.public.d.ts +94 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.public.js +102 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.public.js.map +1 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.types.d.ts +528 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.types.js +41 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.types.js.map +1 -0
- package/build/internal/{crm-tasks-v2-task-tasks.universal-DHOV27KP.d.mts → cjs/src/crm-tasks-v2-task-tasks.universal.d.ts} +238 -67
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.universal.js +363 -0
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.context.d.ts +32 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.context.js +32 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.context.js.map +1 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.http.d.ts +47 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.http.js +254 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.http.js.map +1 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.meta.d.ts +27 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.meta.js +128 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.meta.js.map +1 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.public.d.ts +94 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.public.js +87 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.public.js.map +1 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.types.d.ts +528 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.types.js +38 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.types.js.map +1 -0
- package/build/internal/{crm-tasks-v2-task-tasks.universal-DHOV27KP.d.ts → es/src/crm-tasks-v2-task-tasks.universal.d.ts} +238 -67
- package/build/internal/es/src/crm-tasks-v2-task-tasks.universal.js +330 -0
- package/build/internal/es/src/crm-tasks-v2-task-tasks.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -115
- package/build/index.d.ts +0 -115
- package/build/index.js +0 -640
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -601
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -115
- package/build/internal/index.d.ts +0 -115
- package/build/internal/index.js +0 -640
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -601
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -290
- package/build/internal/meta.d.ts +0 -290
- package/build/internal/meta.js +0 -386
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -353
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -290
- package/build/meta.d.ts +0 -290
- package/build/meta.js +0 -386
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -353
- package/build/meta.mjs.map +0 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
export interface Task {
|
|
2
3
|
/**
|
|
3
4
|
* Task ID.
|
|
4
5
|
* @format GUID
|
|
@@ -46,13 +47,13 @@ interface Task {
|
|
|
46
47
|
contact?: ContactInfo;
|
|
47
48
|
}
|
|
48
49
|
/** Possible statuses in which the task may be. */
|
|
49
|
-
declare enum TaskStatus {
|
|
50
|
+
export declare enum TaskStatus {
|
|
50
51
|
/** Action needed. */
|
|
51
52
|
ACTION_NEEDED = "ACTION_NEEDED",
|
|
52
53
|
/** Task completed. */
|
|
53
54
|
COMPLETED = "COMPLETED"
|
|
54
55
|
}
|
|
55
|
-
interface TaskSource {
|
|
56
|
+
export interface TaskSource {
|
|
56
57
|
/**
|
|
57
58
|
* How the task was created.
|
|
58
59
|
* @readonly
|
|
@@ -72,13 +73,13 @@ interface TaskSource {
|
|
|
72
73
|
userId?: string | null;
|
|
73
74
|
}
|
|
74
75
|
/** Possible sources that can create tasks. */
|
|
75
|
-
declare enum SourceType {
|
|
76
|
+
export declare enum SourceType {
|
|
76
77
|
/** Task was created by an app. */
|
|
77
78
|
APP = "APP",
|
|
78
79
|
/** Task was created by a Wix user. */
|
|
79
80
|
USER = "USER"
|
|
80
81
|
}
|
|
81
|
-
interface ContactInfo {
|
|
82
|
+
export interface ContactInfo {
|
|
82
83
|
/**
|
|
83
84
|
* ID of the contact associated with the task.
|
|
84
85
|
* @format GUID
|
|
@@ -110,7 +111,7 @@ interface ContactInfo {
|
|
|
110
111
|
*/
|
|
111
112
|
phone?: string | null;
|
|
112
113
|
}
|
|
113
|
-
interface RepositionTask {
|
|
114
|
+
export interface RepositionTask {
|
|
114
115
|
/**
|
|
115
116
|
* The id of the last task that was re-positioned
|
|
116
117
|
* @format GUID
|
|
@@ -119,11 +120,11 @@ interface RepositionTask {
|
|
|
119
120
|
/** The position of the last task that was re-positioned */
|
|
120
121
|
position?: string | null;
|
|
121
122
|
}
|
|
122
|
-
interface TaskOverdue {
|
|
123
|
+
export interface TaskOverdue {
|
|
123
124
|
/** The overdue task. */
|
|
124
125
|
task?: Task;
|
|
125
126
|
}
|
|
126
|
-
interface TaskAssigned {
|
|
127
|
+
export interface TaskAssigned {
|
|
127
128
|
/**
|
|
128
129
|
* The id of the assignee
|
|
129
130
|
* @format GUID
|
|
@@ -132,51 +133,51 @@ interface TaskAssigned {
|
|
|
132
133
|
/** The task that was assigned */
|
|
133
134
|
task?: Task;
|
|
134
135
|
}
|
|
135
|
-
interface CreateTaskRequest {
|
|
136
|
+
export interface CreateTaskRequest {
|
|
136
137
|
/** Task to create. */
|
|
137
138
|
task: Task;
|
|
138
139
|
}
|
|
139
|
-
interface CreateTaskResponse {
|
|
140
|
+
export interface CreateTaskResponse {
|
|
140
141
|
/** The created task. */
|
|
141
142
|
task?: Task;
|
|
142
143
|
}
|
|
143
|
-
interface ContactNotFoundError {
|
|
144
|
+
export interface ContactNotFoundError {
|
|
144
145
|
/** @format GUID */
|
|
145
146
|
contactId?: string;
|
|
146
147
|
}
|
|
147
|
-
interface GetTaskRequest {
|
|
148
|
+
export interface GetTaskRequest {
|
|
148
149
|
/**
|
|
149
150
|
* ID of the task to retrieve.
|
|
150
151
|
* @format GUID
|
|
151
152
|
*/
|
|
152
153
|
taskId: string;
|
|
153
154
|
}
|
|
154
|
-
interface GetTaskResponse {
|
|
155
|
+
export interface GetTaskResponse {
|
|
155
156
|
/** The retrieved task. */
|
|
156
157
|
task?: Task;
|
|
157
158
|
}
|
|
158
|
-
interface UpdateTaskRequest {
|
|
159
|
+
export interface UpdateTaskRequest {
|
|
159
160
|
/** Task to update. */
|
|
160
161
|
task: Task;
|
|
161
162
|
}
|
|
162
|
-
interface UpdateTaskResponse {
|
|
163
|
+
export interface UpdateTaskResponse {
|
|
163
164
|
/** The updated task. */
|
|
164
165
|
task?: Task;
|
|
165
166
|
}
|
|
166
|
-
interface DeleteTaskRequest {
|
|
167
|
+
export interface DeleteTaskRequest {
|
|
167
168
|
/**
|
|
168
169
|
* ID of the task to delete.
|
|
169
170
|
* @format GUID
|
|
170
171
|
*/
|
|
171
172
|
taskId: string;
|
|
172
173
|
}
|
|
173
|
-
interface DeleteTaskResponse {
|
|
174
|
+
export interface DeleteTaskResponse {
|
|
174
175
|
}
|
|
175
|
-
interface QueryTasksRequest {
|
|
176
|
+
export interface QueryTasksRequest {
|
|
176
177
|
/** Query options. */
|
|
177
178
|
query?: CursorQuery;
|
|
178
179
|
}
|
|
179
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
180
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
180
181
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
181
182
|
cursorPaging?: CursorPaging;
|
|
182
183
|
/**
|
|
@@ -195,23 +196,23 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
195
196
|
sort?: Sorting[];
|
|
196
197
|
}
|
|
197
198
|
/** @oneof */
|
|
198
|
-
interface CursorQueryPagingMethodOneOf {
|
|
199
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
199
200
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
200
201
|
cursorPaging?: CursorPaging;
|
|
201
202
|
}
|
|
202
|
-
interface Sorting {
|
|
203
|
+
export interface Sorting {
|
|
203
204
|
/** Name of the field to sort by. */
|
|
204
205
|
fieldName?: string;
|
|
205
206
|
/** Sort order. */
|
|
206
207
|
order?: SortOrder;
|
|
207
208
|
}
|
|
208
|
-
declare enum SortOrder {
|
|
209
|
+
export declare enum SortOrder {
|
|
209
210
|
/** Sort by ascending order. */
|
|
210
211
|
ASC = "ASC",
|
|
211
212
|
/** Sort by descending order. */
|
|
212
213
|
DESC = "DESC"
|
|
213
214
|
}
|
|
214
|
-
interface CursorPaging {
|
|
215
|
+
export interface CursorPaging {
|
|
215
216
|
/**
|
|
216
217
|
* Number of items to load.
|
|
217
218
|
* @max 1000
|
|
@@ -226,13 +227,13 @@ interface CursorPaging {
|
|
|
226
227
|
*/
|
|
227
228
|
cursor?: string | null;
|
|
228
229
|
}
|
|
229
|
-
interface QueryTasksResponse {
|
|
230
|
+
export interface QueryTasksResponse {
|
|
230
231
|
/** The retrieved tasks. */
|
|
231
232
|
tasks?: Task[];
|
|
232
233
|
/** Paging metadata. */
|
|
233
234
|
pagingMetadata?: CursorPagingMetadata;
|
|
234
235
|
}
|
|
235
|
-
interface CursorPagingMetadata {
|
|
236
|
+
export interface CursorPagingMetadata {
|
|
236
237
|
/** Number of items returned in the response. */
|
|
237
238
|
count?: number | null;
|
|
238
239
|
/** Offset that was requested. */
|
|
@@ -244,13 +245,13 @@ interface CursorPagingMetadata {
|
|
|
244
245
|
*/
|
|
245
246
|
hasNext?: boolean | null;
|
|
246
247
|
}
|
|
247
|
-
interface Cursors {
|
|
248
|
+
export interface Cursors {
|
|
248
249
|
/** Cursor pointing to next page in the list of results. */
|
|
249
250
|
next?: string | null;
|
|
250
251
|
/** Cursor pointing to previous page in the list of results. */
|
|
251
252
|
prev?: string | null;
|
|
252
253
|
}
|
|
253
|
-
interface CountTasksRequest {
|
|
254
|
+
export interface CountTasksRequest {
|
|
254
255
|
/**
|
|
255
256
|
* Filter which tasks to count. See supported filters ([REST](https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/filter-and-sort)| [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/tasks/query-tasks)).
|
|
256
257
|
*
|
|
@@ -265,15 +266,15 @@ interface CountTasksRequest {
|
|
|
265
266
|
*/
|
|
266
267
|
filter?: Record<string, any> | null;
|
|
267
268
|
}
|
|
268
|
-
interface CountTasksResponse {
|
|
269
|
+
export interface CountTasksResponse {
|
|
269
270
|
/** The number of tasks that match the specified filter. */
|
|
270
271
|
count?: number;
|
|
271
272
|
}
|
|
272
|
-
interface QueryTasksInternalRequest {
|
|
273
|
+
export interface QueryTasksInternalRequest {
|
|
273
274
|
/** WQL expression */
|
|
274
275
|
query?: QueryV2;
|
|
275
276
|
}
|
|
276
|
-
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
277
|
+
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
277
278
|
/** Paging options to limit and skip the number of items. */
|
|
278
279
|
paging?: Paging;
|
|
279
280
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
@@ -298,13 +299,13 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
298
299
|
fieldsets?: string[];
|
|
299
300
|
}
|
|
300
301
|
/** @oneof */
|
|
301
|
-
interface QueryV2PagingMethodOneOf {
|
|
302
|
+
export interface QueryV2PagingMethodOneOf {
|
|
302
303
|
/** Paging options to limit and skip the number of items. */
|
|
303
304
|
paging?: Paging;
|
|
304
305
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
305
306
|
cursorPaging?: CursorPaging;
|
|
306
307
|
}
|
|
307
|
-
interface Paging {
|
|
308
|
+
export interface Paging {
|
|
308
309
|
/**
|
|
309
310
|
* Number of items to load.
|
|
310
311
|
* @max 1000
|
|
@@ -313,13 +314,13 @@ interface Paging {
|
|
|
313
314
|
/** Number of items to skip in the current sort order. */
|
|
314
315
|
offset?: number | null;
|
|
315
316
|
}
|
|
316
|
-
interface QueryTasksInternalResponse {
|
|
317
|
+
export interface QueryTasksInternalResponse {
|
|
317
318
|
/** The retrieved tasks. */
|
|
318
319
|
tasks?: Task[];
|
|
319
320
|
/** Details on the paged set of results returned. */
|
|
320
321
|
pagingMetadata?: PagingMetadataV2;
|
|
321
322
|
}
|
|
322
|
-
interface PagingMetadataV2 {
|
|
323
|
+
export interface PagingMetadataV2 {
|
|
323
324
|
/** Number of items returned in the response. */
|
|
324
325
|
count?: number | null;
|
|
325
326
|
/** Offset that was requested. */
|
|
@@ -331,7 +332,7 @@ interface PagingMetadataV2 {
|
|
|
331
332
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
332
333
|
cursors?: Cursors;
|
|
333
334
|
}
|
|
334
|
-
interface MoveTaskAfterRequest {
|
|
335
|
+
export interface MoveTaskAfterRequest {
|
|
335
336
|
/**
|
|
336
337
|
* ID of the task to move.
|
|
337
338
|
* @format GUID
|
|
@@ -344,18 +345,18 @@ interface MoveTaskAfterRequest {
|
|
|
344
345
|
*/
|
|
345
346
|
beforeTaskId?: string | null;
|
|
346
347
|
}
|
|
347
|
-
interface MoveTaskAfterResponse {
|
|
348
|
+
export interface MoveTaskAfterResponse {
|
|
348
349
|
}
|
|
349
|
-
interface TaskNotFoundError {
|
|
350
|
+
export interface TaskNotFoundError {
|
|
350
351
|
/**
|
|
351
352
|
* The task id that was not found
|
|
352
353
|
* @format GUID
|
|
353
354
|
*/
|
|
354
355
|
taskId?: string;
|
|
355
356
|
}
|
|
356
|
-
interface Empty {
|
|
357
|
+
export interface Empty {
|
|
357
358
|
}
|
|
358
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
359
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
359
360
|
createdEvent?: EntityCreatedEvent;
|
|
360
361
|
updatedEvent?: EntityUpdatedEvent;
|
|
361
362
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -398,19 +399,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
398
399
|
entityEventSequence?: string | null;
|
|
399
400
|
}
|
|
400
401
|
/** @oneof */
|
|
401
|
-
interface DomainEventBodyOneOf {
|
|
402
|
+
export interface DomainEventBodyOneOf {
|
|
402
403
|
createdEvent?: EntityCreatedEvent;
|
|
403
404
|
updatedEvent?: EntityUpdatedEvent;
|
|
404
405
|
deletedEvent?: EntityDeletedEvent;
|
|
405
406
|
actionEvent?: ActionEvent;
|
|
406
407
|
}
|
|
407
|
-
interface EntityCreatedEvent {
|
|
408
|
+
export interface EntityCreatedEvent {
|
|
408
409
|
entity?: string;
|
|
409
410
|
}
|
|
410
|
-
interface RestoreInfo {
|
|
411
|
+
export interface RestoreInfo {
|
|
411
412
|
deletedDate?: Date | null;
|
|
412
413
|
}
|
|
413
|
-
interface EntityUpdatedEvent {
|
|
414
|
+
export interface EntityUpdatedEvent {
|
|
414
415
|
/**
|
|
415
416
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
416
417
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -418,14 +419,14 @@ interface EntityUpdatedEvent {
|
|
|
418
419
|
*/
|
|
419
420
|
currentEntity?: string;
|
|
420
421
|
}
|
|
421
|
-
interface EntityDeletedEvent {
|
|
422
|
+
export interface EntityDeletedEvent {
|
|
422
423
|
/** Entity that was deleted */
|
|
423
424
|
deletedEntity?: string | null;
|
|
424
425
|
}
|
|
425
|
-
interface ActionEvent {
|
|
426
|
+
export interface ActionEvent {
|
|
426
427
|
body?: string;
|
|
427
428
|
}
|
|
428
|
-
interface MessageEnvelope {
|
|
429
|
+
export interface MessageEnvelope {
|
|
429
430
|
/**
|
|
430
431
|
* App instance ID.
|
|
431
432
|
* @format GUID
|
|
@@ -441,7 +442,7 @@ interface MessageEnvelope {
|
|
|
441
442
|
/** Stringify payload. */
|
|
442
443
|
data?: string;
|
|
443
444
|
}
|
|
444
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
445
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
445
446
|
/**
|
|
446
447
|
* ID of a site visitor that has not logged in to the site.
|
|
447
448
|
* @format GUID
|
|
@@ -466,7 +467,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
466
467
|
identityType?: WebhookIdentityType;
|
|
467
468
|
}
|
|
468
469
|
/** @oneof */
|
|
469
|
-
interface IdentificationDataIdOneOf {
|
|
470
|
+
export interface IdentificationDataIdOneOf {
|
|
470
471
|
/**
|
|
471
472
|
* ID of a site visitor that has not logged in to the site.
|
|
472
473
|
* @format GUID
|
|
@@ -488,14 +489,14 @@ interface IdentificationDataIdOneOf {
|
|
|
488
489
|
*/
|
|
489
490
|
appId?: string;
|
|
490
491
|
}
|
|
491
|
-
declare enum WebhookIdentityType {
|
|
492
|
+
export declare enum WebhookIdentityType {
|
|
492
493
|
UNKNOWN = "UNKNOWN",
|
|
493
494
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
494
495
|
MEMBER = "MEMBER",
|
|
495
496
|
WIX_USER = "WIX_USER",
|
|
496
497
|
APP = "APP"
|
|
497
498
|
}
|
|
498
|
-
interface DeleteCompletedTasksRequest {
|
|
499
|
+
export interface DeleteCompletedTasksRequest {
|
|
499
500
|
/**
|
|
500
501
|
* Optional list of tasks ids of the tasks to delete. If the list is not provided the filter is used.
|
|
501
502
|
* @format GUID
|
|
@@ -505,9 +506,9 @@ interface DeleteCompletedTasksRequest {
|
|
|
505
506
|
/** An optional filter of tasks to count. See 'queryTasks' for supported filter options. */
|
|
506
507
|
filter?: Record<string, any> | null;
|
|
507
508
|
}
|
|
508
|
-
interface DeleteCompletedTasksResponse {
|
|
509
|
+
export interface DeleteCompletedTasksResponse {
|
|
509
510
|
}
|
|
510
|
-
interface SendTasksReminderRequest {
|
|
511
|
+
export interface SendTasksReminderRequest {
|
|
511
512
|
/**
|
|
512
513
|
* Ids of the tasks to remind
|
|
513
514
|
* @format GUID
|
|
@@ -517,14 +518,14 @@ interface SendTasksReminderRequest {
|
|
|
517
518
|
/** The reminder type */
|
|
518
519
|
reminderType?: ReminderType;
|
|
519
520
|
}
|
|
520
|
-
declare enum ReminderType {
|
|
521
|
+
export declare enum ReminderType {
|
|
521
522
|
UNKNOWN_REMINDER_TYPE = "UNKNOWN_REMINDER_TYPE",
|
|
522
523
|
FIRST_REMINDER = "FIRST_REMINDER",
|
|
523
524
|
LAST_REMINDER = "LAST_REMINDER"
|
|
524
525
|
}
|
|
525
|
-
interface SendTasksReminderResponse {
|
|
526
|
+
export interface SendTasksReminderResponse {
|
|
526
527
|
}
|
|
527
|
-
interface BaseEventMetadata {
|
|
528
|
+
export interface BaseEventMetadata {
|
|
528
529
|
/**
|
|
529
530
|
* App instance ID.
|
|
530
531
|
* @format GUID
|
|
@@ -538,7 +539,7 @@ interface BaseEventMetadata {
|
|
|
538
539
|
/** The identification type and identity data. */
|
|
539
540
|
identity?: IdentificationData;
|
|
540
541
|
}
|
|
541
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
542
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
542
543
|
/**
|
|
543
544
|
* Unique event ID.
|
|
544
545
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -576,22 +577,124 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
576
577
|
*/
|
|
577
578
|
entityEventSequence?: string | null;
|
|
578
579
|
}
|
|
579
|
-
interface TaskCreatedEnvelope {
|
|
580
|
+
export interface TaskCreatedEnvelope {
|
|
580
581
|
entity: Task;
|
|
581
582
|
metadata: EventMetadata;
|
|
582
583
|
}
|
|
583
|
-
|
|
584
|
+
/**
|
|
585
|
+
* Triggered when a task is created.
|
|
586
|
+
* @permissionScope Read Tasks
|
|
587
|
+
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
588
|
+
* @permissionScope Manage Tasks
|
|
589
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
590
|
+
* @permissionId CRM_TASKS.TASK_READ
|
|
591
|
+
* @webhook
|
|
592
|
+
* @eventType wix.crm.tasks.v2.task_created
|
|
593
|
+
* @serviceIdentifier wix.crm.tasks.v2.Tasks
|
|
594
|
+
* @slug created
|
|
595
|
+
*/
|
|
596
|
+
export declare function onTaskCreated(handler: (event: TaskCreatedEnvelope) => void | Promise<void>): void;
|
|
597
|
+
export interface TaskDeletedEnvelope {
|
|
584
598
|
metadata: EventMetadata;
|
|
585
599
|
}
|
|
586
|
-
|
|
600
|
+
/**
|
|
601
|
+
* Triggered when a task is deleted.
|
|
602
|
+
* @permissionScope Read Tasks
|
|
603
|
+
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
604
|
+
* @permissionScope Manage Tasks
|
|
605
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
606
|
+
* @permissionId CRM_TASKS.TASK_READ
|
|
607
|
+
* @webhook
|
|
608
|
+
* @eventType wix.crm.tasks.v2.task_deleted
|
|
609
|
+
* @serviceIdentifier wix.crm.tasks.v2.Tasks
|
|
610
|
+
* @slug deleted
|
|
611
|
+
*/
|
|
612
|
+
export declare function onTaskDeleted(handler: (event: TaskDeletedEnvelope) => void | Promise<void>): void;
|
|
613
|
+
export interface TaskOverdueEnvelope {
|
|
587
614
|
data: TaskOverdue;
|
|
588
615
|
metadata: EventMetadata;
|
|
589
616
|
}
|
|
590
|
-
|
|
617
|
+
/**
|
|
618
|
+
* Triggered when a task reaches its due date.
|
|
619
|
+
* @permissionScope Read Tasks
|
|
620
|
+
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
621
|
+
* @permissionScope Manage Tasks
|
|
622
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
623
|
+
* @permissionId CRM_TASKS.TASK_READ
|
|
624
|
+
* @webhook
|
|
625
|
+
* @eventType wix.crm.tasks.v2.task_task_overdue
|
|
626
|
+
* @serviceIdentifier wix.crm.tasks.v2.Tasks
|
|
627
|
+
* @slug task_overdue
|
|
628
|
+
*/
|
|
629
|
+
export declare function onTaskOverdue(handler: (event: TaskOverdueEnvelope) => void | Promise<void>): void;
|
|
630
|
+
export interface TaskUpdatedEnvelope {
|
|
591
631
|
entity: Task;
|
|
592
632
|
metadata: EventMetadata;
|
|
593
633
|
}
|
|
594
|
-
|
|
634
|
+
/**
|
|
635
|
+
* Triggered when a task is updated.
|
|
636
|
+
* @permissionScope Read Tasks
|
|
637
|
+
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
638
|
+
* @permissionScope Manage Tasks
|
|
639
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
640
|
+
* @permissionId CRM_TASKS.TASK_READ
|
|
641
|
+
* @webhook
|
|
642
|
+
* @eventType wix.crm.tasks.v2.task_updated
|
|
643
|
+
* @serviceIdentifier wix.crm.tasks.v2.Tasks
|
|
644
|
+
* @slug updated
|
|
645
|
+
*/
|
|
646
|
+
export declare function onTaskUpdated(handler: (event: TaskUpdatedEnvelope) => void | Promise<void>): void;
|
|
647
|
+
type TaskNonNullablePaths = `status` | `source.sourceType`;
|
|
648
|
+
/**
|
|
649
|
+
* Creates a new task.
|
|
650
|
+
* @param task - Task to create.
|
|
651
|
+
* @public
|
|
652
|
+
* @requiredField task
|
|
653
|
+
* @permissionId CRM_TASKS.TASK_CREATE
|
|
654
|
+
* @permissionScope Manage Tasks
|
|
655
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
656
|
+
* @applicableIdentity APP
|
|
657
|
+
* @returns The created task.
|
|
658
|
+
* @fqn wix.crm.tasks.v2.Tasks.CreateTask
|
|
659
|
+
*/
|
|
660
|
+
export declare function createTask(task: Task): Promise<NonNullablePaths<Task, TaskNonNullablePaths>>;
|
|
661
|
+
/**
|
|
662
|
+
* Retrieves a task by ID.
|
|
663
|
+
* @param taskId - ID of the task to retrieve.
|
|
664
|
+
* @public
|
|
665
|
+
* @requiredField taskId
|
|
666
|
+
* @permissionId CRM_TASKS.TASK_READ
|
|
667
|
+
* @permissionScope Read Tasks
|
|
668
|
+
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
669
|
+
* @permissionScope Manage Tasks
|
|
670
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
671
|
+
* @applicableIdentity APP
|
|
672
|
+
* @returns The retrieved task.
|
|
673
|
+
* @fqn wix.crm.tasks.v2.Tasks.GetTask
|
|
674
|
+
*/
|
|
675
|
+
export declare function getTask(taskId: string): Promise<NonNullablePaths<Task, TaskNonNullablePaths>>;
|
|
676
|
+
/**
|
|
677
|
+
* Updates a task.
|
|
678
|
+
*
|
|
679
|
+
* Each time the task is updated, `revision` increments by 1.
|
|
680
|
+
* The existing `revision` must be included when updating the task.
|
|
681
|
+
* This ensures you're working with the latest task
|
|
682
|
+
* and prevents unintended overwrites.
|
|
683
|
+
* @param _id - Task ID.
|
|
684
|
+
* @public
|
|
685
|
+
* @requiredField _id
|
|
686
|
+
* @requiredField task
|
|
687
|
+
* @requiredField task.revision
|
|
688
|
+
* @param task - Task to update.
|
|
689
|
+
* @permissionId CRM_TASKS.TASK_UPDATE
|
|
690
|
+
* @permissionScope Manage Tasks
|
|
691
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
692
|
+
* @applicableIdentity APP
|
|
693
|
+
* @returns The updated task.
|
|
694
|
+
* @fqn wix.crm.tasks.v2.Tasks.UpdateTask
|
|
695
|
+
*/
|
|
696
|
+
export declare function updateTask(_id: string, task: NonNullablePaths<UpdateTask, `revision`>): Promise<NonNullablePaths<Task, TaskNonNullablePaths>>;
|
|
697
|
+
export interface UpdateTask {
|
|
595
698
|
/**
|
|
596
699
|
* Task ID.
|
|
597
700
|
* @format GUID
|
|
@@ -638,6 +741,42 @@ interface UpdateTask {
|
|
|
638
741
|
/** Information about the contact associated with the task. */
|
|
639
742
|
contact?: ContactInfo;
|
|
640
743
|
}
|
|
744
|
+
/**
|
|
745
|
+
* Deletes a task by ID.
|
|
746
|
+
* @param taskId - ID of the task to delete.
|
|
747
|
+
* @public
|
|
748
|
+
* @requiredField taskId
|
|
749
|
+
* @permissionId CRM_TASKS.TASK_DELETE
|
|
750
|
+
* @permissionScope Manage Tasks
|
|
751
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
752
|
+
* @applicableIdentity APP
|
|
753
|
+
* @fqn wix.crm.tasks.v2.Tasks.DeleteTask
|
|
754
|
+
*/
|
|
755
|
+
export declare function deleteTask(taskId: string): Promise<void>;
|
|
756
|
+
/**
|
|
757
|
+
* Creates a query to retrieve a list of tasks.
|
|
758
|
+
*
|
|
759
|
+
* The `queryTasks()` method builds a query to retrieve a list of tasks and returns a `TasksQueryBuilder` object.
|
|
760
|
+
*
|
|
761
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` method. You can refine the query by chaining `TasksQueryBuilder` methods onto the query. `TasksQueryBuilder` methods enable you to sort, filter, and control the results that `queryTasks()` returns.
|
|
762
|
+
*
|
|
763
|
+
* `queryTasks()` runs with these `TasksQueryBuilder` defaults, which you can override:
|
|
764
|
+
* - `limit(50)`
|
|
765
|
+
* - `descending('_createdDate')`
|
|
766
|
+
*
|
|
767
|
+
* The methods that are chained to `queryTasks()` are applied in the order they are called. For example, if you apply `ascending('_createdDate')` and then `descending('_updatedDate')`, the results are sorted first by the created date and then, if there are multiple results with the same date, the items are sorted by the updated date.
|
|
768
|
+
*
|
|
769
|
+
* The following `TasksQueryBuilder` methods are supported for `queryTasks()`. For a full description of the `task` object, see the object returned for the `items` property in `TasksQueryResult`.
|
|
770
|
+
* @public
|
|
771
|
+
* @permissionScope Read Tasks
|
|
772
|
+
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
773
|
+
* @permissionScope Manage Tasks
|
|
774
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
775
|
+
* @permissionId CRM_TASKS.TASK_READ
|
|
776
|
+
* @applicableIdentity APP
|
|
777
|
+
* @fqn wix.crm.tasks.v2.Tasks.QueryTasks
|
|
778
|
+
*/
|
|
779
|
+
export declare function queryTasks(): TasksQueryBuilder;
|
|
641
780
|
interface QueryCursorResult {
|
|
642
781
|
cursors: Cursors;
|
|
643
782
|
hasNext: () => boolean;
|
|
@@ -645,13 +784,13 @@ interface QueryCursorResult {
|
|
|
645
784
|
length: number;
|
|
646
785
|
pageSize: number;
|
|
647
786
|
}
|
|
648
|
-
interface TasksQueryResult extends QueryCursorResult {
|
|
787
|
+
export interface TasksQueryResult extends QueryCursorResult {
|
|
649
788
|
items: Task[];
|
|
650
789
|
query: TasksQueryBuilder;
|
|
651
790
|
next: () => Promise<TasksQueryResult>;
|
|
652
791
|
prev: () => Promise<TasksQueryResult>;
|
|
653
792
|
}
|
|
654
|
-
interface TasksQueryBuilder {
|
|
793
|
+
export interface TasksQueryBuilder {
|
|
655
794
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
656
795
|
* @param value - Value to compare against.
|
|
657
796
|
*/
|
|
@@ -688,7 +827,25 @@ interface TasksQueryBuilder {
|
|
|
688
827
|
skipTo: (cursor: string) => TasksQueryBuilder;
|
|
689
828
|
find: () => Promise<TasksQueryResult>;
|
|
690
829
|
}
|
|
691
|
-
|
|
830
|
+
/**
|
|
831
|
+
* Counts the number of tasks.
|
|
832
|
+
*
|
|
833
|
+
*
|
|
834
|
+
* This method returns the count of all tasks regardless of their `status`.
|
|
835
|
+
*
|
|
836
|
+
* Optionally, you can specify a filter to count only tasks that meet certain criteria.
|
|
837
|
+
* @public
|
|
838
|
+
* @param options - Filtering options.
|
|
839
|
+
* @permissionId CRM_TASKS.TASK_READ
|
|
840
|
+
* @permissionScope Read Tasks
|
|
841
|
+
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
842
|
+
* @permissionScope Manage Tasks
|
|
843
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
844
|
+
* @applicableIdentity APP
|
|
845
|
+
* @fqn wix.crm.tasks.v2.Tasks.CountTasks
|
|
846
|
+
*/
|
|
847
|
+
export declare function countTasks(options?: CountTasksOptions): Promise<NonNullablePaths<CountTasksResponse, `count`>>;
|
|
848
|
+
export interface CountTasksOptions {
|
|
692
849
|
/**
|
|
693
850
|
* Filter which tasks to count. See supported filters ([REST](https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/filter-and-sort)| [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/tasks/query-tasks)).
|
|
694
851
|
*
|
|
@@ -703,7 +860,22 @@ interface CountTasksOptions {
|
|
|
703
860
|
*/
|
|
704
861
|
filter?: Record<string, any> | null;
|
|
705
862
|
}
|
|
706
|
-
|
|
863
|
+
/**
|
|
864
|
+
* Moves a task specified by ID to be placed after another task in the task display.
|
|
865
|
+
*
|
|
866
|
+
* You can reposition a task to be first in the display by omitting `beforeTaskId`.
|
|
867
|
+
* @param taskId - ID of the task to move.
|
|
868
|
+
* @public
|
|
869
|
+
* @requiredField taskId
|
|
870
|
+
* @param options - Options for moving the task.
|
|
871
|
+
* @permissionId CRM_TASKS.TASK_UPDATE
|
|
872
|
+
* @permissionScope Manage Tasks
|
|
873
|
+
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
874
|
+
* @applicableIdentity APP
|
|
875
|
+
* @fqn wix.crm.tasks.v2.Tasks.MoveTaskAfter
|
|
876
|
+
*/
|
|
877
|
+
export declare function moveTaskAfter(taskId: string, options?: MoveTaskAfterOptions): Promise<void>;
|
|
878
|
+
export interface MoveTaskAfterOptions {
|
|
707
879
|
/**
|
|
708
880
|
* The ID of the task after which the moved task is positioned in the task display.
|
|
709
881
|
* If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
|
|
@@ -711,5 +883,4 @@ interface MoveTaskAfterOptions {
|
|
|
711
883
|
*/
|
|
712
884
|
beforeTaskId?: string | null;
|
|
713
885
|
}
|
|
714
|
-
|
|
715
|
-
export { type IdentificationDataIdOneOf as $, type QueryV2PagingMethodOneOf as A, type QueryTasksInternalResponse as B, type CountTasksOptions as C, type DeleteTaskRequest as D, type PagingMetadataV2 as E, type MoveTaskAfterRequest as F, type GetTaskRequest as G, type MoveTaskAfterResponse as H, type TaskNotFoundError as I, type Empty as J, type DomainEvent as K, type DomainEventBodyOneOf as L, type MoveTaskAfterOptions as M, type EntityCreatedEvent as N, type RestoreInfo as O, type Paging as P, type QueryTasksRequest as Q, ReminderType as R, SourceType as S, type Task as T, type UpdateTask as U, type EntityUpdatedEvent as V, WebhookIdentityType as W, type EntityDeletedEvent as X, type ActionEvent as Y, type MessageEnvelope as Z, type IdentificationData as _, type TasksQueryBuilder as a, type DeleteCompletedTasksRequest as a0, type DeleteCompletedTasksResponse as a1, type SendTasksReminderRequest as a2, type SendTasksReminderResponse as a3, type BaseEventMetadata as a4, type EventMetadata as a5, type TaskCreatedEnvelope as a6, type TaskDeletedEnvelope as a7, type TaskOverdueEnvelope as a8, type TaskUpdatedEnvelope as a9, type TasksQueryResult as aa, type CountTasksResponse as b, TaskStatus as c, SortOrder as d, type TaskSource as e, type ContactInfo as f, type RepositionTask as g, type TaskOverdue as h, type TaskAssigned as i, type CreateTaskRequest as j, type CreateTaskResponse as k, type ContactNotFoundError as l, type GetTaskResponse as m, type UpdateTaskRequest as n, type UpdateTaskResponse as o, type DeleteTaskResponse as p, type CursorQuery as q, type CursorQueryPagingMethodOneOf as r, type Sorting as s, type CursorPaging as t, type QueryTasksResponse as u, type CursorPagingMetadata as v, type Cursors as w, type CountTasksRequest as x, type QueryTasksInternalRequest as y, type QueryV2 as z };
|
|
886
|
+
export {};
|