@wix/crm 1.0.85 → 1.0.87

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.
Files changed (229) hide show
  1. package/build/cjs/context.d.ts +5 -5
  2. package/build/cjs/context.js +5 -5
  3. package/build/cjs/context.js.map +1 -1
  4. package/build/cjs/index.d.ts +5 -5
  5. package/build/cjs/index.js +5 -5
  6. package/build/cjs/index.js.map +1 -1
  7. package/build/cjs/meta.d.ts +5 -5
  8. package/build/cjs/meta.js +5 -5
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/context.d.ts +5 -5
  11. package/build/es/context.js +5 -5
  12. package/build/es/context.js.map +1 -1
  13. package/build/es/index.d.ts +5 -5
  14. package/build/es/index.js +5 -5
  15. package/build/es/index.js.map +1 -1
  16. package/build/es/meta.d.ts +5 -5
  17. package/build/es/meta.js +5 -5
  18. package/build/es/meta.js.map +1 -1
  19. package/package.json +15 -9
  20. package/build/cjs/index.typings.d.ts +0 -5
  21. package/build/cjs/index.typings.js +0 -32
  22. package/build/cjs/index.typings.js.map +0 -1
  23. package/build/cjs/src/contacts-v4-contact.context.d.ts +0 -9
  24. package/build/cjs/src/contacts-v4-contact.context.js +0 -124
  25. package/build/cjs/src/contacts-v4-contact.context.js.map +0 -1
  26. package/build/cjs/src/contacts-v4-contact.http.d.ts +0 -94
  27. package/build/cjs/src/contacts-v4-contact.http.js +0 -485
  28. package/build/cjs/src/contacts-v4-contact.http.js.map +0 -1
  29. package/build/cjs/src/contacts-v4-contact.meta.d.ts +0 -31
  30. package/build/cjs/src/contacts-v4-contact.meta.js +0 -161
  31. package/build/cjs/src/contacts-v4-contact.meta.js.map +0 -1
  32. package/build/cjs/src/contacts-v4-contact.public.d.ts +0 -49
  33. package/build/cjs/src/contacts-v4-contact.public.js +0 -76
  34. package/build/cjs/src/contacts-v4-contact.public.js.map +0 -1
  35. package/build/cjs/src/contacts-v4-contact.types.d.ts +0 -2199
  36. package/build/cjs/src/contacts-v4-contact.types.js +0 -270
  37. package/build/cjs/src/contacts-v4-contact.types.js.map +0 -1
  38. package/build/cjs/src/contacts-v4-contact.universal.d.ts +0 -2069
  39. package/build/cjs/src/contacts-v4-contact.universal.js +0 -930
  40. package/build/cjs/src/contacts-v4-contact.universal.js.map +0 -1
  41. package/build/cjs/src/contacts-v4-extended-field.context.d.ts +0 -7
  42. package/build/cjs/src/contacts-v4-extended-field.context.js +0 -90
  43. package/build/cjs/src/contacts-v4-extended-field.context.js.map +0 -1
  44. package/build/cjs/src/contacts-v4-extended-field.http.d.ts +0 -52
  45. package/build/cjs/src/contacts-v4-extended-field.http.js +0 -234
  46. package/build/cjs/src/contacts-v4-extended-field.http.js.map +0 -1
  47. package/build/cjs/src/contacts-v4-extended-field.meta.d.ts +0 -23
  48. package/build/cjs/src/contacts-v4-extended-field.meta.js +0 -123
  49. package/build/cjs/src/contacts-v4-extended-field.meta.js.map +0 -1
  50. package/build/cjs/src/contacts-v4-extended-field.public.d.ts +0 -23
  51. package/build/cjs/src/contacts-v4-extended-field.public.js +0 -44
  52. package/build/cjs/src/contacts-v4-extended-field.public.js.map +0 -1
  53. package/build/cjs/src/contacts-v4-extended-field.types.d.ts +0 -357
  54. package/build/cjs/src/contacts-v4-extended-field.types.js +0 -23
  55. package/build/cjs/src/contacts-v4-extended-field.types.js.map +0 -1
  56. package/build/cjs/src/contacts-v4-extended-field.universal.d.ts +0 -623
  57. package/build/cjs/src/contacts-v4-extended-field.universal.js +0 -434
  58. package/build/cjs/src/contacts-v4-extended-field.universal.js.map +0 -1
  59. package/build/cjs/src/contacts-v4-label.context.d.ts +0 -7
  60. package/build/cjs/src/contacts-v4-label.context.js +0 -90
  61. package/build/cjs/src/contacts-v4-label.context.js.map +0 -1
  62. package/build/cjs/src/contacts-v4-label.http.d.ts +0 -53
  63. package/build/cjs/src/contacts-v4-label.http.js +0 -235
  64. package/build/cjs/src/contacts-v4-label.http.js.map +0 -1
  65. package/build/cjs/src/contacts-v4-label.meta.d.ts +0 -23
  66. package/build/cjs/src/contacts-v4-label.meta.js +0 -123
  67. package/build/cjs/src/contacts-v4-label.meta.js.map +0 -1
  68. package/build/cjs/src/contacts-v4-label.public.d.ts +0 -21
  69. package/build/cjs/src/contacts-v4-label.public.js +0 -43
  70. package/build/cjs/src/contacts-v4-label.public.js.map +0 -1
  71. package/build/cjs/src/contacts-v4-label.types.d.ts +0 -349
  72. package/build/cjs/src/contacts-v4-label.types.js +0 -17
  73. package/build/cjs/src/contacts-v4-label.types.js.map +0 -1
  74. package/build/cjs/src/contacts-v4-label.universal.d.ts +0 -627
  75. package/build/cjs/src/contacts-v4-label.universal.js +0 -428
  76. package/build/cjs/src/contacts-v4-label.universal.js.map +0 -1
  77. package/build/cjs/src/contacts-v4-submit-contact.context.d.ts +0 -3
  78. package/build/cjs/src/contacts-v4-submit-contact.context.js +0 -22
  79. package/build/cjs/src/contacts-v4-submit-contact.context.js.map +0 -1
  80. package/build/cjs/src/contacts-v4-submit-contact.http.d.ts +0 -8
  81. package/build/cjs/src/contacts-v4-submit-contact.http.js +0 -90
  82. package/build/cjs/src/contacts-v4-submit-contact.http.js.map +0 -1
  83. package/build/cjs/src/contacts-v4-submit-contact.meta.d.ts +0 -13
  84. package/build/cjs/src/contacts-v4-submit-contact.meta.js +0 -47
  85. package/build/cjs/src/contacts-v4-submit-contact.meta.js.map +0 -1
  86. package/build/cjs/src/contacts-v4-submit-contact.public.d.ts +0 -8
  87. package/build/cjs/src/contacts-v4-submit-contact.public.js +0 -22
  88. package/build/cjs/src/contacts-v4-submit-contact.public.js.map +0 -1
  89. package/build/cjs/src/contacts-v4-submit-contact.types.d.ts +0 -541
  90. package/build/cjs/src/contacts-v4-submit-contact.types.js +0 -174
  91. package/build/cjs/src/contacts-v4-submit-contact.types.js.map +0 -1
  92. package/build/cjs/src/contacts-v4-submit-contact.universal.d.ts +0 -555
  93. package/build/cjs/src/contacts-v4-submit-contact.universal.js +0 -288
  94. package/build/cjs/src/contacts-v4-submit-contact.universal.js.map +0 -1
  95. package/build/cjs/src/crm-tasks-v2-task.context.d.ts +0 -9
  96. package/build/cjs/src/crm-tasks-v2-task.context.js +0 -124
  97. package/build/cjs/src/crm-tasks-v2-task.context.js.map +0 -1
  98. package/build/cjs/src/crm-tasks-v2-task.http.d.ts +0 -59
  99. package/build/cjs/src/crm-tasks-v2-task.http.js +0 -268
  100. package/build/cjs/src/crm-tasks-v2-task.http.js.map +0 -1
  101. package/build/cjs/src/crm-tasks-v2-task.meta.d.ts +0 -27
  102. package/build/cjs/src/crm-tasks-v2-task.meta.js +0 -161
  103. package/build/cjs/src/crm-tasks-v2-task.meta.js.map +0 -1
  104. package/build/cjs/src/crm-tasks-v2-task.public.d.ts +0 -30
  105. package/build/cjs/src/crm-tasks-v2-task.public.js +0 -58
  106. package/build/cjs/src/crm-tasks-v2-task.public.js.map +0 -1
  107. package/build/cjs/src/crm-tasks-v2-task.types.d.ts +0 -430
  108. package/build/cjs/src/crm-tasks-v2-task.types.js +0 -29
  109. package/build/cjs/src/crm-tasks-v2-task.types.js.map +0 -1
  110. package/build/cjs/src/crm-tasks-v2-task.universal.d.ts +0 -678
  111. package/build/cjs/src/crm-tasks-v2-task.universal.js +0 -520
  112. package/build/cjs/src/crm-tasks-v2-task.universal.js.map +0 -1
  113. package/build/cjs/src/ping-notifications-v3-notification.http.d.ts +0 -15
  114. package/build/cjs/src/ping-notifications-v3-notification.http.js +0 -87
  115. package/build/cjs/src/ping-notifications-v3-notification.http.js.map +0 -1
  116. package/build/cjs/src/ping-notifications-v3-notification.public.d.ts +0 -8
  117. package/build/cjs/src/ping-notifications-v3-notification.public.js +0 -14
  118. package/build/cjs/src/ping-notifications-v3-notification.public.js.map +0 -1
  119. package/build/cjs/src/ping-notifications-v3-notification.types.d.ts +0 -113
  120. package/build/cjs/src/ping-notifications-v3-notification.types.js +0 -15
  121. package/build/cjs/src/ping-notifications-v3-notification.types.js.map +0 -1
  122. package/build/cjs/src/ping-notifications-v3-notification.universal.d.ts +0 -146
  123. package/build/cjs/src/ping-notifications-v3-notification.universal.js +0 -136
  124. package/build/cjs/src/ping-notifications-v3-notification.universal.js.map +0 -1
  125. package/build/es/index.typings.d.ts +0 -5
  126. package/build/es/index.typings.js +0 -6
  127. package/build/es/index.typings.js.map +0 -1
  128. package/build/es/src/contacts-v4-contact.context.d.ts +0 -9
  129. package/build/es/src/contacts-v4-contact.context.js +0 -114
  130. package/build/es/src/contacts-v4-contact.context.js.map +0 -1
  131. package/build/es/src/contacts-v4-contact.http.d.ts +0 -94
  132. package/build/es/src/contacts-v4-contact.http.js +0 -475
  133. package/build/es/src/contacts-v4-contact.http.js.map +0 -1
  134. package/build/es/src/contacts-v4-contact.meta.d.ts +0 -31
  135. package/build/es/src/contacts-v4-contact.meta.js +0 -128
  136. package/build/es/src/contacts-v4-contact.meta.js.map +0 -1
  137. package/build/es/src/contacts-v4-contact.public.d.ts +0 -49
  138. package/build/es/src/contacts-v4-contact.public.js +0 -40
  139. package/build/es/src/contacts-v4-contact.public.js.map +0 -1
  140. package/build/es/src/contacts-v4-contact.types.d.ts +0 -2199
  141. package/build/es/src/contacts-v4-contact.types.js +0 -267
  142. package/build/es/src/contacts-v4-contact.types.js.map +0 -1
  143. package/build/es/src/contacts-v4-contact.universal.d.ts +0 -2069
  144. package/build/es/src/contacts-v4-contact.universal.js +0 -897
  145. package/build/es/src/contacts-v4-contact.universal.js.map +0 -1
  146. package/build/es/src/contacts-v4-extended-field.context.d.ts +0 -7
  147. package/build/es/src/contacts-v4-extended-field.context.js +0 -82
  148. package/build/es/src/contacts-v4-extended-field.context.js.map +0 -1
  149. package/build/es/src/contacts-v4-extended-field.http.d.ts +0 -52
  150. package/build/es/src/contacts-v4-extended-field.http.js +0 -226
  151. package/build/es/src/contacts-v4-extended-field.http.js.map +0 -1
  152. package/build/es/src/contacts-v4-extended-field.meta.d.ts +0 -23
  153. package/build/es/src/contacts-v4-extended-field.meta.js +0 -92
  154. package/build/es/src/contacts-v4-extended-field.meta.js.map +0 -1
  155. package/build/es/src/contacts-v4-extended-field.public.d.ts +0 -23
  156. package/build/es/src/contacts-v4-extended-field.public.js +0 -30
  157. package/build/es/src/contacts-v4-extended-field.public.js.map +0 -1
  158. package/build/es/src/contacts-v4-extended-field.types.d.ts +0 -357
  159. package/build/es/src/contacts-v4-extended-field.types.js +0 -20
  160. package/build/es/src/contacts-v4-extended-field.types.js.map +0 -1
  161. package/build/es/src/contacts-v4-extended-field.universal.d.ts +0 -623
  162. package/build/es/src/contacts-v4-extended-field.universal.js +0 -403
  163. package/build/es/src/contacts-v4-extended-field.universal.js.map +0 -1
  164. package/build/es/src/contacts-v4-label.context.d.ts +0 -7
  165. package/build/es/src/contacts-v4-label.context.js +0 -82
  166. package/build/es/src/contacts-v4-label.context.js.map +0 -1
  167. package/build/es/src/contacts-v4-label.http.d.ts +0 -53
  168. package/build/es/src/contacts-v4-label.http.js +0 -227
  169. package/build/es/src/contacts-v4-label.http.js.map +0 -1
  170. package/build/es/src/contacts-v4-label.meta.d.ts +0 -23
  171. package/build/es/src/contacts-v4-label.meta.js +0 -92
  172. package/build/es/src/contacts-v4-label.meta.js.map +0 -1
  173. package/build/es/src/contacts-v4-label.public.d.ts +0 -21
  174. package/build/es/src/contacts-v4-label.public.js +0 -30
  175. package/build/es/src/contacts-v4-label.public.js.map +0 -1
  176. package/build/es/src/contacts-v4-label.types.d.ts +0 -349
  177. package/build/es/src/contacts-v4-label.types.js +0 -14
  178. package/build/es/src/contacts-v4-label.types.js.map +0 -1
  179. package/build/es/src/contacts-v4-label.universal.d.ts +0 -627
  180. package/build/es/src/contacts-v4-label.universal.js +0 -397
  181. package/build/es/src/contacts-v4-label.universal.js.map +0 -1
  182. package/build/es/src/contacts-v4-submit-contact.context.d.ts +0 -3
  183. package/build/es/src/contacts-v4-submit-contact.context.js +0 -18
  184. package/build/es/src/contacts-v4-submit-contact.context.js.map +0 -1
  185. package/build/es/src/contacts-v4-submit-contact.http.d.ts +0 -8
  186. package/build/es/src/contacts-v4-submit-contact.http.js +0 -86
  187. package/build/es/src/contacts-v4-submit-contact.http.js.map +0 -1
  188. package/build/es/src/contacts-v4-submit-contact.meta.d.ts +0 -13
  189. package/build/es/src/contacts-v4-submit-contact.meta.js +0 -20
  190. package/build/es/src/contacts-v4-submit-contact.meta.js.map +0 -1
  191. package/build/es/src/contacts-v4-submit-contact.public.d.ts +0 -8
  192. package/build/es/src/contacts-v4-submit-contact.public.js +0 -9
  193. package/build/es/src/contacts-v4-submit-contact.public.js.map +0 -1
  194. package/build/es/src/contacts-v4-submit-contact.types.d.ts +0 -541
  195. package/build/es/src/contacts-v4-submit-contact.types.js +0 -171
  196. package/build/es/src/contacts-v4-submit-contact.types.js.map +0 -1
  197. package/build/es/src/contacts-v4-submit-contact.universal.d.ts +0 -555
  198. package/build/es/src/contacts-v4-submit-contact.universal.js +0 -261
  199. package/build/es/src/contacts-v4-submit-contact.universal.js.map +0 -1
  200. package/build/es/src/crm-tasks-v2-task.context.d.ts +0 -9
  201. package/build/es/src/crm-tasks-v2-task.context.js +0 -114
  202. package/build/es/src/crm-tasks-v2-task.context.js.map +0 -1
  203. package/build/es/src/crm-tasks-v2-task.http.d.ts +0 -59
  204. package/build/es/src/crm-tasks-v2-task.http.js +0 -258
  205. package/build/es/src/crm-tasks-v2-task.http.js.map +0 -1
  206. package/build/es/src/crm-tasks-v2-task.meta.d.ts +0 -27
  207. package/build/es/src/crm-tasks-v2-task.meta.js +0 -128
  208. package/build/es/src/crm-tasks-v2-task.meta.js.map +0 -1
  209. package/build/es/src/crm-tasks-v2-task.public.d.ts +0 -30
  210. package/build/es/src/crm-tasks-v2-task.public.js +0 -40
  211. package/build/es/src/crm-tasks-v2-task.public.js.map +0 -1
  212. package/build/es/src/crm-tasks-v2-task.types.d.ts +0 -430
  213. package/build/es/src/crm-tasks-v2-task.types.js +0 -26
  214. package/build/es/src/crm-tasks-v2-task.types.js.map +0 -1
  215. package/build/es/src/crm-tasks-v2-task.universal.d.ts +0 -678
  216. package/build/es/src/crm-tasks-v2-task.universal.js +0 -487
  217. package/build/es/src/crm-tasks-v2-task.universal.js.map +0 -1
  218. package/build/es/src/ping-notifications-v3-notification.http.d.ts +0 -15
  219. package/build/es/src/ping-notifications-v3-notification.http.js +0 -83
  220. package/build/es/src/ping-notifications-v3-notification.http.js.map +0 -1
  221. package/build/es/src/ping-notifications-v3-notification.public.d.ts +0 -8
  222. package/build/es/src/ping-notifications-v3-notification.public.js +0 -9
  223. package/build/es/src/ping-notifications-v3-notification.public.js.map +0 -1
  224. package/build/es/src/ping-notifications-v3-notification.types.d.ts +0 -113
  225. package/build/es/src/ping-notifications-v3-notification.types.js +0 -12
  226. package/build/es/src/ping-notifications-v3-notification.types.js.map +0 -1
  227. package/build/es/src/ping-notifications-v3-notification.universal.d.ts +0 -146
  228. package/build/es/src/ping-notifications-v3-notification.universal.js +0 -109
  229. package/build/es/src/ping-notifications-v3-notification.universal.js.map +0 -1
@@ -1,44 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.onExtendedFieldDeleted = exports.onExtendedFieldUpdated = exports.onExtendedFieldCreated = exports.SortOrder = exports.FieldType = exports.FieldDataType = exports.queryExtendedFields = exports.deleteExtendedField = exports.renameExtendedField = exports.getExtendedField = exports.findOrCreateExtendedField = exports.__metadata = void 0;
4
- const contacts_v4_extended_field_universal_1 = require("./contacts-v4-extended-field.universal");
5
- exports.__metadata = { PACKAGE_NAME: '@wix/crm' };
6
- function findOrCreateExtendedField(httpClient) {
7
- return (displayName, dataType) => (0, contacts_v4_extended_field_universal_1.findOrCreateExtendedField)(displayName, dataType,
8
- // @ts-ignore
9
- { httpClient });
10
- }
11
- exports.findOrCreateExtendedField = findOrCreateExtendedField;
12
- function getExtendedField(httpClient) {
13
- return (key) => (0, contacts_v4_extended_field_universal_1.getExtendedField)(key,
14
- // @ts-ignore
15
- { httpClient });
16
- }
17
- exports.getExtendedField = getExtendedField;
18
- function renameExtendedField(httpClient) {
19
- return (key, field) => (0, contacts_v4_extended_field_universal_1.renameExtendedField)(key, field,
20
- // @ts-ignore
21
- { httpClient });
22
- }
23
- exports.renameExtendedField = renameExtendedField;
24
- function deleteExtendedField(httpClient) {
25
- return (key) => (0, contacts_v4_extended_field_universal_1.deleteExtendedField)(key,
26
- // @ts-ignore
27
- { httpClient });
28
- }
29
- exports.deleteExtendedField = deleteExtendedField;
30
- function queryExtendedFields(httpClient) {
31
- return () => (0, contacts_v4_extended_field_universal_1.queryExtendedFields)(
32
- // @ts-ignore
33
- { httpClient });
34
- }
35
- exports.queryExtendedFields = queryExtendedFields;
36
- var contacts_v4_extended_field_universal_2 = require("./contacts-v4-extended-field.universal");
37
- Object.defineProperty(exports, "FieldDataType", { enumerable: true, get: function () { return contacts_v4_extended_field_universal_2.FieldDataType; } });
38
- Object.defineProperty(exports, "FieldType", { enumerable: true, get: function () { return contacts_v4_extended_field_universal_2.FieldType; } });
39
- Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return contacts_v4_extended_field_universal_2.SortOrder; } });
40
- var contacts_v4_extended_field_universal_3 = require("./contacts-v4-extended-field.universal");
41
- Object.defineProperty(exports, "onExtendedFieldCreated", { enumerable: true, get: function () { return contacts_v4_extended_field_universal_3.onExtendedFieldCreated; } });
42
- Object.defineProperty(exports, "onExtendedFieldUpdated", { enumerable: true, get: function () { return contacts_v4_extended_field_universal_3.onExtendedFieldUpdated; } });
43
- Object.defineProperty(exports, "onExtendedFieldDeleted", { enumerable: true, get: function () { return contacts_v4_extended_field_universal_3.onExtendedFieldDeleted; } });
44
- //# sourceMappingURL=contacts-v4-extended-field.public.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"contacts-v4-extended-field.public.js","sourceRoot":"","sources":["../../../src/contacts-v4-extended-field.public.ts"],"names":[],"mappings":";;;AACA,iGAQgD;AAEnC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;AAEvD,SAAgB,yBAAyB,CAAC,UAAsB;IAC9D,OAAO,CAAC,WAAmB,EAAE,QAAuB,EAAE,EAAE,CACtD,IAAA,gEAAkC,EAChC,WAAW,EACX,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,8DAQC;AAED,SAAgB,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,uDAAyB,EACvB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4CAOC;AAED,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,CAAC,GAAW,EAAE,KAA0B,EAAE,EAAE,CACjD,IAAA,0DAA4B,EAC1B,GAAG,EACH,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kDAQC;AAED,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,0DAA4B,EAC1B,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,kDAOC;AAED,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,GAAG,EAAE,CACV,IAAA,0DAA4B;IAC1B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,kDAMC;AAED,+FAIgD;AAH9C,qIAAA,aAAa,OAAA;AACb,iIAAA,SAAS,OAAA;AACT,iIAAA,SAAS,OAAA;AA4CX,+FAIgD;AAH9C,8IAAA,sBAAsB,OAAA;AACtB,8IAAA,sBAAsB,OAAA;AACtB,8IAAA,sBAAsB,OAAA"}
@@ -1,357 +0,0 @@
1
- /** Extended field that was found or created. */
2
- export interface ExtendedField {
3
- /**
4
- * Extended field namespace.
5
- *
6
- * Extended fields created by site collaborators or 3rd-party apps
7
- * are automatically assigned to the `custom` namespace.
8
- * @readonly
9
- */
10
- namespace?: string | null;
11
- /**
12
- * Extended field key.
13
- *
14
- * When accessing contact data,
15
- * extended field data is available at `extendedFields[key]`.
16
- * For example, if the key is "custom.notes",
17
- * the value can be accessed at `extendedFields["custom.notes"]`.
18
- *
19
- * `key` is generated when the extended field is created
20
- * and cannot be modified, even if `displayName` changes.
21
- * @readonly
22
- */
23
- key?: string;
24
- /** Display name shown in the Contact List. */
25
- displayName?: string;
26
- /**
27
- * Type of data the field holds.
28
- *
29
- * - `TEXT`: Accepts strings.
30
- * - `NUMBER`: Accepts floats.
31
- * - `DATE`: Accepts dates formatted as `YYYY-MM-DD`.
32
- * - `URL`: Accepts strings. Prepends `https://` if no protocol is included.
33
- * @readonly
34
- */
35
- dataType?: FieldDataType;
36
- /**
37
- * Indicates whether the extended field is a system field or custom field.
38
- *
39
- * - `SYSTEM`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
40
- * - `USER_DEFINED`: The field is a custom field and can be modified by 3rd-party apps or site contributors.
41
- * @readonly
42
- */
43
- fieldType?: FieldType;
44
- /**
45
- * Date and time the field was created.
46
- * @readonly
47
- */
48
- createdDate?: Date;
49
- /**
50
- * Date and time the field was last updated.
51
- * @readonly
52
- */
53
- updatedDate?: Date;
54
- /**
55
- * Field description, if the field is a system field.
56
- * @readonly
57
- */
58
- description?: string | null;
59
- }
60
- export declare enum FieldDataType {
61
- UNKNOWN_DATA_TYPE = "UNKNOWN_DATA_TYPE",
62
- TEXT = "TEXT",
63
- NUMBER = "NUMBER",
64
- DATE = "DATE",
65
- URL = "URL"
66
- }
67
- export declare enum FieldType {
68
- UNKNOWN = "UNKNOWN",
69
- SYSTEM = "SYSTEM",
70
- USER_DEFINED = "USER_DEFINED"
71
- }
72
- /** Extended field filter options. */
73
- export interface ListExtendedFieldsRequest {
74
- /** Filter for fields of the specified type. */
75
- fieldType?: FieldType;
76
- /**
77
- * Filter for fields in the specified namespace.
78
- * Fields created by site contributors or 3rd-party apps
79
- * are automatically assigned to the `custom` namespace.
80
- */
81
- namespace?: string | null;
82
- /** Filter for fields where `displayName` starts with the specified case-sensitive string. */
83
- startsWith?: string | null;
84
- /** Sorting options. */
85
- sort?: Sorting;
86
- /** Paging options. */
87
- paging?: Paging;
88
- }
89
- export interface Sorting {
90
- /** Name of the field to sort by. */
91
- fieldName?: string;
92
- /**
93
- * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
94
- *
95
- * Defaults to `ASC`.
96
- */
97
- order?: SortOrder;
98
- }
99
- export declare enum SortOrder {
100
- ASC = "ASC",
101
- DESC = "DESC"
102
- }
103
- export interface Paging {
104
- /**
105
- * Number of items to return.
106
- *
107
- * Defaults to `100`.
108
- */
109
- limit?: number | null;
110
- /**
111
- * Number of items to skip in the current sort order.
112
- *
113
- * Defaults to `0`.
114
- */
115
- offset?: number | null;
116
- }
117
- /** List of extended fields. */
118
- export interface ListExtendedFieldsResponse {
119
- /** List of extended fields. */
120
- fields?: ExtendedField[];
121
- /** Metadata for the page of results. */
122
- metadata?: PagingMetadata;
123
- }
124
- export interface PagingMetadata {
125
- /** Number of items returned. */
126
- count?: number | null;
127
- /** Requested offset. */
128
- offset?: number | null;
129
- /** Number of items that matched the query. */
130
- total?: number | null;
131
- /**
132
- * Indicates if `total` calculation timed out before the response was sent.
133
- * Typically this happens if there is a large set of results.
134
- */
135
- tooManyToCount?: boolean | null;
136
- }
137
- /** Custom field to find or create. */
138
- export interface FindOrCreateExtendedFieldRequest {
139
- /**
140
- * Display name to find or create.
141
- *
142
- * If an existing custom field is an exact match
143
- * for the specified `displayName`,
144
- * the existing field is returned.
145
- * If not, a new field is created and returned.
146
- */
147
- displayName: string;
148
- /**
149
- * Type of data the field holds.
150
- * Ignored if an existing field is an exact match
151
- * for the specified display name.
152
- *
153
- * - `TEXT`: Accepts strings.
154
- * - `NUMBER`: Accepts floats.
155
- * - `DATE`: Accepts dates formatted as `YYYY-MM-DD`.
156
- * - `URL`: Accepts strings. Prepends `https://` if no protocol is included.
157
- */
158
- dataType?: FieldDataType;
159
- }
160
- /** Extended field that was found or created. */
161
- export interface FindOrCreateExtendedFieldResponse {
162
- /** Extended field that was found or created. */
163
- field?: ExtendedField;
164
- /**
165
- * Indicates whether the extended field was just created or already existed.
166
- *
167
- * If the field was just created, returns `true`.
168
- * If the field already existed, returns `false`.
169
- */
170
- newField?: boolean;
171
- }
172
- export interface GetExtendedFieldRequest {
173
- /**
174
- * Extended field key.
175
- *
176
- * When accessing contact data,
177
- * extended field values are available at `info.extendedFields.items[key]`.
178
- * For example, if the key is "custom.patronus",
179
- * the value can be accessed at `info.extendedFields.items["custom.patronus"]`.
180
- *
181
- * Once set, `key` cannot be modified, even if `displayName` changes.
182
- */
183
- key: string;
184
- }
185
- /** The specified field. */
186
- export interface GetExtendedFieldResponse {
187
- /** The specified field. */
188
- field?: ExtendedField;
189
- }
190
- export interface GetExtendedFieldByLegacyIdRequest {
191
- legacyId?: string;
192
- }
193
- export interface GetExtendedFieldByLegacyIdResponse {
194
- field?: ExtendedField;
195
- }
196
- export interface UpdateExtendedFieldRequest {
197
- /** Field to update. */
198
- field?: ExtendedField;
199
- }
200
- /** Updated extended field. */
201
- export interface UpdateExtendedFieldResponse {
202
- /** Updated extended field. */
203
- field?: ExtendedField;
204
- }
205
- export interface DeleteExtendedFieldRequest {
206
- /** Extended field key. */
207
- key: string;
208
- }
209
- export interface DeleteExtendedFieldResponse {
210
- }
211
- export interface PurgeRequest {
212
- instanceId?: string;
213
- }
214
- export interface PurgeResponse {
215
- deletedItems?: number;
216
- }
217
- export interface GdprListRequest {
218
- instanceId?: string;
219
- }
220
- export interface GdprListResponse {
221
- fields?: ExtendedField[];
222
- }
223
- export interface QueryExtendedFieldsRequest {
224
- /** Query options. */
225
- query?: Query;
226
- }
227
- export interface Query {
228
- /**
229
- * ilter object.
230
- *
231
- * Possible filters: `$eq`, `$gt`, `$gte`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
232
- *
233
- * For a detailed list of supported filters, see [sorting and filtering for extended fields](https://dev.wix.com/api/rest/contacts/extended-fields/sort-and-filter).
234
- *
235
- * Example: `{ "filter": {
236
- * "displayName": {
237
- * "$startsWith": "Referral"
238
- * }
239
- * }
240
- * }`
241
- */
242
- filter?: Record<string, any> | null;
243
- /**
244
- * Sorting options. Currently supports sorting on one field only.
245
- *
246
- * Example: `{ "sort": [{"fieldName": "displayName", "order": "DESC"}] }`
247
- */
248
- sort?: Sorting[];
249
- /** Pagination options. */
250
- paging?: Paging;
251
- }
252
- export interface QueryExtendedFieldsResponse {
253
- /** List of extended fields. */
254
- fields?: ExtendedField[];
255
- /** Details on the paged set of results returned. */
256
- pagingMetadata?: PagingMetadata;
257
- }
258
- export interface DomainEvent extends DomainEventBodyOneOf {
259
- createdEvent?: EntityCreatedEvent;
260
- updatedEvent?: EntityUpdatedEvent;
261
- deletedEvent?: EntityDeletedEvent;
262
- actionEvent?: ActionEvent;
263
- /**
264
- * Unique event ID.
265
- * Allows clients to ignore duplicate webhooks.
266
- */
267
- id?: string;
268
- /**
269
- * Assumes actions are also always typed to an entity_type
270
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
271
- */
272
- entityFqdn?: string;
273
- /**
274
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
275
- * This is although the created/updated/deleted notion is duplication of the oneof types
276
- * Example: created/updated/deleted/started/completed/email_opened
277
- */
278
- slug?: string;
279
- /** ID of the entity associated with the event. */
280
- entityId?: string;
281
- /** Event timestamp. */
282
- eventTime?: Date;
283
- /**
284
- * Whether the event was triggered as a result of a privacy regulation application
285
- * (for example, GDPR).
286
- */
287
- triggeredByAnonymizeRequest?: boolean | null;
288
- /** If present, indicates the action that triggered the event. */
289
- originatedFrom?: string | null;
290
- /**
291
- * A sequence number defining the order of updates to the underlying entity.
292
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
293
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
294
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
295
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
296
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
297
- */
298
- entityEventSequence?: string | null;
299
- }
300
- /** @oneof */
301
- export interface DomainEventBodyOneOf {
302
- createdEvent?: EntityCreatedEvent;
303
- updatedEvent?: EntityUpdatedEvent;
304
- deletedEvent?: EntityDeletedEvent;
305
- actionEvent?: ActionEvent;
306
- }
307
- export interface EntityCreatedEvent {
308
- entityAsJson?: string;
309
- }
310
- export interface EntityUpdatedEvent {
311
- /**
312
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
313
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
314
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
315
- */
316
- currentEntityAsJson?: string;
317
- }
318
- export interface EntityDeletedEvent {
319
- /** Entity that was deleted */
320
- deletedEntityAsJson?: string | null;
321
- }
322
- export interface ActionEvent {
323
- bodyAsJson?: string;
324
- }
325
- export interface FindOrCreateExtendedFieldResponseNonNullableFields {
326
- field?: {
327
- key: string;
328
- displayName: string;
329
- dataType: FieldDataType;
330
- fieldType: FieldType;
331
- };
332
- newField: boolean;
333
- }
334
- export interface GetExtendedFieldResponseNonNullableFields {
335
- field?: {
336
- key: string;
337
- displayName: string;
338
- dataType: FieldDataType;
339
- fieldType: FieldType;
340
- };
341
- }
342
- export interface UpdateExtendedFieldResponseNonNullableFields {
343
- field?: {
344
- key: string;
345
- displayName: string;
346
- dataType: FieldDataType;
347
- fieldType: FieldType;
348
- };
349
- }
350
- export interface QueryExtendedFieldsResponseNonNullableFields {
351
- fields: {
352
- key: string;
353
- displayName: string;
354
- dataType: FieldDataType;
355
- fieldType: FieldType;
356
- }[];
357
- }
@@ -1,23 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SortOrder = exports.FieldType = exports.FieldDataType = void 0;
4
- var FieldDataType;
5
- (function (FieldDataType) {
6
- FieldDataType["UNKNOWN_DATA_TYPE"] = "UNKNOWN_DATA_TYPE";
7
- FieldDataType["TEXT"] = "TEXT";
8
- FieldDataType["NUMBER"] = "NUMBER";
9
- FieldDataType["DATE"] = "DATE";
10
- FieldDataType["URL"] = "URL";
11
- })(FieldDataType || (exports.FieldDataType = FieldDataType = {}));
12
- var FieldType;
13
- (function (FieldType) {
14
- FieldType["UNKNOWN"] = "UNKNOWN";
15
- FieldType["SYSTEM"] = "SYSTEM";
16
- FieldType["USER_DEFINED"] = "USER_DEFINED";
17
- })(FieldType || (exports.FieldType = FieldType = {}));
18
- var SortOrder;
19
- (function (SortOrder) {
20
- SortOrder["ASC"] = "ASC";
21
- SortOrder["DESC"] = "DESC";
22
- })(SortOrder || (exports.SortOrder = SortOrder = {}));
23
- //# sourceMappingURL=contacts-v4-extended-field.types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"contacts-v4-extended-field.types.js","sourceRoot":"","sources":["../../../src/contacts-v4-extended-field.types.ts"],"names":[],"mappings":";;;AA4DA,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,wDAAuC,CAAA;IACvC,8BAAa,CAAA;IACb,kCAAiB,CAAA;IACjB,8BAAa,CAAA;IACb,4BAAW,CAAA;AACb,CAAC,EANW,aAAa,6BAAb,aAAa,QAMxB;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,0CAA6B,CAAA;AAC/B,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB;AA+BD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}