@wix/crm 1.0.141 → 1.0.143

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.
@@ -2145,19 +2145,11 @@ interface ExtendedField$1 {
2145
2145
  displayName?: string;
2146
2146
  /**
2147
2147
  * Type of data the field holds.
2148
- *
2149
- * - `TEXT`: Accepts strings.
2150
- * - `NUMBER`: Accepts floats.
2151
- * - `DATE`: Accepts dates formatted as `YYYY-MM-DD`.
2152
- * - `URL`: Accepts strings. Prepends `https://` if no protocol is included.
2153
2148
  * @readonly
2154
2149
  */
2155
2150
  dataType?: FieldDataType$1;
2156
2151
  /**
2157
2152
  * Indicates whether the extended field is a system field or custom field.
2158
- *
2159
- * - `SYSTEM`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
2160
- * - `USER_DEFINED`: The field is a custom field and can be modified by 3rd-party apps or site contributors.
2161
2153
  * @readonly
2162
2154
  */
2163
2155
  fieldType?: FieldType$1;
@@ -2178,29 +2170,39 @@ interface ExtendedField$1 {
2178
2170
  description?: string | null;
2179
2171
  }
2180
2172
  declare enum FieldDataType$1 {
2173
+ /** Undefined data type. */
2181
2174
  UNKNOWN_DATA_TYPE = "UNKNOWN_DATA_TYPE",
2175
+ /** Accepts strings. */
2182
2176
  TEXT = "TEXT",
2177
+ /** Accepts floats. */
2183
2178
  NUMBER = "NUMBER",
2179
+ /** Accepts dates formatted as `YYYY-MM-DD`. */
2184
2180
  DATE = "DATE",
2181
+ /** Accepts strings. Prepends `https://` if no protocol is included. */
2185
2182
  URL = "URL"
2186
2183
  }
2187
2184
  declare enum FieldType$1 {
2185
+ /** Undefined field type. */
2188
2186
  UNKNOWN = "UNKNOWN",
2187
+ /** The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors. */
2189
2188
  SYSTEM = "SYSTEM",
2189
+ /** The field is a custom field and can be modified by 3rd-party apps or site contributors. */
2190
2190
  USER_DEFINED = "USER_DEFINED"
2191
2191
  }
2192
2192
  interface Sorting$5 {
2193
2193
  /** Name of the field to sort by. */
2194
2194
  fieldName?: string;
2195
2195
  /**
2196
- * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
2196
+ * Sort order.
2197
2197
  *
2198
- * Defaults to `ASC`.
2198
+ * Default: `ASC`.
2199
2199
  */
2200
2200
  order?: SortOrder$5;
2201
2201
  }
2202
2202
  declare enum SortOrder$5 {
2203
+ /** Sort by ascending order. */
2203
2204
  ASC = "ASC",
2205
+ /** Sort by descending order. */
2204
2206
  DESC = "DESC"
2205
2207
  }
2206
2208
  interface Paging$3 {
@@ -2415,29 +2417,39 @@ interface ExtendedField {
2415
2417
  description?: string | null;
2416
2418
  }
2417
2419
  declare enum FieldDataType {
2420
+ /** Undefined data type. */
2418
2421
  UNKNOWN_DATA_TYPE = "UNKNOWN_DATA_TYPE",
2422
+ /** Accepts strings. */
2419
2423
  TEXT = "TEXT",
2424
+ /** Accepts floats. */
2420
2425
  NUMBER = "NUMBER",
2426
+ /** Accepts dates formatted as `YYYY-MM-DD`. */
2421
2427
  DATE = "DATE",
2428
+ /** Accepts strings. Prepends `https://` if no protocol is included. */
2422
2429
  URL = "URL"
2423
2430
  }
2424
2431
  declare enum FieldType {
2432
+ /** Undefined field type. */
2425
2433
  UNKNOWN = "UNKNOWN",
2434
+ /** The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors. */
2426
2435
  SYSTEM = "SYSTEM",
2436
+ /** The field is a custom field and can be modified by 3rd-party apps or site contributors. */
2427
2437
  USER_DEFINED = "USER_DEFINED"
2428
2438
  }
2429
2439
  interface Sorting$4 {
2430
2440
  /** Name of the field to sort by. */
2431
2441
  fieldName?: string;
2432
2442
  /**
2433
- * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
2443
+ * Sort order.
2434
2444
  *
2435
- * Defaults to `ASC`.
2445
+ * Default: `ASC`.
2436
2446
  */
2437
2447
  order?: SortOrder$4;
2438
2448
  }
2439
2449
  declare enum SortOrder$4 {
2450
+ /** Sort by ascending order. */
2440
2451
  ASC = "ASC",
2452
+ /** Sort by descending order. */
2441
2453
  DESC = "DESC"
2442
2454
  }
2443
2455
  interface Paging$2 {
@@ -3717,8 +3729,11 @@ interface Task$1 {
3717
3729
  }
3718
3730
  /** Possible statuses in which the task may be. */
3719
3731
  declare enum TaskStatus$1 {
3732
+ /** Undefined task status. */
3720
3733
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
3734
+ /** Action needed. */
3721
3735
  ACTION_NEEDED = "ACTION_NEEDED",
3736
+ /** Task completed. */
3722
3737
  COMPLETED = "COMPLETED"
3723
3738
  }
3724
3739
  interface TaskSource$1 {
@@ -3740,8 +3755,11 @@ interface TaskSource$1 {
3740
3755
  }
3741
3756
  /** Possible sources that can create tasks. */
3742
3757
  declare enum SourceType$1 {
3758
+ /** Undefined source type. */
3743
3759
  UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
3760
+ /** Task was created by an app. */
3744
3761
  APP = "APP",
3762
+ /** Task was created by a user. */
3745
3763
  USER = "USER"
3746
3764
  }
3747
3765
  interface ContactInfo$1 {
@@ -3837,7 +3855,9 @@ interface Sorting$1 {
3837
3855
  order?: SortOrder$1;
3838
3856
  }
3839
3857
  declare enum SortOrder$1 {
3858
+ /** Sort by ascending order. */
3840
3859
  ASC = "ASC",
3860
+ /** Sort by descending order. */
3841
3861
  DESC = "DESC"
3842
3862
  }
3843
3863
  interface CursorPaging$1 {
@@ -3967,8 +3987,11 @@ interface Task {
3967
3987
  }
3968
3988
  /** Possible statuses in which the task may be. */
3969
3989
  declare enum TaskStatus {
3990
+ /** Undefined task status. */
3970
3991
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
3992
+ /** Action needed. */
3971
3993
  ACTION_NEEDED = "ACTION_NEEDED",
3994
+ /** Task completed. */
3972
3995
  COMPLETED = "COMPLETED"
3973
3996
  }
3974
3997
  interface TaskSource {
@@ -3990,8 +4013,11 @@ interface TaskSource {
3990
4013
  }
3991
4014
  /** Possible sources that can create tasks. */
3992
4015
  declare enum SourceType {
4016
+ /** Undefined source type. */
3993
4017
  UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
4018
+ /** Task was created by an app. */
3994
4019
  APP = "APP",
4020
+ /** Task was created by a user. */
3995
4021
  USER = "USER"
3996
4022
  }
3997
4023
  interface ContactInfo {
@@ -4087,7 +4113,9 @@ interface Sorting {
4087
4113
  order?: SortOrder;
4088
4114
  }
4089
4115
  declare enum SortOrder {
4116
+ /** Sort by ascending order. */
4090
4117
  ASC = "ASC",
4118
+ /** Sort by descending order. */
4091
4119
  DESC = "DESC"
4092
4120
  }
4093
4121
  interface CursorPaging {