@wix/auto_sdk_crm_tasks 1.0.6 → 1.0.7
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/{internal/cjs/src/crm-tasks-v2-task-tasks.universal.d.ts → crm-tasks-v2-task-tasks.universal-DHOV27KP.d.mts} +67 -238
- package/build/{cjs/src/crm-tasks-v2-task-tasks.universal.d.ts → crm-tasks-v2-task-tasks.universal-DHOV27KP.d.ts} +67 -238
- package/build/index.d.mts +115 -0
- package/build/index.d.ts +115 -0
- package/build/index.js +640 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +601 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/crm-tasks-v2-task-tasks.universal.d.ts → internal/crm-tasks-v2-task-tasks.universal-DHOV27KP.d.mts} +67 -238
- package/build/internal/{es/src/crm-tasks-v2-task-tasks.universal.d.ts → crm-tasks-v2-task-tasks.universal-DHOV27KP.d.ts} +67 -238
- package/build/internal/index.d.mts +115 -0
- package/build/internal/index.d.ts +115 -0
- package/build/internal/index.js +640 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +601 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +290 -0
- package/build/internal/meta.d.ts +290 -0
- package/build/internal/meta.js +386 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +353 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +290 -0
- package/build/meta.d.ts +290 -0
- package/build/meta.js +386 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +353 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/crm-tasks-v2-task-tasks.context.d.ts +0 -32
- package/build/cjs/src/crm-tasks-v2-task-tasks.context.js +0 -40
- package/build/cjs/src/crm-tasks-v2-task-tasks.context.js.map +0 -1
- package/build/cjs/src/crm-tasks-v2-task-tasks.http.d.ts +0 -47
- package/build/cjs/src/crm-tasks-v2-task-tasks.http.js +0 -264
- package/build/cjs/src/crm-tasks-v2-task-tasks.http.js.map +0 -1
- package/build/cjs/src/crm-tasks-v2-task-tasks.meta.d.ts +0 -27
- package/build/cjs/src/crm-tasks-v2-task-tasks.meta.js +0 -161
- package/build/cjs/src/crm-tasks-v2-task-tasks.meta.js.map +0 -1
- package/build/cjs/src/crm-tasks-v2-task-tasks.public.d.ts +0 -94
- package/build/cjs/src/crm-tasks-v2-task-tasks.public.js +0 -102
- package/build/cjs/src/crm-tasks-v2-task-tasks.public.js.map +0 -1
- package/build/cjs/src/crm-tasks-v2-task-tasks.types.d.ts +0 -528
- package/build/cjs/src/crm-tasks-v2-task-tasks.types.js +0 -41
- package/build/cjs/src/crm-tasks-v2-task-tasks.types.js.map +0 -1
- package/build/cjs/src/crm-tasks-v2-task-tasks.universal.js +0 -363
- package/build/cjs/src/crm-tasks-v2-task-tasks.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/crm-tasks-v2-task-tasks.context.d.ts +0 -32
- package/build/es/src/crm-tasks-v2-task-tasks.context.js +0 -32
- package/build/es/src/crm-tasks-v2-task-tasks.context.js.map +0 -1
- package/build/es/src/crm-tasks-v2-task-tasks.http.d.ts +0 -47
- package/build/es/src/crm-tasks-v2-task-tasks.http.js +0 -254
- package/build/es/src/crm-tasks-v2-task-tasks.http.js.map +0 -1
- package/build/es/src/crm-tasks-v2-task-tasks.meta.d.ts +0 -27
- package/build/es/src/crm-tasks-v2-task-tasks.meta.js +0 -128
- package/build/es/src/crm-tasks-v2-task-tasks.meta.js.map +0 -1
- package/build/es/src/crm-tasks-v2-task-tasks.public.d.ts +0 -94
- package/build/es/src/crm-tasks-v2-task-tasks.public.js +0 -87
- package/build/es/src/crm-tasks-v2-task-tasks.public.js.map +0 -1
- package/build/es/src/crm-tasks-v2-task-tasks.types.d.ts +0 -528
- package/build/es/src/crm-tasks-v2-task-tasks.types.js +0 -38
- package/build/es/src/crm-tasks-v2-task-tasks.types.js.map +0 -1
- package/build/es/src/crm-tasks-v2-task-tasks.universal.js +0 -330
- package/build/es/src/crm-tasks-v2-task-tasks.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.context.d.ts +0 -32
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.context.js +0 -40
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.context.js.map +0 -1
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.http.d.ts +0 -47
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.http.js +0 -264
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.http.js.map +0 -1
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.meta.d.ts +0 -27
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.meta.js +0 -161
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.meta.js.map +0 -1
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.public.d.ts +0 -94
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.public.js +0 -102
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.public.js.map +0 -1
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.types.d.ts +0 -528
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.types.js +0 -41
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.types.js.map +0 -1
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.universal.js +0 -363
- package/build/internal/cjs/src/crm-tasks-v2-task-tasks.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/crm-tasks-v2-task-tasks.context.d.ts +0 -32
- package/build/internal/es/src/crm-tasks-v2-task-tasks.context.js +0 -32
- package/build/internal/es/src/crm-tasks-v2-task-tasks.context.js.map +0 -1
- package/build/internal/es/src/crm-tasks-v2-task-tasks.http.d.ts +0 -47
- package/build/internal/es/src/crm-tasks-v2-task-tasks.http.js +0 -254
- package/build/internal/es/src/crm-tasks-v2-task-tasks.http.js.map +0 -1
- package/build/internal/es/src/crm-tasks-v2-task-tasks.meta.d.ts +0 -27
- package/build/internal/es/src/crm-tasks-v2-task-tasks.meta.js +0 -128
- package/build/internal/es/src/crm-tasks-v2-task-tasks.meta.js.map +0 -1
- package/build/internal/es/src/crm-tasks-v2-task-tasks.public.d.ts +0 -94
- package/build/internal/es/src/crm-tasks-v2-task-tasks.public.js +0 -87
- package/build/internal/es/src/crm-tasks-v2-task-tasks.public.js.map +0 -1
- package/build/internal/es/src/crm-tasks-v2-task-tasks.types.d.ts +0 -528
- package/build/internal/es/src/crm-tasks-v2-task-tasks.types.js +0 -38
- package/build/internal/es/src/crm-tasks-v2-task-tasks.types.js.map +0 -1
- package/build/internal/es/src/crm-tasks-v2-task-tasks.universal.js +0 -330
- package/build/internal/es/src/crm-tasks-v2-task-tasks.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface Task {
|
|
1
|
+
interface Task {
|
|
3
2
|
/**
|
|
4
3
|
* Task ID.
|
|
5
4
|
* @format GUID
|
|
@@ -47,13 +46,13 @@ export interface Task {
|
|
|
47
46
|
contact?: ContactInfo;
|
|
48
47
|
}
|
|
49
48
|
/** Possible statuses in which the task may be. */
|
|
50
|
-
|
|
49
|
+
declare enum TaskStatus {
|
|
51
50
|
/** Action needed. */
|
|
52
51
|
ACTION_NEEDED = "ACTION_NEEDED",
|
|
53
52
|
/** Task completed. */
|
|
54
53
|
COMPLETED = "COMPLETED"
|
|
55
54
|
}
|
|
56
|
-
|
|
55
|
+
interface TaskSource {
|
|
57
56
|
/**
|
|
58
57
|
* How the task was created.
|
|
59
58
|
* @readonly
|
|
@@ -73,13 +72,13 @@ export interface TaskSource {
|
|
|
73
72
|
userId?: string | null;
|
|
74
73
|
}
|
|
75
74
|
/** Possible sources that can create tasks. */
|
|
76
|
-
|
|
75
|
+
declare enum SourceType {
|
|
77
76
|
/** Task was created by an app. */
|
|
78
77
|
APP = "APP",
|
|
79
78
|
/** Task was created by a Wix user. */
|
|
80
79
|
USER = "USER"
|
|
81
80
|
}
|
|
82
|
-
|
|
81
|
+
interface ContactInfo {
|
|
83
82
|
/**
|
|
84
83
|
* ID of the contact associated with the task.
|
|
85
84
|
* @format GUID
|
|
@@ -111,7 +110,7 @@ export interface ContactInfo {
|
|
|
111
110
|
*/
|
|
112
111
|
phone?: string | null;
|
|
113
112
|
}
|
|
114
|
-
|
|
113
|
+
interface RepositionTask {
|
|
115
114
|
/**
|
|
116
115
|
* The id of the last task that was re-positioned
|
|
117
116
|
* @format GUID
|
|
@@ -120,11 +119,11 @@ export interface RepositionTask {
|
|
|
120
119
|
/** The position of the last task that was re-positioned */
|
|
121
120
|
position?: string | null;
|
|
122
121
|
}
|
|
123
|
-
|
|
122
|
+
interface TaskOverdue {
|
|
124
123
|
/** The overdue task. */
|
|
125
124
|
task?: Task;
|
|
126
125
|
}
|
|
127
|
-
|
|
126
|
+
interface TaskAssigned {
|
|
128
127
|
/**
|
|
129
128
|
* The id of the assignee
|
|
130
129
|
* @format GUID
|
|
@@ -133,51 +132,51 @@ export interface TaskAssigned {
|
|
|
133
132
|
/** The task that was assigned */
|
|
134
133
|
task?: Task;
|
|
135
134
|
}
|
|
136
|
-
|
|
135
|
+
interface CreateTaskRequest {
|
|
137
136
|
/** Task to create. */
|
|
138
137
|
task: Task;
|
|
139
138
|
}
|
|
140
|
-
|
|
139
|
+
interface CreateTaskResponse {
|
|
141
140
|
/** The created task. */
|
|
142
141
|
task?: Task;
|
|
143
142
|
}
|
|
144
|
-
|
|
143
|
+
interface ContactNotFoundError {
|
|
145
144
|
/** @format GUID */
|
|
146
145
|
contactId?: string;
|
|
147
146
|
}
|
|
148
|
-
|
|
147
|
+
interface GetTaskRequest {
|
|
149
148
|
/**
|
|
150
149
|
* ID of the task to retrieve.
|
|
151
150
|
* @format GUID
|
|
152
151
|
*/
|
|
153
152
|
taskId: string;
|
|
154
153
|
}
|
|
155
|
-
|
|
154
|
+
interface GetTaskResponse {
|
|
156
155
|
/** The retrieved task. */
|
|
157
156
|
task?: Task;
|
|
158
157
|
}
|
|
159
|
-
|
|
158
|
+
interface UpdateTaskRequest {
|
|
160
159
|
/** Task to update. */
|
|
161
160
|
task: Task;
|
|
162
161
|
}
|
|
163
|
-
|
|
162
|
+
interface UpdateTaskResponse {
|
|
164
163
|
/** The updated task. */
|
|
165
164
|
task?: Task;
|
|
166
165
|
}
|
|
167
|
-
|
|
166
|
+
interface DeleteTaskRequest {
|
|
168
167
|
/**
|
|
169
168
|
* ID of the task to delete.
|
|
170
169
|
* @format GUID
|
|
171
170
|
*/
|
|
172
171
|
taskId: string;
|
|
173
172
|
}
|
|
174
|
-
|
|
173
|
+
interface DeleteTaskResponse {
|
|
175
174
|
}
|
|
176
|
-
|
|
175
|
+
interface QueryTasksRequest {
|
|
177
176
|
/** Query options. */
|
|
178
177
|
query?: CursorQuery;
|
|
179
178
|
}
|
|
180
|
-
|
|
179
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
181
180
|
/** 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`. */
|
|
182
181
|
cursorPaging?: CursorPaging;
|
|
183
182
|
/**
|
|
@@ -196,23 +195,23 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
196
195
|
sort?: Sorting[];
|
|
197
196
|
}
|
|
198
197
|
/** @oneof */
|
|
199
|
-
|
|
198
|
+
interface CursorQueryPagingMethodOneOf {
|
|
200
199
|
/** 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`. */
|
|
201
200
|
cursorPaging?: CursorPaging;
|
|
202
201
|
}
|
|
203
|
-
|
|
202
|
+
interface Sorting {
|
|
204
203
|
/** Name of the field to sort by. */
|
|
205
204
|
fieldName?: string;
|
|
206
205
|
/** Sort order. */
|
|
207
206
|
order?: SortOrder;
|
|
208
207
|
}
|
|
209
|
-
|
|
208
|
+
declare enum SortOrder {
|
|
210
209
|
/** Sort by ascending order. */
|
|
211
210
|
ASC = "ASC",
|
|
212
211
|
/** Sort by descending order. */
|
|
213
212
|
DESC = "DESC"
|
|
214
213
|
}
|
|
215
|
-
|
|
214
|
+
interface CursorPaging {
|
|
216
215
|
/**
|
|
217
216
|
* Number of items to load.
|
|
218
217
|
* @max 1000
|
|
@@ -227,13 +226,13 @@ export interface CursorPaging {
|
|
|
227
226
|
*/
|
|
228
227
|
cursor?: string | null;
|
|
229
228
|
}
|
|
230
|
-
|
|
229
|
+
interface QueryTasksResponse {
|
|
231
230
|
/** The retrieved tasks. */
|
|
232
231
|
tasks?: Task[];
|
|
233
232
|
/** Paging metadata. */
|
|
234
233
|
pagingMetadata?: CursorPagingMetadata;
|
|
235
234
|
}
|
|
236
|
-
|
|
235
|
+
interface CursorPagingMetadata {
|
|
237
236
|
/** Number of items returned in the response. */
|
|
238
237
|
count?: number | null;
|
|
239
238
|
/** Offset that was requested. */
|
|
@@ -245,13 +244,13 @@ export interface CursorPagingMetadata {
|
|
|
245
244
|
*/
|
|
246
245
|
hasNext?: boolean | null;
|
|
247
246
|
}
|
|
248
|
-
|
|
247
|
+
interface Cursors {
|
|
249
248
|
/** Cursor pointing to next page in the list of results. */
|
|
250
249
|
next?: string | null;
|
|
251
250
|
/** Cursor pointing to previous page in the list of results. */
|
|
252
251
|
prev?: string | null;
|
|
253
252
|
}
|
|
254
|
-
|
|
253
|
+
interface CountTasksRequest {
|
|
255
254
|
/**
|
|
256
255
|
* 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)).
|
|
257
256
|
*
|
|
@@ -266,15 +265,15 @@ export interface CountTasksRequest {
|
|
|
266
265
|
*/
|
|
267
266
|
filter?: Record<string, any> | null;
|
|
268
267
|
}
|
|
269
|
-
|
|
268
|
+
interface CountTasksResponse {
|
|
270
269
|
/** The number of tasks that match the specified filter. */
|
|
271
270
|
count?: number;
|
|
272
271
|
}
|
|
273
|
-
|
|
272
|
+
interface QueryTasksInternalRequest {
|
|
274
273
|
/** WQL expression */
|
|
275
274
|
query?: QueryV2;
|
|
276
275
|
}
|
|
277
|
-
|
|
276
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
278
277
|
/** Paging options to limit and skip the number of items. */
|
|
279
278
|
paging?: Paging;
|
|
280
279
|
/** 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`. */
|
|
@@ -299,13 +298,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
299
298
|
fieldsets?: string[];
|
|
300
299
|
}
|
|
301
300
|
/** @oneof */
|
|
302
|
-
|
|
301
|
+
interface QueryV2PagingMethodOneOf {
|
|
303
302
|
/** Paging options to limit and skip the number of items. */
|
|
304
303
|
paging?: Paging;
|
|
305
304
|
/** 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`. */
|
|
306
305
|
cursorPaging?: CursorPaging;
|
|
307
306
|
}
|
|
308
|
-
|
|
307
|
+
interface Paging {
|
|
309
308
|
/**
|
|
310
309
|
* Number of items to load.
|
|
311
310
|
* @max 1000
|
|
@@ -314,13 +313,13 @@ export interface Paging {
|
|
|
314
313
|
/** Number of items to skip in the current sort order. */
|
|
315
314
|
offset?: number | null;
|
|
316
315
|
}
|
|
317
|
-
|
|
316
|
+
interface QueryTasksInternalResponse {
|
|
318
317
|
/** The retrieved tasks. */
|
|
319
318
|
tasks?: Task[];
|
|
320
319
|
/** Details on the paged set of results returned. */
|
|
321
320
|
pagingMetadata?: PagingMetadataV2;
|
|
322
321
|
}
|
|
323
|
-
|
|
322
|
+
interface PagingMetadataV2 {
|
|
324
323
|
/** Number of items returned in the response. */
|
|
325
324
|
count?: number | null;
|
|
326
325
|
/** Offset that was requested. */
|
|
@@ -332,7 +331,7 @@ export interface PagingMetadataV2 {
|
|
|
332
331
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
333
332
|
cursors?: Cursors;
|
|
334
333
|
}
|
|
335
|
-
|
|
334
|
+
interface MoveTaskAfterRequest {
|
|
336
335
|
/**
|
|
337
336
|
* ID of the task to move.
|
|
338
337
|
* @format GUID
|
|
@@ -345,18 +344,18 @@ export interface MoveTaskAfterRequest {
|
|
|
345
344
|
*/
|
|
346
345
|
beforeTaskId?: string | null;
|
|
347
346
|
}
|
|
348
|
-
|
|
347
|
+
interface MoveTaskAfterResponse {
|
|
349
348
|
}
|
|
350
|
-
|
|
349
|
+
interface TaskNotFoundError {
|
|
351
350
|
/**
|
|
352
351
|
* The task id that was not found
|
|
353
352
|
* @format GUID
|
|
354
353
|
*/
|
|
355
354
|
taskId?: string;
|
|
356
355
|
}
|
|
357
|
-
|
|
356
|
+
interface Empty {
|
|
358
357
|
}
|
|
359
|
-
|
|
358
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
360
359
|
createdEvent?: EntityCreatedEvent;
|
|
361
360
|
updatedEvent?: EntityUpdatedEvent;
|
|
362
361
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -399,19 +398,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
399
398
|
entityEventSequence?: string | null;
|
|
400
399
|
}
|
|
401
400
|
/** @oneof */
|
|
402
|
-
|
|
401
|
+
interface DomainEventBodyOneOf {
|
|
403
402
|
createdEvent?: EntityCreatedEvent;
|
|
404
403
|
updatedEvent?: EntityUpdatedEvent;
|
|
405
404
|
deletedEvent?: EntityDeletedEvent;
|
|
406
405
|
actionEvent?: ActionEvent;
|
|
407
406
|
}
|
|
408
|
-
|
|
407
|
+
interface EntityCreatedEvent {
|
|
409
408
|
entity?: string;
|
|
410
409
|
}
|
|
411
|
-
|
|
410
|
+
interface RestoreInfo {
|
|
412
411
|
deletedDate?: Date | null;
|
|
413
412
|
}
|
|
414
|
-
|
|
413
|
+
interface EntityUpdatedEvent {
|
|
415
414
|
/**
|
|
416
415
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
417
416
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -419,14 +418,14 @@ export interface EntityUpdatedEvent {
|
|
|
419
418
|
*/
|
|
420
419
|
currentEntity?: string;
|
|
421
420
|
}
|
|
422
|
-
|
|
421
|
+
interface EntityDeletedEvent {
|
|
423
422
|
/** Entity that was deleted */
|
|
424
423
|
deletedEntity?: string | null;
|
|
425
424
|
}
|
|
426
|
-
|
|
425
|
+
interface ActionEvent {
|
|
427
426
|
body?: string;
|
|
428
427
|
}
|
|
429
|
-
|
|
428
|
+
interface MessageEnvelope {
|
|
430
429
|
/**
|
|
431
430
|
* App instance ID.
|
|
432
431
|
* @format GUID
|
|
@@ -442,7 +441,7 @@ export interface MessageEnvelope {
|
|
|
442
441
|
/** Stringify payload. */
|
|
443
442
|
data?: string;
|
|
444
443
|
}
|
|
445
|
-
|
|
444
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
446
445
|
/**
|
|
447
446
|
* ID of a site visitor that has not logged in to the site.
|
|
448
447
|
* @format GUID
|
|
@@ -467,7 +466,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
467
466
|
identityType?: WebhookIdentityType;
|
|
468
467
|
}
|
|
469
468
|
/** @oneof */
|
|
470
|
-
|
|
469
|
+
interface IdentificationDataIdOneOf {
|
|
471
470
|
/**
|
|
472
471
|
* ID of a site visitor that has not logged in to the site.
|
|
473
472
|
* @format GUID
|
|
@@ -489,14 +488,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
489
488
|
*/
|
|
490
489
|
appId?: string;
|
|
491
490
|
}
|
|
492
|
-
|
|
491
|
+
declare enum WebhookIdentityType {
|
|
493
492
|
UNKNOWN = "UNKNOWN",
|
|
494
493
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
495
494
|
MEMBER = "MEMBER",
|
|
496
495
|
WIX_USER = "WIX_USER",
|
|
497
496
|
APP = "APP"
|
|
498
497
|
}
|
|
499
|
-
|
|
498
|
+
interface DeleteCompletedTasksRequest {
|
|
500
499
|
/**
|
|
501
500
|
* Optional list of tasks ids of the tasks to delete. If the list is not provided the filter is used.
|
|
502
501
|
* @format GUID
|
|
@@ -506,9 +505,9 @@ export interface DeleteCompletedTasksRequest {
|
|
|
506
505
|
/** An optional filter of tasks to count. See 'queryTasks' for supported filter options. */
|
|
507
506
|
filter?: Record<string, any> | null;
|
|
508
507
|
}
|
|
509
|
-
|
|
508
|
+
interface DeleteCompletedTasksResponse {
|
|
510
509
|
}
|
|
511
|
-
|
|
510
|
+
interface SendTasksReminderRequest {
|
|
512
511
|
/**
|
|
513
512
|
* Ids of the tasks to remind
|
|
514
513
|
* @format GUID
|
|
@@ -518,14 +517,14 @@ export interface SendTasksReminderRequest {
|
|
|
518
517
|
/** The reminder type */
|
|
519
518
|
reminderType?: ReminderType;
|
|
520
519
|
}
|
|
521
|
-
|
|
520
|
+
declare enum ReminderType {
|
|
522
521
|
UNKNOWN_REMINDER_TYPE = "UNKNOWN_REMINDER_TYPE",
|
|
523
522
|
FIRST_REMINDER = "FIRST_REMINDER",
|
|
524
523
|
LAST_REMINDER = "LAST_REMINDER"
|
|
525
524
|
}
|
|
526
|
-
|
|
525
|
+
interface SendTasksReminderResponse {
|
|
527
526
|
}
|
|
528
|
-
|
|
527
|
+
interface BaseEventMetadata {
|
|
529
528
|
/**
|
|
530
529
|
* App instance ID.
|
|
531
530
|
* @format GUID
|
|
@@ -539,7 +538,7 @@ export interface BaseEventMetadata {
|
|
|
539
538
|
/** The identification type and identity data. */
|
|
540
539
|
identity?: IdentificationData;
|
|
541
540
|
}
|
|
542
|
-
|
|
541
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
543
542
|
/**
|
|
544
543
|
* Unique event ID.
|
|
545
544
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -577,124 +576,22 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
577
576
|
*/
|
|
578
577
|
entityEventSequence?: string | null;
|
|
579
578
|
}
|
|
580
|
-
|
|
579
|
+
interface TaskCreatedEnvelope {
|
|
581
580
|
entity: Task;
|
|
582
581
|
metadata: EventMetadata;
|
|
583
582
|
}
|
|
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 {
|
|
583
|
+
interface TaskDeletedEnvelope {
|
|
598
584
|
metadata: EventMetadata;
|
|
599
585
|
}
|
|
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 {
|
|
586
|
+
interface TaskOverdueEnvelope {
|
|
614
587
|
data: TaskOverdue;
|
|
615
588
|
metadata: EventMetadata;
|
|
616
589
|
}
|
|
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 {
|
|
590
|
+
interface TaskUpdatedEnvelope {
|
|
631
591
|
entity: Task;
|
|
632
592
|
metadata: EventMetadata;
|
|
633
593
|
}
|
|
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 {
|
|
594
|
+
interface UpdateTask {
|
|
698
595
|
/**
|
|
699
596
|
* Task ID.
|
|
700
597
|
* @format GUID
|
|
@@ -741,42 +638,6 @@ export interface UpdateTask {
|
|
|
741
638
|
/** Information about the contact associated with the task. */
|
|
742
639
|
contact?: ContactInfo;
|
|
743
640
|
}
|
|
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;
|
|
780
641
|
interface QueryCursorResult {
|
|
781
642
|
cursors: Cursors;
|
|
782
643
|
hasNext: () => boolean;
|
|
@@ -784,13 +645,13 @@ interface QueryCursorResult {
|
|
|
784
645
|
length: number;
|
|
785
646
|
pageSize: number;
|
|
786
647
|
}
|
|
787
|
-
|
|
648
|
+
interface TasksQueryResult extends QueryCursorResult {
|
|
788
649
|
items: Task[];
|
|
789
650
|
query: TasksQueryBuilder;
|
|
790
651
|
next: () => Promise<TasksQueryResult>;
|
|
791
652
|
prev: () => Promise<TasksQueryResult>;
|
|
792
653
|
}
|
|
793
|
-
|
|
654
|
+
interface TasksQueryBuilder {
|
|
794
655
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
795
656
|
* @param value - Value to compare against.
|
|
796
657
|
*/
|
|
@@ -827,25 +688,7 @@ export interface TasksQueryBuilder {
|
|
|
827
688
|
skipTo: (cursor: string) => TasksQueryBuilder;
|
|
828
689
|
find: () => Promise<TasksQueryResult>;
|
|
829
690
|
}
|
|
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 {
|
|
691
|
+
interface CountTasksOptions {
|
|
849
692
|
/**
|
|
850
693
|
* 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)).
|
|
851
694
|
*
|
|
@@ -860,22 +703,7 @@ export interface CountTasksOptions {
|
|
|
860
703
|
*/
|
|
861
704
|
filter?: Record<string, any> | null;
|
|
862
705
|
}
|
|
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 {
|
|
706
|
+
interface MoveTaskAfterOptions {
|
|
879
707
|
/**
|
|
880
708
|
* The ID of the task after which the moved task is positioned in the task display.
|
|
881
709
|
* If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
|
|
@@ -883,4 +711,5 @@ export interface MoveTaskAfterOptions {
|
|
|
883
711
|
*/
|
|
884
712
|
beforeTaskId?: string | null;
|
|
885
713
|
}
|
|
886
|
-
|
|
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 };
|