@wix/auto_sdk_crm_tasks 1.0.5 → 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 -258
- package/build/{cjs/src/crm-tasks-v2-task-tasks.universal.d.ts → crm-tasks-v2-task-tasks.universal-DHOV27KP.d.ts} +67 -258
- 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 -258
- package/build/internal/{es/src/crm-tasks-v2-task-tasks.universal.d.ts → crm-tasks-v2-task-tasks.universal-DHOV27KP.d.ts} +67 -258
- 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 -551
- 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 -551
- 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 -551
- 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 -551
- 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,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface Task {
|
|
2
2
|
/**
|
|
3
3
|
* Task ID.
|
|
4
4
|
* @format GUID
|
|
@@ -46,13 +46,13 @@ export interface Task {
|
|
|
46
46
|
contact?: ContactInfo;
|
|
47
47
|
}
|
|
48
48
|
/** Possible statuses in which the task may be. */
|
|
49
|
-
|
|
49
|
+
declare enum TaskStatus {
|
|
50
50
|
/** Action needed. */
|
|
51
51
|
ACTION_NEEDED = "ACTION_NEEDED",
|
|
52
52
|
/** Task completed. */
|
|
53
53
|
COMPLETED = "COMPLETED"
|
|
54
54
|
}
|
|
55
|
-
|
|
55
|
+
interface TaskSource {
|
|
56
56
|
/**
|
|
57
57
|
* How the task was created.
|
|
58
58
|
* @readonly
|
|
@@ -72,13 +72,13 @@ export interface TaskSource {
|
|
|
72
72
|
userId?: string | null;
|
|
73
73
|
}
|
|
74
74
|
/** Possible sources that can create tasks. */
|
|
75
|
-
|
|
75
|
+
declare enum SourceType {
|
|
76
76
|
/** Task was created by an app. */
|
|
77
77
|
APP = "APP",
|
|
78
78
|
/** Task was created by a Wix user. */
|
|
79
79
|
USER = "USER"
|
|
80
80
|
}
|
|
81
|
-
|
|
81
|
+
interface ContactInfo {
|
|
82
82
|
/**
|
|
83
83
|
* ID of the contact associated with the task.
|
|
84
84
|
* @format GUID
|
|
@@ -110,7 +110,7 @@ export interface ContactInfo {
|
|
|
110
110
|
*/
|
|
111
111
|
phone?: string | null;
|
|
112
112
|
}
|
|
113
|
-
|
|
113
|
+
interface RepositionTask {
|
|
114
114
|
/**
|
|
115
115
|
* The id of the last task that was re-positioned
|
|
116
116
|
* @format GUID
|
|
@@ -119,11 +119,11 @@ export interface RepositionTask {
|
|
|
119
119
|
/** The position of the last task that was re-positioned */
|
|
120
120
|
position?: string | null;
|
|
121
121
|
}
|
|
122
|
-
|
|
122
|
+
interface TaskOverdue {
|
|
123
123
|
/** The overdue task. */
|
|
124
124
|
task?: Task;
|
|
125
125
|
}
|
|
126
|
-
|
|
126
|
+
interface TaskAssigned {
|
|
127
127
|
/**
|
|
128
128
|
* The id of the assignee
|
|
129
129
|
* @format GUID
|
|
@@ -132,51 +132,51 @@ export interface TaskAssigned {
|
|
|
132
132
|
/** The task that was assigned */
|
|
133
133
|
task?: Task;
|
|
134
134
|
}
|
|
135
|
-
|
|
135
|
+
interface CreateTaskRequest {
|
|
136
136
|
/** Task to create. */
|
|
137
137
|
task: Task;
|
|
138
138
|
}
|
|
139
|
-
|
|
139
|
+
interface CreateTaskResponse {
|
|
140
140
|
/** The created task. */
|
|
141
141
|
task?: Task;
|
|
142
142
|
}
|
|
143
|
-
|
|
143
|
+
interface ContactNotFoundError {
|
|
144
144
|
/** @format GUID */
|
|
145
145
|
contactId?: string;
|
|
146
146
|
}
|
|
147
|
-
|
|
147
|
+
interface GetTaskRequest {
|
|
148
148
|
/**
|
|
149
149
|
* ID of the task to retrieve.
|
|
150
150
|
* @format GUID
|
|
151
151
|
*/
|
|
152
152
|
taskId: string;
|
|
153
153
|
}
|
|
154
|
-
|
|
154
|
+
interface GetTaskResponse {
|
|
155
155
|
/** The retrieved task. */
|
|
156
156
|
task?: Task;
|
|
157
157
|
}
|
|
158
|
-
|
|
158
|
+
interface UpdateTaskRequest {
|
|
159
159
|
/** Task to update. */
|
|
160
160
|
task: Task;
|
|
161
161
|
}
|
|
162
|
-
|
|
162
|
+
interface UpdateTaskResponse {
|
|
163
163
|
/** The updated task. */
|
|
164
164
|
task?: Task;
|
|
165
165
|
}
|
|
166
|
-
|
|
166
|
+
interface DeleteTaskRequest {
|
|
167
167
|
/**
|
|
168
168
|
* ID of the task to delete.
|
|
169
169
|
* @format GUID
|
|
170
170
|
*/
|
|
171
171
|
taskId: string;
|
|
172
172
|
}
|
|
173
|
-
|
|
173
|
+
interface DeleteTaskResponse {
|
|
174
174
|
}
|
|
175
|
-
|
|
175
|
+
interface QueryTasksRequest {
|
|
176
176
|
/** Query options. */
|
|
177
177
|
query?: CursorQuery;
|
|
178
178
|
}
|
|
179
|
-
|
|
179
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
180
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`. */
|
|
181
181
|
cursorPaging?: CursorPaging;
|
|
182
182
|
/**
|
|
@@ -195,23 +195,23 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
195
195
|
sort?: Sorting[];
|
|
196
196
|
}
|
|
197
197
|
/** @oneof */
|
|
198
|
-
|
|
198
|
+
interface CursorQueryPagingMethodOneOf {
|
|
199
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`. */
|
|
200
200
|
cursorPaging?: CursorPaging;
|
|
201
201
|
}
|
|
202
|
-
|
|
202
|
+
interface Sorting {
|
|
203
203
|
/** Name of the field to sort by. */
|
|
204
204
|
fieldName?: string;
|
|
205
205
|
/** Sort order. */
|
|
206
206
|
order?: SortOrder;
|
|
207
207
|
}
|
|
208
|
-
|
|
208
|
+
declare enum SortOrder {
|
|
209
209
|
/** Sort by ascending order. */
|
|
210
210
|
ASC = "ASC",
|
|
211
211
|
/** Sort by descending order. */
|
|
212
212
|
DESC = "DESC"
|
|
213
213
|
}
|
|
214
|
-
|
|
214
|
+
interface CursorPaging {
|
|
215
215
|
/**
|
|
216
216
|
* Number of items to load.
|
|
217
217
|
* @max 1000
|
|
@@ -226,13 +226,13 @@ export interface CursorPaging {
|
|
|
226
226
|
*/
|
|
227
227
|
cursor?: string | null;
|
|
228
228
|
}
|
|
229
|
-
|
|
229
|
+
interface QueryTasksResponse {
|
|
230
230
|
/** The retrieved tasks. */
|
|
231
231
|
tasks?: Task[];
|
|
232
232
|
/** Paging metadata. */
|
|
233
233
|
pagingMetadata?: CursorPagingMetadata;
|
|
234
234
|
}
|
|
235
|
-
|
|
235
|
+
interface CursorPagingMetadata {
|
|
236
236
|
/** Number of items returned in the response. */
|
|
237
237
|
count?: number | null;
|
|
238
238
|
/** Offset that was requested. */
|
|
@@ -244,13 +244,13 @@ export interface CursorPagingMetadata {
|
|
|
244
244
|
*/
|
|
245
245
|
hasNext?: boolean | null;
|
|
246
246
|
}
|
|
247
|
-
|
|
247
|
+
interface Cursors {
|
|
248
248
|
/** Cursor pointing to next page in the list of results. */
|
|
249
249
|
next?: string | null;
|
|
250
250
|
/** Cursor pointing to previous page in the list of results. */
|
|
251
251
|
prev?: string | null;
|
|
252
252
|
}
|
|
253
|
-
|
|
253
|
+
interface CountTasksRequest {
|
|
254
254
|
/**
|
|
255
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)).
|
|
256
256
|
*
|
|
@@ -265,15 +265,15 @@ export interface CountTasksRequest {
|
|
|
265
265
|
*/
|
|
266
266
|
filter?: Record<string, any> | null;
|
|
267
267
|
}
|
|
268
|
-
|
|
268
|
+
interface CountTasksResponse {
|
|
269
269
|
/** The number of tasks that match the specified filter. */
|
|
270
270
|
count?: number;
|
|
271
271
|
}
|
|
272
|
-
|
|
272
|
+
interface QueryTasksInternalRequest {
|
|
273
273
|
/** WQL expression */
|
|
274
274
|
query?: QueryV2;
|
|
275
275
|
}
|
|
276
|
-
|
|
276
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
277
277
|
/** Paging options to limit and skip the number of items. */
|
|
278
278
|
paging?: Paging;
|
|
279
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`. */
|
|
@@ -298,13 +298,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
298
298
|
fieldsets?: string[];
|
|
299
299
|
}
|
|
300
300
|
/** @oneof */
|
|
301
|
-
|
|
301
|
+
interface QueryV2PagingMethodOneOf {
|
|
302
302
|
/** Paging options to limit and skip the number of items. */
|
|
303
303
|
paging?: Paging;
|
|
304
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`. */
|
|
305
305
|
cursorPaging?: CursorPaging;
|
|
306
306
|
}
|
|
307
|
-
|
|
307
|
+
interface Paging {
|
|
308
308
|
/**
|
|
309
309
|
* Number of items to load.
|
|
310
310
|
* @max 1000
|
|
@@ -313,13 +313,13 @@ export interface Paging {
|
|
|
313
313
|
/** Number of items to skip in the current sort order. */
|
|
314
314
|
offset?: number | null;
|
|
315
315
|
}
|
|
316
|
-
|
|
316
|
+
interface QueryTasksInternalResponse {
|
|
317
317
|
/** The retrieved tasks. */
|
|
318
318
|
tasks?: Task[];
|
|
319
319
|
/** Details on the paged set of results returned. */
|
|
320
320
|
pagingMetadata?: PagingMetadataV2;
|
|
321
321
|
}
|
|
322
|
-
|
|
322
|
+
interface PagingMetadataV2 {
|
|
323
323
|
/** Number of items returned in the response. */
|
|
324
324
|
count?: number | null;
|
|
325
325
|
/** Offset that was requested. */
|
|
@@ -331,7 +331,7 @@ export interface PagingMetadataV2 {
|
|
|
331
331
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
332
332
|
cursors?: Cursors;
|
|
333
333
|
}
|
|
334
|
-
|
|
334
|
+
interface MoveTaskAfterRequest {
|
|
335
335
|
/**
|
|
336
336
|
* ID of the task to move.
|
|
337
337
|
* @format GUID
|
|
@@ -344,18 +344,18 @@ export interface MoveTaskAfterRequest {
|
|
|
344
344
|
*/
|
|
345
345
|
beforeTaskId?: string | null;
|
|
346
346
|
}
|
|
347
|
-
|
|
347
|
+
interface MoveTaskAfterResponse {
|
|
348
348
|
}
|
|
349
|
-
|
|
349
|
+
interface TaskNotFoundError {
|
|
350
350
|
/**
|
|
351
351
|
* The task id that was not found
|
|
352
352
|
* @format GUID
|
|
353
353
|
*/
|
|
354
354
|
taskId?: string;
|
|
355
355
|
}
|
|
356
|
-
|
|
356
|
+
interface Empty {
|
|
357
357
|
}
|
|
358
|
-
|
|
358
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
359
359
|
createdEvent?: EntityCreatedEvent;
|
|
360
360
|
updatedEvent?: EntityUpdatedEvent;
|
|
361
361
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -398,19 +398,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
398
398
|
entityEventSequence?: string | null;
|
|
399
399
|
}
|
|
400
400
|
/** @oneof */
|
|
401
|
-
|
|
401
|
+
interface DomainEventBodyOneOf {
|
|
402
402
|
createdEvent?: EntityCreatedEvent;
|
|
403
403
|
updatedEvent?: EntityUpdatedEvent;
|
|
404
404
|
deletedEvent?: EntityDeletedEvent;
|
|
405
405
|
actionEvent?: ActionEvent;
|
|
406
406
|
}
|
|
407
|
-
|
|
407
|
+
interface EntityCreatedEvent {
|
|
408
408
|
entity?: string;
|
|
409
409
|
}
|
|
410
|
-
|
|
410
|
+
interface RestoreInfo {
|
|
411
411
|
deletedDate?: Date | null;
|
|
412
412
|
}
|
|
413
|
-
|
|
413
|
+
interface EntityUpdatedEvent {
|
|
414
414
|
/**
|
|
415
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.
|
|
416
416
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -418,14 +418,14 @@ export interface EntityUpdatedEvent {
|
|
|
418
418
|
*/
|
|
419
419
|
currentEntity?: string;
|
|
420
420
|
}
|
|
421
|
-
|
|
421
|
+
interface EntityDeletedEvent {
|
|
422
422
|
/** Entity that was deleted */
|
|
423
423
|
deletedEntity?: string | null;
|
|
424
424
|
}
|
|
425
|
-
|
|
425
|
+
interface ActionEvent {
|
|
426
426
|
body?: string;
|
|
427
427
|
}
|
|
428
|
-
|
|
428
|
+
interface MessageEnvelope {
|
|
429
429
|
/**
|
|
430
430
|
* App instance ID.
|
|
431
431
|
* @format GUID
|
|
@@ -441,7 +441,7 @@ export interface MessageEnvelope {
|
|
|
441
441
|
/** Stringify payload. */
|
|
442
442
|
data?: string;
|
|
443
443
|
}
|
|
444
|
-
|
|
444
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
445
445
|
/**
|
|
446
446
|
* ID of a site visitor that has not logged in to the site.
|
|
447
447
|
* @format GUID
|
|
@@ -466,7 +466,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
466
466
|
identityType?: WebhookIdentityType;
|
|
467
467
|
}
|
|
468
468
|
/** @oneof */
|
|
469
|
-
|
|
469
|
+
interface IdentificationDataIdOneOf {
|
|
470
470
|
/**
|
|
471
471
|
* ID of a site visitor that has not logged in to the site.
|
|
472
472
|
* @format GUID
|
|
@@ -488,14 +488,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
488
488
|
*/
|
|
489
489
|
appId?: string;
|
|
490
490
|
}
|
|
491
|
-
|
|
491
|
+
declare enum WebhookIdentityType {
|
|
492
492
|
UNKNOWN = "UNKNOWN",
|
|
493
493
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
494
494
|
MEMBER = "MEMBER",
|
|
495
495
|
WIX_USER = "WIX_USER",
|
|
496
496
|
APP = "APP"
|
|
497
497
|
}
|
|
498
|
-
|
|
498
|
+
interface DeleteCompletedTasksRequest {
|
|
499
499
|
/**
|
|
500
500
|
* Optional list of tasks ids of the tasks to delete. If the list is not provided the filter is used.
|
|
501
501
|
* @format GUID
|
|
@@ -505,9 +505,9 @@ export interface DeleteCompletedTasksRequest {
|
|
|
505
505
|
/** An optional filter of tasks to count. See 'queryTasks' for supported filter options. */
|
|
506
506
|
filter?: Record<string, any> | null;
|
|
507
507
|
}
|
|
508
|
-
|
|
508
|
+
interface DeleteCompletedTasksResponse {
|
|
509
509
|
}
|
|
510
|
-
|
|
510
|
+
interface SendTasksReminderRequest {
|
|
511
511
|
/**
|
|
512
512
|
* Ids of the tasks to remind
|
|
513
513
|
* @format GUID
|
|
@@ -517,36 +517,14 @@ export interface SendTasksReminderRequest {
|
|
|
517
517
|
/** The reminder type */
|
|
518
518
|
reminderType?: ReminderType;
|
|
519
519
|
}
|
|
520
|
-
|
|
520
|
+
declare enum ReminderType {
|
|
521
521
|
UNKNOWN_REMINDER_TYPE = "UNKNOWN_REMINDER_TYPE",
|
|
522
522
|
FIRST_REMINDER = "FIRST_REMINDER",
|
|
523
523
|
LAST_REMINDER = "LAST_REMINDER"
|
|
524
524
|
}
|
|
525
|
-
|
|
525
|
+
interface SendTasksReminderResponse {
|
|
526
526
|
}
|
|
527
|
-
interface
|
|
528
|
-
sourceType: SourceType;
|
|
529
|
-
}
|
|
530
|
-
export interface TaskNonNullableFields {
|
|
531
|
-
status: TaskStatus;
|
|
532
|
-
source?: TaskSourceNonNullableFields;
|
|
533
|
-
}
|
|
534
|
-
export interface CreateTaskResponseNonNullableFields {
|
|
535
|
-
task?: TaskNonNullableFields;
|
|
536
|
-
}
|
|
537
|
-
export interface GetTaskResponseNonNullableFields {
|
|
538
|
-
task?: TaskNonNullableFields;
|
|
539
|
-
}
|
|
540
|
-
export interface UpdateTaskResponseNonNullableFields {
|
|
541
|
-
task?: TaskNonNullableFields;
|
|
542
|
-
}
|
|
543
|
-
export interface QueryTasksResponseNonNullableFields {
|
|
544
|
-
tasks: TaskNonNullableFields[];
|
|
545
|
-
}
|
|
546
|
-
export interface CountTasksResponseNonNullableFields {
|
|
547
|
-
count: number;
|
|
548
|
-
}
|
|
549
|
-
export interface BaseEventMetadata {
|
|
527
|
+
interface BaseEventMetadata {
|
|
550
528
|
/**
|
|
551
529
|
* App instance ID.
|
|
552
530
|
* @format GUID
|
|
@@ -560,7 +538,7 @@ export interface BaseEventMetadata {
|
|
|
560
538
|
/** The identification type and identity data. */
|
|
561
539
|
identity?: IdentificationData;
|
|
562
540
|
}
|
|
563
|
-
|
|
541
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
564
542
|
/**
|
|
565
543
|
* Unique event ID.
|
|
566
544
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -598,123 +576,22 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
598
576
|
*/
|
|
599
577
|
entityEventSequence?: string | null;
|
|
600
578
|
}
|
|
601
|
-
|
|
579
|
+
interface TaskCreatedEnvelope {
|
|
602
580
|
entity: Task;
|
|
603
581
|
metadata: EventMetadata;
|
|
604
582
|
}
|
|
605
|
-
|
|
606
|
-
* Triggered when a task is created.
|
|
607
|
-
* @permissionScope Read Tasks
|
|
608
|
-
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
609
|
-
* @permissionScope Manage Tasks
|
|
610
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
611
|
-
* @permissionId CRM_TASKS.TASK_READ
|
|
612
|
-
* @webhook
|
|
613
|
-
* @eventType wix.crm.tasks.v2.task_created
|
|
614
|
-
* @serviceIdentifier wix.crm.tasks.v2.Tasks
|
|
615
|
-
* @slug created
|
|
616
|
-
*/
|
|
617
|
-
export declare function onTaskCreated(handler: (event: TaskCreatedEnvelope) => void | Promise<void>): void;
|
|
618
|
-
export interface TaskDeletedEnvelope {
|
|
583
|
+
interface TaskDeletedEnvelope {
|
|
619
584
|
metadata: EventMetadata;
|
|
620
585
|
}
|
|
621
|
-
|
|
622
|
-
* Triggered when a task is deleted.
|
|
623
|
-
* @permissionScope Read Tasks
|
|
624
|
-
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
625
|
-
* @permissionScope Manage Tasks
|
|
626
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
627
|
-
* @permissionId CRM_TASKS.TASK_READ
|
|
628
|
-
* @webhook
|
|
629
|
-
* @eventType wix.crm.tasks.v2.task_deleted
|
|
630
|
-
* @serviceIdentifier wix.crm.tasks.v2.Tasks
|
|
631
|
-
* @slug deleted
|
|
632
|
-
*/
|
|
633
|
-
export declare function onTaskDeleted(handler: (event: TaskDeletedEnvelope) => void | Promise<void>): void;
|
|
634
|
-
export interface TaskOverdueEnvelope {
|
|
586
|
+
interface TaskOverdueEnvelope {
|
|
635
587
|
data: TaskOverdue;
|
|
636
588
|
metadata: EventMetadata;
|
|
637
589
|
}
|
|
638
|
-
|
|
639
|
-
* Triggered when a task reaches its due date.
|
|
640
|
-
* @permissionScope Read Tasks
|
|
641
|
-
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
642
|
-
* @permissionScope Manage Tasks
|
|
643
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
644
|
-
* @permissionId CRM_TASKS.TASK_READ
|
|
645
|
-
* @webhook
|
|
646
|
-
* @eventType wix.crm.tasks.v2.task_task_overdue
|
|
647
|
-
* @serviceIdentifier wix.crm.tasks.v2.Tasks
|
|
648
|
-
* @slug task_overdue
|
|
649
|
-
*/
|
|
650
|
-
export declare function onTaskOverdue(handler: (event: TaskOverdueEnvelope) => void | Promise<void>): void;
|
|
651
|
-
export interface TaskUpdatedEnvelope {
|
|
590
|
+
interface TaskUpdatedEnvelope {
|
|
652
591
|
entity: Task;
|
|
653
592
|
metadata: EventMetadata;
|
|
654
593
|
}
|
|
655
|
-
|
|
656
|
-
* Triggered when a task is updated.
|
|
657
|
-
* @permissionScope Read Tasks
|
|
658
|
-
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
659
|
-
* @permissionScope Manage Tasks
|
|
660
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
661
|
-
* @permissionId CRM_TASKS.TASK_READ
|
|
662
|
-
* @webhook
|
|
663
|
-
* @eventType wix.crm.tasks.v2.task_updated
|
|
664
|
-
* @serviceIdentifier wix.crm.tasks.v2.Tasks
|
|
665
|
-
* @slug updated
|
|
666
|
-
*/
|
|
667
|
-
export declare function onTaskUpdated(handler: (event: TaskUpdatedEnvelope) => void | Promise<void>): void;
|
|
668
|
-
/**
|
|
669
|
-
* Creates a new task.
|
|
670
|
-
* @param task - Task to create.
|
|
671
|
-
* @public
|
|
672
|
-
* @requiredField task
|
|
673
|
-
* @permissionId CRM_TASKS.TASK_CREATE
|
|
674
|
-
* @permissionScope Manage Tasks
|
|
675
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
676
|
-
* @applicableIdentity APP
|
|
677
|
-
* @returns The created task.
|
|
678
|
-
* @fqn wix.crm.tasks.v2.Tasks.CreateTask
|
|
679
|
-
*/
|
|
680
|
-
export declare function createTask(task: Task): Promise<Task & TaskNonNullableFields>;
|
|
681
|
-
/**
|
|
682
|
-
* Retrieves a task by ID.
|
|
683
|
-
* @param taskId - ID of the task to retrieve.
|
|
684
|
-
* @public
|
|
685
|
-
* @requiredField taskId
|
|
686
|
-
* @permissionId CRM_TASKS.TASK_READ
|
|
687
|
-
* @permissionScope Read Tasks
|
|
688
|
-
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
689
|
-
* @permissionScope Manage Tasks
|
|
690
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
691
|
-
* @applicableIdentity APP
|
|
692
|
-
* @returns The retrieved task.
|
|
693
|
-
* @fqn wix.crm.tasks.v2.Tasks.GetTask
|
|
694
|
-
*/
|
|
695
|
-
export declare function getTask(taskId: string): Promise<Task & TaskNonNullableFields>;
|
|
696
|
-
/**
|
|
697
|
-
* Updates a task.
|
|
698
|
-
*
|
|
699
|
-
* Each time the task is updated, `revision` increments by 1.
|
|
700
|
-
* The existing `revision` must be included when updating the task.
|
|
701
|
-
* This ensures you're working with the latest task
|
|
702
|
-
* and prevents unintended overwrites.
|
|
703
|
-
* @param _id - Task ID.
|
|
704
|
-
* @public
|
|
705
|
-
* @requiredField _id
|
|
706
|
-
* @requiredField task
|
|
707
|
-
* @requiredField task.revision
|
|
708
|
-
* @param task - Task to update.
|
|
709
|
-
* @permissionId CRM_TASKS.TASK_UPDATE
|
|
710
|
-
* @permissionScope Manage Tasks
|
|
711
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
712
|
-
* @applicableIdentity APP
|
|
713
|
-
* @returns The updated task.
|
|
714
|
-
* @fqn wix.crm.tasks.v2.Tasks.UpdateTask
|
|
715
|
-
*/
|
|
716
|
-
export declare function updateTask(_id: string | null, task: UpdateTask): Promise<Task & TaskNonNullableFields>;
|
|
717
|
-
export interface UpdateTask {
|
|
594
|
+
interface UpdateTask {
|
|
718
595
|
/**
|
|
719
596
|
* Task ID.
|
|
720
597
|
* @format GUID
|
|
@@ -761,42 +638,6 @@ export interface UpdateTask {
|
|
|
761
638
|
/** Information about the contact associated with the task. */
|
|
762
639
|
contact?: ContactInfo;
|
|
763
640
|
}
|
|
764
|
-
/**
|
|
765
|
-
* Deletes a task by ID.
|
|
766
|
-
* @param taskId - ID of the task to delete.
|
|
767
|
-
* @public
|
|
768
|
-
* @requiredField taskId
|
|
769
|
-
* @permissionId CRM_TASKS.TASK_DELETE
|
|
770
|
-
* @permissionScope Manage Tasks
|
|
771
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
772
|
-
* @applicableIdentity APP
|
|
773
|
-
* @fqn wix.crm.tasks.v2.Tasks.DeleteTask
|
|
774
|
-
*/
|
|
775
|
-
export declare function deleteTask(taskId: string): Promise<void>;
|
|
776
|
-
/**
|
|
777
|
-
* Creates a query to retrieve a list of tasks.
|
|
778
|
-
*
|
|
779
|
-
* The `queryTasks()` method builds a query to retrieve a list of tasks and returns a `TasksQueryBuilder` object.
|
|
780
|
-
*
|
|
781
|
-
* 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.
|
|
782
|
-
*
|
|
783
|
-
* `queryTasks()` runs with these `TasksQueryBuilder` defaults, which you can override:
|
|
784
|
-
* - `limit(50)`
|
|
785
|
-
* - `descending('_createdDate')`
|
|
786
|
-
*
|
|
787
|
-
* 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.
|
|
788
|
-
*
|
|
789
|
-
* 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`.
|
|
790
|
-
* @public
|
|
791
|
-
* @permissionScope Read Tasks
|
|
792
|
-
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
793
|
-
* @permissionScope Manage Tasks
|
|
794
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
795
|
-
* @permissionId CRM_TASKS.TASK_READ
|
|
796
|
-
* @applicableIdentity APP
|
|
797
|
-
* @fqn wix.crm.tasks.v2.Tasks.QueryTasks
|
|
798
|
-
*/
|
|
799
|
-
export declare function queryTasks(): TasksQueryBuilder;
|
|
800
641
|
interface QueryCursorResult {
|
|
801
642
|
cursors: Cursors;
|
|
802
643
|
hasNext: () => boolean;
|
|
@@ -804,13 +645,13 @@ interface QueryCursorResult {
|
|
|
804
645
|
length: number;
|
|
805
646
|
pageSize: number;
|
|
806
647
|
}
|
|
807
|
-
|
|
648
|
+
interface TasksQueryResult extends QueryCursorResult {
|
|
808
649
|
items: Task[];
|
|
809
650
|
query: TasksQueryBuilder;
|
|
810
651
|
next: () => Promise<TasksQueryResult>;
|
|
811
652
|
prev: () => Promise<TasksQueryResult>;
|
|
812
653
|
}
|
|
813
|
-
|
|
654
|
+
interface TasksQueryBuilder {
|
|
814
655
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
815
656
|
* @param value - Value to compare against.
|
|
816
657
|
*/
|
|
@@ -847,25 +688,7 @@ export interface TasksQueryBuilder {
|
|
|
847
688
|
skipTo: (cursor: string) => TasksQueryBuilder;
|
|
848
689
|
find: () => Promise<TasksQueryResult>;
|
|
849
690
|
}
|
|
850
|
-
|
|
851
|
-
* Counts the number of tasks.
|
|
852
|
-
*
|
|
853
|
-
*
|
|
854
|
-
* This method returns the count of all tasks regardless of their `status`.
|
|
855
|
-
*
|
|
856
|
-
* Optionally, you can specify a filter to count only tasks that meet certain criteria.
|
|
857
|
-
* @public
|
|
858
|
-
* @param options - Filtering options.
|
|
859
|
-
* @permissionId CRM_TASKS.TASK_READ
|
|
860
|
-
* @permissionScope Read Tasks
|
|
861
|
-
* @permissionScopeId SCOPE.DC-CRM.READ-TASKS
|
|
862
|
-
* @permissionScope Manage Tasks
|
|
863
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
864
|
-
* @applicableIdentity APP
|
|
865
|
-
* @fqn wix.crm.tasks.v2.Tasks.CountTasks
|
|
866
|
-
*/
|
|
867
|
-
export declare function countTasks(options?: CountTasksOptions): Promise<CountTasksResponse & CountTasksResponseNonNullableFields>;
|
|
868
|
-
export interface CountTasksOptions {
|
|
691
|
+
interface CountTasksOptions {
|
|
869
692
|
/**
|
|
870
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)).
|
|
871
694
|
*
|
|
@@ -880,22 +703,7 @@ export interface CountTasksOptions {
|
|
|
880
703
|
*/
|
|
881
704
|
filter?: Record<string, any> | null;
|
|
882
705
|
}
|
|
883
|
-
|
|
884
|
-
* Moves a task specified by ID to be placed after another task in the task display.
|
|
885
|
-
*
|
|
886
|
-
* You can reposition a task to be first in the display by omitting `beforeTaskId`.
|
|
887
|
-
* @param taskId - ID of the task to move.
|
|
888
|
-
* @public
|
|
889
|
-
* @requiredField taskId
|
|
890
|
-
* @param options - Options for moving the task.
|
|
891
|
-
* @permissionId CRM_TASKS.TASK_UPDATE
|
|
892
|
-
* @permissionScope Manage Tasks
|
|
893
|
-
* @permissionScopeId SCOPE.DC-CRM.MANAGE-TASKS
|
|
894
|
-
* @applicableIdentity APP
|
|
895
|
-
* @fqn wix.crm.tasks.v2.Tasks.MoveTaskAfter
|
|
896
|
-
*/
|
|
897
|
-
export declare function moveTaskAfter(taskId: string, options?: MoveTaskAfterOptions): Promise<void>;
|
|
898
|
-
export interface MoveTaskAfterOptions {
|
|
706
|
+
interface MoveTaskAfterOptions {
|
|
899
707
|
/**
|
|
900
708
|
* The ID of the task after which the moved task is positioned in the task display.
|
|
901
709
|
* If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
|
|
@@ -903,4 +711,5 @@ export interface MoveTaskAfterOptions {
|
|
|
903
711
|
*/
|
|
904
712
|
beforeTaskId?: string | null;
|
|
905
713
|
}
|
|
906
|
-
|
|
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 };
|