@wix/crm 1.0.163 → 1.0.165

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/crm",
3
- "version": "1.0.163",
3
+ "version": "1.0.165",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -21,12 +21,12 @@
21
21
  "type-bundles"
22
22
  ],
23
23
  "dependencies": {
24
- "@wix/crm_attachments": "1.0.23",
24
+ "@wix/crm_attachments": "1.0.24",
25
25
  "@wix/crm_contacts": "1.0.70",
26
26
  "@wix/crm_extended-fields": "1.0.49",
27
27
  "@wix/crm_labels": "1.0.48",
28
28
  "@wix/crm_submitted-contact": "1.0.44",
29
- "@wix/crm_tasks": "1.0.51"
29
+ "@wix/crm_tasks": "1.0.52"
30
30
  },
31
31
  "devDependencies": {
32
32
  "glob": "^10.4.1",
@@ -51,5 +51,5 @@
51
51
  "fqdn": ""
52
52
  }
53
53
  },
54
- "falconPackageHash": "fba1ab41e61ba3fdc27ad168a23e23f1043c5081734405d05d2519a2"
54
+ "falconPackageHash": "ae6707aa15dcd0efebcfd98e4920d7e74c0ccfc68a7c0fdde6a44cc7"
55
55
  }
@@ -703,7 +703,7 @@ interface Paging$4 {
703
703
  offset?: number | null;
704
704
  }
705
705
  interface ListAttachmentsResponse {
706
- /** Liss of attachments for the specified contact. */
706
+ /** List of attachments for the specified contact. */
707
707
  attachments?: ContactAttachment[];
708
708
  /** Metadata for the paginated results. */
709
709
  metadata?: PagingMetadata$3;
@@ -5451,7 +5451,7 @@ interface TaskSource {
5451
5451
  */
5452
5452
  appId?: string | null;
5453
5453
  /**
5454
- * User ID, if the task was created by a user.
5454
+ * User ID, if the task was created by a Wix user.
5455
5455
  * @readonly
5456
5456
  */
5457
5457
  userId?: string | null;
@@ -5460,7 +5460,7 @@ interface TaskSource {
5460
5460
  declare enum SourceType {
5461
5461
  /** Task was created by an app. */
5462
5462
  APP = "APP",
5463
- /** Task was created by a user. */
5463
+ /** Task was created by a Wix user. */
5464
5464
  USER = "USER"
5465
5465
  }
5466
5466
  interface ContactInfo {
@@ -5477,7 +5477,7 @@ interface ContactInfo {
5477
5477
  */
5478
5478
  lastName?: string | null;
5479
5479
  /**
5480
- * Contact's image url.
5480
+ * Contact's image URL.
5481
5481
  * @readonly
5482
5482
  */
5483
5483
  imageUrl?: string | null;
@@ -5652,7 +5652,7 @@ interface CountTasksRequest {
5652
5652
  filter?: Record<string, any> | null;
5653
5653
  }
5654
5654
  interface CountTasksResponse {
5655
- /** The number of tasks that match the provided filter. */
5655
+ /** The number of tasks that match the specified filter. */
5656
5656
  count?: number;
5657
5657
  }
5658
5658
  interface QueryTasksInternalRequest {
@@ -5697,7 +5697,7 @@ interface Paging {
5697
5697
  offset?: number | null;
5698
5698
  }
5699
5699
  interface QueryTasksInternalResponse {
5700
- /** The retrieved Tasks */
5700
+ /** The retrieved tasks. */
5701
5701
  tasks?: Task[];
5702
5702
  /** Details on the paged set of results returned. */
5703
5703
  pagingMetadata?: PagingMetadataV2;
@@ -5715,11 +5715,11 @@ interface PagingMetadataV2 {
5715
5715
  cursors?: Cursors;
5716
5716
  }
5717
5717
  interface MoveTaskAfterRequest {
5718
- /** The task ID to move. */
5718
+ /** ID of the task to move. */
5719
5719
  taskId: string;
5720
5720
  /**
5721
- * The task ID after which the moved task is positioned in the display.
5722
- * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
5721
+ * The ID of the task after which the moved task is positioned in the task display.
5722
+ * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
5723
5723
  */
5724
5724
  beforeTaskId?: string | null;
5725
5725
  }
@@ -6028,8 +6028,8 @@ interface CountTasksOptions {
6028
6028
  }
6029
6029
  interface MoveTaskAfterOptions {
6030
6030
  /**
6031
- * The task ID after which the moved task is positioned in the display.
6032
- * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
6031
+ * The ID of the task after which the moved task is positioned in the task display.
6032
+ * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
6033
6033
  */
6034
6034
  beforeTaskId?: string | null;
6035
6035
  }
@@ -6109,10 +6109,9 @@ interface CountTasksSignature {
6109
6109
  * Counts the number of tasks.
6110
6110
  *
6111
6111
  *
6112
- * This endpoint returns the count of all tasks regardless of the task `status`.
6112
+ * This method returns the count of all tasks regardless of their `status`.
6113
6113
  *
6114
- * Optionally, you can pass a filter to count only tasks based
6115
- * on specified criteria.
6114
+ * Optionally, you can specify a filter to count only tasks that meet certain criteria.
6116
6115
  * @param - Filtering options.
6117
6116
  */
6118
6117
  (options?: CountTasksOptions | undefined): Promise<CountTasksResponse & CountTasksResponseNonNullableFields>;
@@ -6120,10 +6119,10 @@ interface CountTasksSignature {
6120
6119
  declare function moveTaskAfter$1(httpClient: HttpClient): MoveTaskAfterSignature;
6121
6120
  interface MoveTaskAfterSignature {
6122
6121
  /**
6123
- * Moves a task specified by ID to be placed after another task in the display.
6122
+ * Moves a task specified by ID to be placed after another task in the task display.
6124
6123
  *
6125
- * You can reposition a task to be first in the display by ommitting `beforeTaskId`.
6126
- * @param - The task ID to move.
6124
+ * You can reposition a task to be first in the display by omitting `beforeTaskId`.
6125
+ * @param - ID of the task to move.
6127
6126
  * @param - Options for moving the task.
6128
6127
  */
6129
6128
  (taskId: string, options?: MoveTaskAfterOptions | undefined): Promise<void>;
@@ -703,7 +703,7 @@ interface Paging$4 {
703
703
  offset?: number | null;
704
704
  }
705
705
  interface ListAttachmentsResponse {
706
- /** Liss of attachments for the specified contact. */
706
+ /** List of attachments for the specified contact. */
707
707
  attachments?: ContactAttachment[];
708
708
  /** Metadata for the paginated results. */
709
709
  metadata?: PagingMetadata$3;
@@ -5451,7 +5451,7 @@ interface TaskSource {
5451
5451
  */
5452
5452
  appId?: string | null;
5453
5453
  /**
5454
- * User ID, if the task was created by a user.
5454
+ * User ID, if the task was created by a Wix user.
5455
5455
  * @readonly
5456
5456
  */
5457
5457
  userId?: string | null;
@@ -5460,7 +5460,7 @@ interface TaskSource {
5460
5460
  declare enum SourceType {
5461
5461
  /** Task was created by an app. */
5462
5462
  APP = "APP",
5463
- /** Task was created by a user. */
5463
+ /** Task was created by a Wix user. */
5464
5464
  USER = "USER"
5465
5465
  }
5466
5466
  interface ContactInfo {
@@ -5477,7 +5477,7 @@ interface ContactInfo {
5477
5477
  */
5478
5478
  lastName?: string | null;
5479
5479
  /**
5480
- * Contact's image url.
5480
+ * Contact's image URL.
5481
5481
  * @readonly
5482
5482
  */
5483
5483
  imageUrl?: string | null;
@@ -5652,7 +5652,7 @@ interface CountTasksRequest {
5652
5652
  filter?: Record<string, any> | null;
5653
5653
  }
5654
5654
  interface CountTasksResponse {
5655
- /** The number of tasks that match the provided filter. */
5655
+ /** The number of tasks that match the specified filter. */
5656
5656
  count?: number;
5657
5657
  }
5658
5658
  interface QueryTasksInternalRequest {
@@ -5697,7 +5697,7 @@ interface Paging {
5697
5697
  offset?: number | null;
5698
5698
  }
5699
5699
  interface QueryTasksInternalResponse {
5700
- /** The retrieved Tasks */
5700
+ /** The retrieved tasks. */
5701
5701
  tasks?: Task[];
5702
5702
  /** Details on the paged set of results returned. */
5703
5703
  pagingMetadata?: PagingMetadataV2;
@@ -5715,11 +5715,11 @@ interface PagingMetadataV2 {
5715
5715
  cursors?: Cursors;
5716
5716
  }
5717
5717
  interface MoveTaskAfterRequest {
5718
- /** The task ID to move. */
5718
+ /** ID of the task to move. */
5719
5719
  taskId: string;
5720
5720
  /**
5721
- * The task ID after which the moved task is positioned in the display.
5722
- * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
5721
+ * The ID of the task after which the moved task is positioned in the task display.
5722
+ * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
5723
5723
  */
5724
5724
  beforeTaskId?: string | null;
5725
5725
  }
@@ -6028,8 +6028,8 @@ interface CountTasksOptions {
6028
6028
  }
6029
6029
  interface MoveTaskAfterOptions {
6030
6030
  /**
6031
- * The task ID after which the moved task is positioned in the display.
6032
- * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
6031
+ * The ID of the task after which the moved task is positioned in the task display.
6032
+ * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
6033
6033
  */
6034
6034
  beforeTaskId?: string | null;
6035
6035
  }
@@ -6109,10 +6109,9 @@ interface CountTasksSignature {
6109
6109
  * Counts the number of tasks.
6110
6110
  *
6111
6111
  *
6112
- * This endpoint returns the count of all tasks regardless of the task `status`.
6112
+ * This method returns the count of all tasks regardless of their `status`.
6113
6113
  *
6114
- * Optionally, you can pass a filter to count only tasks based
6115
- * on specified criteria.
6114
+ * Optionally, you can specify a filter to count only tasks that meet certain criteria.
6116
6115
  * @param - Filtering options.
6117
6116
  */
6118
6117
  (options?: CountTasksOptions | undefined): Promise<CountTasksResponse & CountTasksResponseNonNullableFields>;
@@ -6120,10 +6119,10 @@ interface CountTasksSignature {
6120
6119
  declare function moveTaskAfter$1(httpClient: HttpClient): MoveTaskAfterSignature;
6121
6120
  interface MoveTaskAfterSignature {
6122
6121
  /**
6123
- * Moves a task specified by ID to be placed after another task in the display.
6122
+ * Moves a task specified by ID to be placed after another task in the task display.
6124
6123
  *
6125
- * You can reposition a task to be first in the display by ommitting `beforeTaskId`.
6126
- * @param - The task ID to move.
6124
+ * You can reposition a task to be first in the display by omitting `beforeTaskId`.
6125
+ * @param - ID of the task to move.
6127
6126
  * @param - Options for moving the task.
6128
6127
  */
6129
6128
  (taskId: string, options?: MoveTaskAfterOptions | undefined): Promise<void>;
@@ -113,7 +113,7 @@ interface Paging$7 {
113
113
  offset?: number | null;
114
114
  }
115
115
  interface ListAttachmentsResponse$1 {
116
- /** Liss of attachments for the specified contact. */
116
+ /** List of attachments for the specified contact. */
117
117
  attachments?: ContactAttachment$1[];
118
118
  /** Metadata for the paginated results. */
119
119
  metadata?: PagingMetadata$7;
@@ -258,7 +258,7 @@ interface Paging$6 {
258
258
  offset?: number | null;
259
259
  }
260
260
  interface ListAttachmentsResponse {
261
- /** Liss of attachments for the specified contact. */
261
+ /** List of attachments for the specified contact. */
262
262
  attachments?: ContactAttachment[];
263
263
  /** Metadata for the paginated results. */
264
264
  metadata?: PagingMetadata$6;
@@ -3676,7 +3676,7 @@ interface TaskSource$1 {
3676
3676
  */
3677
3677
  appId?: string | null;
3678
3678
  /**
3679
- * User ID, if the task was created by a user.
3679
+ * User ID, if the task was created by a Wix user.
3680
3680
  * @readonly
3681
3681
  */
3682
3682
  userId?: string | null;
@@ -3685,7 +3685,7 @@ interface TaskSource$1 {
3685
3685
  declare enum SourceType$1 {
3686
3686
  /** Task was created by an app. */
3687
3687
  APP = "APP",
3688
- /** Task was created by a user. */
3688
+ /** Task was created by a Wix user. */
3689
3689
  USER = "USER"
3690
3690
  }
3691
3691
  interface ContactInfo$1 {
@@ -3702,7 +3702,7 @@ interface ContactInfo$1 {
3702
3702
  */
3703
3703
  lastName?: string | null;
3704
3704
  /**
3705
- * Contact's image url.
3705
+ * Contact's image URL.
3706
3706
  * @readonly
3707
3707
  */
3708
3708
  imageUrl?: string | null;
@@ -3824,27 +3824,29 @@ interface Cursors$1 {
3824
3824
  }
3825
3825
  interface CountTasksRequest$1 {
3826
3826
  /**
3827
- * Filter tasks to count. See [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/filter-and-sort) for supported filters.
3827
+ * 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)).
3828
3828
  *
3829
3829
  * Filter tasks in the following format:
3830
+ *
3830
3831
  * `"filter" : {
3831
3832
  * "fieldName1": "value1",
3832
3833
  * "fieldName2":{"$operator":"value2"}
3833
3834
  * }`
3835
+ *
3834
3836
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3835
3837
  */
3836
3838
  filter?: Record<string, any> | null;
3837
3839
  }
3838
3840
  interface CountTasksResponse$1 {
3839
- /** The number of tasks that match the provided filter. */
3841
+ /** The number of tasks that match the specified filter. */
3840
3842
  count?: number;
3841
3843
  }
3842
3844
  interface MoveTaskAfterRequest$1 {
3843
- /** The task ID to move. */
3845
+ /** ID of the task to move. */
3844
3846
  taskId: string;
3845
3847
  /**
3846
- * The task ID after which the moved task is positioned in the display.
3847
- * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
3848
+ * The ID of the task after which the moved task is positioned in the task display.
3849
+ * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
3848
3850
  */
3849
3851
  beforeTaskId?: string | null;
3850
3852
  }
@@ -3930,7 +3932,7 @@ interface TaskSource {
3930
3932
  */
3931
3933
  appId?: string | null;
3932
3934
  /**
3933
- * User ID, if the task was created by a user.
3935
+ * User ID, if the task was created by a Wix user.
3934
3936
  * @readonly
3935
3937
  */
3936
3938
  userId?: string | null;
@@ -3939,7 +3941,7 @@ interface TaskSource {
3939
3941
  declare enum SourceType {
3940
3942
  /** Task was created by an app. */
3941
3943
  APP = "APP",
3942
- /** Task was created by a user. */
3944
+ /** Task was created by a Wix user. */
3943
3945
  USER = "USER"
3944
3946
  }
3945
3947
  interface ContactInfo {
@@ -3956,7 +3958,7 @@ interface ContactInfo {
3956
3958
  */
3957
3959
  lastName?: string | null;
3958
3960
  /**
3959
- * Contact's image url.
3961
+ * Contact's image URL.
3960
3962
  * @readonly
3961
3963
  */
3962
3964
  imageUrl?: string | null;
@@ -4091,15 +4093,15 @@ interface CountTasksRequest {
4091
4093
  filter?: Record<string, any> | null;
4092
4094
  }
4093
4095
  interface CountTasksResponse {
4094
- /** The number of tasks that match the provided filter. */
4096
+ /** The number of tasks that match the specified filter. */
4095
4097
  count?: number;
4096
4098
  }
4097
4099
  interface MoveTaskAfterRequest {
4098
- /** The task ID to move. */
4100
+ /** ID of the task to move. */
4099
4101
  taskId: string;
4100
4102
  /**
4101
- * The task ID after which the moved task is positioned in the display.
4102
- * If `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.
4103
+ * The ID of the task after which the moved task is positioned in the task display.
4104
+ * If `beforeTaskId` is not specified, the moved task is positioned first in the task display.
4103
4105
  */
4104
4106
  beforeTaskId?: string | null;
4105
4107
  }