@wix/crm 1.0.80 → 1.0.81
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/cjs/context.d.ts +5 -0
- package/build/cjs/context.js +32 -0
- package/build/cjs/context.js.map +1 -0
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +7 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +7 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +7 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/src/contacts-v4-contact.context.d.ts +9 -0
- package/build/cjs/src/contacts-v4-contact.context.js +82 -0
- package/build/cjs/src/contacts-v4-contact.context.js.map +1 -0
- package/build/cjs/src/contacts-v4-contact.http.d.ts +20 -94
- package/build/cjs/src/contacts-v4-contact.http.js +211 -249
- package/build/cjs/src/contacts-v4-contact.http.js.map +1 -1
- package/build/cjs/src/contacts-v4-contact.meta.d.ts +1 -1
- package/build/cjs/src/contacts-v4-contact.meta.js +5 -1
- package/build/cjs/src/contacts-v4-contact.meta.js.map +1 -1
- package/build/cjs/src/contacts-v4-contact.public.d.ts +6 -6
- package/build/cjs/src/contacts-v4-contact.public.js +5 -2
- package/build/cjs/src/contacts-v4-contact.public.js.map +1 -1
- package/build/cjs/src/contacts-v4-contact.types.d.ts +265 -5
- package/build/cjs/src/contacts-v4-contact.types.js +40 -19
- package/build/cjs/src/contacts-v4-contact.types.js.map +1 -1
- package/build/cjs/src/contacts-v4-contact.universal.d.ts +221 -155
- package/build/cjs/src/contacts-v4-contact.universal.js +140 -168
- package/build/cjs/src/contacts-v4-contact.universal.js.map +1 -1
- package/build/cjs/src/contacts-v4-extended-field.context.d.ts +7 -0
- package/build/cjs/src/contacts-v4-extended-field.context.js +60 -0
- package/build/cjs/src/contacts-v4-extended-field.context.js.map +1 -0
- package/build/cjs/src/contacts-v4-extended-field.http.d.ts +7 -14
- package/build/cjs/src/contacts-v4-extended-field.http.js +60 -70
- package/build/cjs/src/contacts-v4-extended-field.http.js.map +1 -1
- package/build/cjs/src/contacts-v4-extended-field.meta.d.ts +1 -1
- package/build/cjs/src/contacts-v4-extended-field.meta.js +5 -1
- package/build/cjs/src/contacts-v4-extended-field.meta.js.map +1 -1
- package/build/cjs/src/contacts-v4-extended-field.public.d.ts +1 -1
- package/build/cjs/src/contacts-v4-extended-field.types.d.ts +68 -1
- package/build/cjs/src/contacts-v4-extended-field.types.js +3 -3
- package/build/cjs/src/contacts-v4-extended-field.types.js.map +1 -1
- package/build/cjs/src/contacts-v4-extended-field.universal.d.ts +104 -30
- package/build/cjs/src/contacts-v4-extended-field.universal.js +58 -51
- package/build/cjs/src/contacts-v4-extended-field.universal.js.map +1 -1
- package/build/cjs/src/contacts-v4-label.context.d.ts +7 -0
- package/build/cjs/src/contacts-v4-label.context.js +60 -0
- package/build/cjs/src/contacts-v4-label.context.js.map +1 -0
- package/build/cjs/src/contacts-v4-label.http.d.ts +13 -14
- package/build/cjs/src/contacts-v4-label.http.js +66 -72
- package/build/cjs/src/contacts-v4-label.http.js.map +1 -1
- package/build/cjs/src/contacts-v4-label.meta.d.ts +1 -1
- package/build/cjs/src/contacts-v4-label.meta.js +5 -1
- package/build/cjs/src/contacts-v4-label.meta.js.map +1 -1
- package/build/cjs/src/contacts-v4-label.public.d.ts +5 -5
- package/build/cjs/src/contacts-v4-label.types.d.ts +76 -9
- package/build/cjs/src/contacts-v4-label.types.js +2 -2
- package/build/cjs/src/contacts-v4-label.types.js.map +1 -1
- package/build/cjs/src/contacts-v4-label.universal.d.ts +113 -40
- package/build/cjs/src/contacts-v4-label.universal.js +72 -62
- package/build/cjs/src/contacts-v4-label.universal.js.map +1 -1
- package/build/cjs/src/contacts-v4-submit-contact.context.d.ts +3 -0
- package/build/cjs/src/contacts-v4-submit-contact.context.js +16 -0
- package/build/cjs/src/contacts-v4-submit-contact.context.js.map +1 -0
- package/build/cjs/src/contacts-v4-submit-contact.http.js +20 -34
- package/build/cjs/src/contacts-v4-submit-contact.http.js.map +1 -1
- package/build/cjs/src/contacts-v4-submit-contact.meta.d.ts +1 -1
- package/build/cjs/src/contacts-v4-submit-contact.meta.js +5 -1
- package/build/cjs/src/contacts-v4-submit-contact.meta.js.map +1 -1
- package/build/cjs/src/contacts-v4-submit-contact.public.d.ts +2 -2
- package/build/cjs/src/contacts-v4-submit-contact.types.d.ts +8 -3
- package/build/cjs/src/contacts-v4-submit-contact.types.js +9 -9
- package/build/cjs/src/contacts-v4-submit-contact.types.js.map +1 -1
- package/build/cjs/src/contacts-v4-submit-contact.universal.d.ts +8 -9
- package/build/cjs/src/contacts-v4-submit-contact.universal.js +25 -28
- package/build/cjs/src/contacts-v4-submit-contact.universal.js.map +1 -1
- package/build/cjs/src/crm-tasks-v2-task.context.d.ts +9 -0
- package/build/cjs/src/crm-tasks-v2-task.context.js +82 -0
- package/build/cjs/src/crm-tasks-v2-task.context.js.map +1 -0
- package/build/cjs/src/crm-tasks-v2-task.http.d.ts +60 -0
- package/build/cjs/src/crm-tasks-v2-task.http.js +268 -0
- package/build/cjs/src/crm-tasks-v2-task.http.js.map +1 -0
- package/build/cjs/src/crm-tasks-v2-task.meta.d.ts +27 -0
- package/build/cjs/src/crm-tasks-v2-task.meta.js +161 -0
- package/build/cjs/src/crm-tasks-v2-task.meta.js.map +1 -0
- package/build/cjs/src/crm-tasks-v2-task.public.d.ts +29 -0
- package/build/cjs/src/crm-tasks-v2-task.public.js +53 -0
- package/build/cjs/src/crm-tasks-v2-task.public.js.map +1 -0
- package/build/cjs/src/crm-tasks-v2-task.types.d.ts +430 -0
- package/build/cjs/src/crm-tasks-v2-task.types.js +29 -0
- package/build/cjs/src/crm-tasks-v2-task.types.js.map +1 -0
- package/build/cjs/src/crm-tasks-v2-task.universal.d.ts +665 -0
- package/build/cjs/src/crm-tasks-v2-task.universal.js +515 -0
- package/build/cjs/src/crm-tasks-v2-task.universal.js.map +1 -0
- package/build/cjs/src/ping-notifications-v3-notification.public.d.ts +1 -1
- package/build/cjs/src/ping-notifications-v3-notification.types.js +1 -1
- package/build/cjs/src/ping-notifications-v3-notification.types.js.map +1 -1
- package/build/cjs/src/ping-notifications-v3-notification.universal.js +6 -2
- package/build/cjs/src/ping-notifications-v3-notification.universal.js.map +1 -1
- package/build/es/context.d.ts +5 -0
- package/build/es/context.js +6 -0
- package/build/es/context.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +1 -0
- package/build/es/index.js.map +1 -1
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +1 -0
- package/build/es/index.typings.js.map +1 -1
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +1 -0
- package/build/es/meta.js.map +1 -1
- package/build/es/src/contacts-v4-contact.context.d.ts +9 -0
- package/build/es/src/contacts-v4-contact.context.js +72 -0
- package/build/es/src/contacts-v4-contact.context.js.map +1 -0
- package/build/es/src/contacts-v4-contact.http.d.ts +20 -94
- package/build/es/src/contacts-v4-contact.http.js +211 -249
- package/build/es/src/contacts-v4-contact.http.js.map +1 -1
- package/build/es/src/contacts-v4-contact.meta.d.ts +1 -1
- package/build/es/src/contacts-v4-contact.public.d.ts +6 -6
- package/build/es/src/contacts-v4-contact.public.js +2 -2
- package/build/es/src/contacts-v4-contact.public.js.map +1 -1
- package/build/es/src/contacts-v4-contact.types.d.ts +265 -5
- package/build/es/src/contacts-v4-contact.types.js +21 -0
- package/build/es/src/contacts-v4-contact.types.js.map +1 -1
- package/build/es/src/contacts-v4-contact.universal.d.ts +221 -155
- package/build/es/src/contacts-v4-contact.universal.js +117 -149
- package/build/es/src/contacts-v4-contact.universal.js.map +1 -1
- package/build/es/src/contacts-v4-extended-field.context.d.ts +7 -0
- package/build/es/src/contacts-v4-extended-field.context.js +52 -0
- package/build/es/src/contacts-v4-extended-field.context.js.map +1 -0
- package/build/es/src/contacts-v4-extended-field.http.d.ts +7 -14
- package/build/es/src/contacts-v4-extended-field.http.js +60 -70
- package/build/es/src/contacts-v4-extended-field.http.js.map +1 -1
- package/build/es/src/contacts-v4-extended-field.meta.d.ts +1 -1
- package/build/es/src/contacts-v4-extended-field.public.d.ts +1 -1
- package/build/es/src/contacts-v4-extended-field.types.d.ts +68 -1
- package/build/es/src/contacts-v4-extended-field.universal.d.ts +104 -30
- package/build/es/src/contacts-v4-extended-field.universal.js +49 -46
- package/build/es/src/contacts-v4-extended-field.universal.js.map +1 -1
- package/build/es/src/contacts-v4-label.context.d.ts +7 -0
- package/build/es/src/contacts-v4-label.context.js +52 -0
- package/build/es/src/contacts-v4-label.context.js.map +1 -0
- package/build/es/src/contacts-v4-label.http.d.ts +13 -14
- package/build/es/src/contacts-v4-label.http.js +66 -72
- package/build/es/src/contacts-v4-label.http.js.map +1 -1
- package/build/es/src/contacts-v4-label.meta.d.ts +1 -1
- package/build/es/src/contacts-v4-label.public.d.ts +5 -5
- package/build/es/src/contacts-v4-label.types.d.ts +76 -9
- package/build/es/src/contacts-v4-label.universal.d.ts +113 -40
- package/build/es/src/contacts-v4-label.universal.js +64 -58
- package/build/es/src/contacts-v4-label.universal.js.map +1 -1
- package/build/es/src/contacts-v4-submit-contact.context.d.ts +3 -0
- package/build/es/src/contacts-v4-submit-contact.context.js +12 -0
- package/build/es/src/contacts-v4-submit-contact.context.js.map +1 -0
- package/build/es/src/contacts-v4-submit-contact.http.js +20 -34
- package/build/es/src/contacts-v4-submit-contact.http.js.map +1 -1
- package/build/es/src/contacts-v4-submit-contact.meta.d.ts +1 -1
- package/build/es/src/contacts-v4-submit-contact.public.d.ts +2 -2
- package/build/es/src/contacts-v4-submit-contact.types.d.ts +8 -3
- package/build/es/src/contacts-v4-submit-contact.types.js.map +1 -1
- package/build/es/src/contacts-v4-submit-contact.universal.d.ts +8 -9
- package/build/es/src/contacts-v4-submit-contact.universal.js +11 -18
- package/build/es/src/contacts-v4-submit-contact.universal.js.map +1 -1
- package/build/es/src/crm-tasks-v2-task.context.d.ts +9 -0
- package/build/es/src/crm-tasks-v2-task.context.js +72 -0
- package/build/es/src/crm-tasks-v2-task.context.js.map +1 -0
- package/build/es/src/crm-tasks-v2-task.http.d.ts +60 -0
- package/build/es/src/crm-tasks-v2-task.http.js +258 -0
- package/build/es/src/crm-tasks-v2-task.http.js.map +1 -0
- package/build/es/src/crm-tasks-v2-task.meta.d.ts +27 -0
- package/build/es/src/crm-tasks-v2-task.meta.js +128 -0
- package/build/es/src/crm-tasks-v2-task.meta.js.map +1 -0
- package/build/es/src/crm-tasks-v2-task.public.d.ts +29 -0
- package/build/es/src/crm-tasks-v2-task.public.js +39 -0
- package/build/es/src/crm-tasks-v2-task.public.js.map +1 -0
- package/build/es/src/crm-tasks-v2-task.types.d.ts +430 -0
- package/build/es/src/crm-tasks-v2-task.types.js +26 -0
- package/build/es/src/crm-tasks-v2-task.types.js.map +1 -0
- package/build/es/src/crm-tasks-v2-task.universal.d.ts +665 -0
- package/build/es/src/crm-tasks-v2-task.universal.js +482 -0
- package/build/es/src/crm-tasks-v2-task.universal.js.map +1 -0
- package/build/es/src/ping-notifications-v3-notification.public.d.ts +1 -1
- package/build/es/src/ping-notifications-v3-notification.universal.js.map +1 -1
- package/context/package.json +6 -0
- package/package.json +12 -6
|
@@ -7,9 +7,7 @@ import { DeleteExtendedFieldRequest, DeleteExtendedFieldResponse, FindOrCreateEx
|
|
|
7
7
|
*
|
|
8
8
|
* Successful calls to `findOrCreateExtendedField()` always return an extended field, which can be passed to subsequent function calls.
|
|
9
9
|
*
|
|
10
|
-
* To find an existing extended field without potentially creating a new one, use
|
|
11
|
-
*
|
|
12
|
-
* >**Note:** Only visitors with **Manage Contacts** permissions can find or create extended fields.
|
|
10
|
+
* To find an existing extended field without potentially creating a new one, use `getExtendedField()` or `queryExtendedFields()`.
|
|
13
11
|
*
|
|
14
12
|
*/
|
|
15
13
|
export declare function findOrCreateExtendedField(payload: FindOrCreateExtendedFieldRequest): RequestOptionsFactory<FindOrCreateExtendedFieldResponse & FindOrCreateExtendedFieldResponseNonNullableFields>;
|
|
@@ -18,7 +16,6 @@ export declare function findOrCreateExtendedField(payload: FindOrCreateExtendedF
|
|
|
18
16
|
*
|
|
19
17
|
* The `getExtendedField()` function returns a Promise that resolves when the extended field is retrieved.
|
|
20
18
|
*
|
|
21
|
-
* >**Note:** Only visitors with **Manage Contacts** permissions can retrieve extended fields.
|
|
22
19
|
*/
|
|
23
20
|
export declare function getExtendedField(payload: GetExtendedFieldRequest): RequestOptionsFactory<GetExtendedFieldResponse & GetExtendedFieldResponseNonNullableFields>;
|
|
24
21
|
/**
|
|
@@ -26,7 +23,6 @@ export declare function getExtendedField(payload: GetExtendedFieldRequest): Requ
|
|
|
26
23
|
*
|
|
27
24
|
* The `renameExtendedField()` function returns a Promise that resolves when the specified extended field's display name is changed
|
|
28
25
|
*
|
|
29
|
-
* > **Note:** Only visitors with **Manage Contacts** permissions can rename extended fields.
|
|
30
26
|
*/
|
|
31
27
|
export declare function updateExtendedField(payload: UpdateExtendedFieldRequest): RequestOptionsFactory<UpdateExtendedFieldResponse & UpdateExtendedFieldResponseNonNullableFields>;
|
|
32
28
|
/**
|
|
@@ -36,25 +32,22 @@ export declare function updateExtendedField(payload: UpdateExtendedFieldRequest)
|
|
|
36
32
|
*
|
|
37
33
|
* When an extended field is deleted, any contact data stored in the field is permanently deleted as well.
|
|
38
34
|
*
|
|
39
|
-
* >**Note:** Only visitors with **Manage Contacts** permissions can delete extended fields.
|
|
40
35
|
*/
|
|
41
36
|
export declare function deleteExtendedField(payload: DeleteExtendedFieldRequest): RequestOptionsFactory<DeleteExtendedFieldResponse>;
|
|
42
37
|
/**
|
|
43
38
|
* Creates a query to retrieve a list of extended fields.
|
|
44
39
|
*
|
|
45
|
-
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an
|
|
40
|
+
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an `FieldsQueryBuilder` object.
|
|
46
41
|
*
|
|
47
|
-
* The returned object contains the query definition, which is used to run the query using the
|
|
42
|
+
* The returned object contains the query definition, which is used to run the query using the `find()` function.
|
|
48
43
|
*
|
|
49
44
|
* You can refine the query by chaining `FieldsQueryBuilder` functions onto the query. `FieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
|
|
50
45
|
*
|
|
51
46
|
* `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:
|
|
52
|
-
* -
|
|
53
|
-
* -
|
|
54
|
-
* -
|
|
55
|
-
*
|
|
56
|
-
* > **Note:** Only visitors with **Manage Contacts** permissions can query extended fields.
|
|
47
|
+
* - `skip()`
|
|
48
|
+
* - `limit(50)`
|
|
49
|
+
* - `descending('_createdDate')`
|
|
57
50
|
*
|
|
58
|
-
* The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the
|
|
51
|
+
* The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the `items` property in `FieldsQueryResult`.
|
|
59
52
|
*/
|
|
60
53
|
export declare function queryExtendedFields(payload: QueryExtendedFieldsRequest): RequestOptionsFactory<QueryExtendedFieldsResponse & QueryExtendedFieldsResponseNonNullableFields>;
|
|
@@ -1,20 +1,8 @@
|
|
|
1
1
|
import { toURLSearchParams } from '@wix/metro-runtime';
|
|
2
|
-
import {
|
|
2
|
+
import { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
|
|
3
|
+
import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
|
|
4
|
+
import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
|
|
3
5
|
import { resolveUrl } from '@wix/metro-runtime';
|
|
4
|
-
const _deleteExtendedFieldRequest = {};
|
|
5
|
-
const _deleteExtendedFieldResponse = {};
|
|
6
|
-
const _extendedField = {
|
|
7
|
-
createdDate: 'google.protobuf.Timestamp',
|
|
8
|
-
updatedDate: 'google.protobuf.Timestamp',
|
|
9
|
-
};
|
|
10
|
-
const _findOrCreateExtendedFieldRequest = {};
|
|
11
|
-
const _findOrCreateExtendedFieldResponse = { field: '_extendedField' };
|
|
12
|
-
const _getExtendedFieldRequest = {};
|
|
13
|
-
const _getExtendedFieldResponse = { field: '_extendedField' };
|
|
14
|
-
const _queryExtendedFieldsRequest = {};
|
|
15
|
-
const _queryExtendedFieldsResponse = { fields: '_extendedField' };
|
|
16
|
-
const _updateExtendedFieldRequest = { field: '_extendedField' };
|
|
17
|
-
const _updateExtendedFieldResponse = { field: '_extendedField' };
|
|
18
6
|
function resolveComWixpressContactsFieldsV4ContactExtendedFieldsServiceV4Url(opts) {
|
|
19
7
|
const domainToMappings = {
|
|
20
8
|
'api._api_base_domain_': [
|
|
@@ -69,33 +57,33 @@ function resolveComWixpressContactsFieldsV4ContactExtendedFieldsServiceV4Url(opt
|
|
|
69
57
|
*
|
|
70
58
|
* Successful calls to `findOrCreateExtendedField()` always return an extended field, which can be passed to subsequent function calls.
|
|
71
59
|
*
|
|
72
|
-
* To find an existing extended field without potentially creating a new one, use
|
|
73
|
-
*
|
|
74
|
-
* >**Note:** Only visitors with **Manage Contacts** permissions can find or create extended fields.
|
|
60
|
+
* To find an existing extended field without potentially creating a new one, use `getExtendedField()` or `queryExtendedFields()`.
|
|
75
61
|
*
|
|
76
62
|
*/
|
|
77
63
|
export function findOrCreateExtendedField(payload) {
|
|
78
|
-
const { toJSON: toReq, fromJSON: fromReq } = serializer(_findOrCreateExtendedFieldRequest, {});
|
|
79
|
-
const { fromJSON: fromRes } = serializer(_findOrCreateExtendedFieldResponse, {
|
|
80
|
-
_extendedField,
|
|
81
|
-
});
|
|
82
64
|
function __findOrCreateExtendedField({ host }) {
|
|
83
|
-
const serializedData = toReq(payload);
|
|
84
65
|
const metadata = {
|
|
85
66
|
entityFqdn: 'wix.contacts.v4.extended_field',
|
|
86
67
|
method: 'POST',
|
|
87
68
|
methodFqn: 'com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.FindOrCreateExtendedField',
|
|
88
69
|
url: resolveComWixpressContactsFieldsV4ContactExtendedFieldsServiceV4Url({
|
|
89
70
|
protoPath: '/v4/extended-fields',
|
|
90
|
-
data:
|
|
71
|
+
data: payload,
|
|
91
72
|
host,
|
|
92
73
|
}),
|
|
93
|
-
data:
|
|
94
|
-
transformResponse:
|
|
74
|
+
data: payload,
|
|
75
|
+
transformResponse: (payload) => transformPaths(payload, [
|
|
76
|
+
{
|
|
77
|
+
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
78
|
+
paths: [
|
|
79
|
+
{ path: 'field.createdDate' },
|
|
80
|
+
{ path: 'field.updatedDate' },
|
|
81
|
+
],
|
|
82
|
+
},
|
|
83
|
+
]),
|
|
95
84
|
};
|
|
96
85
|
return metadata;
|
|
97
86
|
}
|
|
98
|
-
__findOrCreateExtendedField.fromReq = fromReq;
|
|
99
87
|
return __findOrCreateExtendedField;
|
|
100
88
|
}
|
|
101
89
|
/**
|
|
@@ -103,30 +91,31 @@ export function findOrCreateExtendedField(payload) {
|
|
|
103
91
|
*
|
|
104
92
|
* The `getExtendedField()` function returns a Promise that resolves when the extended field is retrieved.
|
|
105
93
|
*
|
|
106
|
-
* >**Note:** Only visitors with **Manage Contacts** permissions can retrieve extended fields.
|
|
107
94
|
*/
|
|
108
95
|
export function getExtendedField(payload) {
|
|
109
|
-
const { toJSON: toReq, fromJSON: fromReq } = serializer(_getExtendedFieldRequest, {});
|
|
110
|
-
const { fromJSON: fromRes } = serializer(_getExtendedFieldResponse, {
|
|
111
|
-
_extendedField,
|
|
112
|
-
});
|
|
113
96
|
function __getExtendedField({ host }) {
|
|
114
|
-
const serializedData = toReq(payload);
|
|
115
97
|
const metadata = {
|
|
116
98
|
entityFqdn: 'wix.contacts.v4.extended_field',
|
|
117
99
|
method: 'GET',
|
|
118
100
|
methodFqn: 'com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.GetExtendedField',
|
|
119
101
|
url: resolveComWixpressContactsFieldsV4ContactExtendedFieldsServiceV4Url({
|
|
120
102
|
protoPath: '/v4/extended-fields/{key}',
|
|
121
|
-
data:
|
|
103
|
+
data: payload,
|
|
122
104
|
host,
|
|
123
105
|
}),
|
|
124
|
-
params: toURLSearchParams(
|
|
125
|
-
transformResponse:
|
|
106
|
+
params: toURLSearchParams(payload),
|
|
107
|
+
transformResponse: (payload) => transformPaths(payload, [
|
|
108
|
+
{
|
|
109
|
+
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
110
|
+
paths: [
|
|
111
|
+
{ path: 'field.createdDate' },
|
|
112
|
+
{ path: 'field.updatedDate' },
|
|
113
|
+
],
|
|
114
|
+
},
|
|
115
|
+
]),
|
|
126
116
|
};
|
|
127
117
|
return metadata;
|
|
128
118
|
}
|
|
129
|
-
__getExtendedField.fromReq = fromReq;
|
|
130
119
|
return __getExtendedField;
|
|
131
120
|
}
|
|
132
121
|
/**
|
|
@@ -134,15 +123,15 @@ export function getExtendedField(payload) {
|
|
|
134
123
|
*
|
|
135
124
|
* The `renameExtendedField()` function returns a Promise that resolves when the specified extended field's display name is changed
|
|
136
125
|
*
|
|
137
|
-
* > **Note:** Only visitors with **Manage Contacts** permissions can rename extended fields.
|
|
138
126
|
*/
|
|
139
127
|
export function updateExtendedField(payload) {
|
|
140
|
-
const { toJSON: toReq, fromJSON: fromReq } = serializer(_updateExtendedFieldRequest, { _extendedField });
|
|
141
|
-
const { fromJSON: fromRes } = serializer(_updateExtendedFieldResponse, {
|
|
142
|
-
_extendedField,
|
|
143
|
-
});
|
|
144
128
|
function __updateExtendedField({ host }) {
|
|
145
|
-
const serializedData =
|
|
129
|
+
const serializedData = transformPaths(payload, [
|
|
130
|
+
{
|
|
131
|
+
transformFn: transformSDKTimestampToRESTTimestamp,
|
|
132
|
+
paths: [{ path: 'field.createdDate' }, { path: 'field.updatedDate' }],
|
|
133
|
+
},
|
|
134
|
+
]);
|
|
146
135
|
const metadata = {
|
|
147
136
|
entityFqdn: 'wix.contacts.v4.extended_field',
|
|
148
137
|
method: 'PATCH',
|
|
@@ -153,11 +142,18 @@ export function updateExtendedField(payload) {
|
|
|
153
142
|
host,
|
|
154
143
|
}),
|
|
155
144
|
data: serializedData,
|
|
156
|
-
transformResponse:
|
|
145
|
+
transformResponse: (payload) => transformPaths(payload, [
|
|
146
|
+
{
|
|
147
|
+
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
148
|
+
paths: [
|
|
149
|
+
{ path: 'field.createdDate' },
|
|
150
|
+
{ path: 'field.updatedDate' },
|
|
151
|
+
],
|
|
152
|
+
},
|
|
153
|
+
]),
|
|
157
154
|
};
|
|
158
155
|
return metadata;
|
|
159
156
|
}
|
|
160
|
-
__updateExtendedField.fromReq = fromReq;
|
|
161
157
|
return __updateExtendedField;
|
|
162
158
|
}
|
|
163
159
|
/**
|
|
@@ -167,70 +163,64 @@ export function updateExtendedField(payload) {
|
|
|
167
163
|
*
|
|
168
164
|
* When an extended field is deleted, any contact data stored in the field is permanently deleted as well.
|
|
169
165
|
*
|
|
170
|
-
* >**Note:** Only visitors with **Manage Contacts** permissions can delete extended fields.
|
|
171
166
|
*/
|
|
172
167
|
export function deleteExtendedField(payload) {
|
|
173
|
-
const { toJSON: toReq, fromJSON: fromReq } = serializer(_deleteExtendedFieldRequest, {});
|
|
174
|
-
const { fromJSON: fromRes } = serializer(_deleteExtendedFieldResponse, {});
|
|
175
168
|
function __deleteExtendedField({ host }) {
|
|
176
|
-
const serializedData = toReq(payload);
|
|
177
169
|
const metadata = {
|
|
178
170
|
entityFqdn: 'wix.contacts.v4.extended_field',
|
|
179
171
|
method: 'DELETE',
|
|
180
172
|
methodFqn: 'com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.DeleteExtendedField',
|
|
181
173
|
url: resolveComWixpressContactsFieldsV4ContactExtendedFieldsServiceV4Url({
|
|
182
174
|
protoPath: '/v4/extended-fields/{key}',
|
|
183
|
-
data:
|
|
175
|
+
data: payload,
|
|
184
176
|
host,
|
|
185
177
|
}),
|
|
186
|
-
params: toURLSearchParams(
|
|
187
|
-
transformResponse: fromRes,
|
|
178
|
+
params: toURLSearchParams(payload),
|
|
188
179
|
};
|
|
189
180
|
return metadata;
|
|
190
181
|
}
|
|
191
|
-
__deleteExtendedField.fromReq = fromReq;
|
|
192
182
|
return __deleteExtendedField;
|
|
193
183
|
}
|
|
194
184
|
/**
|
|
195
185
|
* Creates a query to retrieve a list of extended fields.
|
|
196
186
|
*
|
|
197
|
-
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an
|
|
187
|
+
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an `FieldsQueryBuilder` object.
|
|
198
188
|
*
|
|
199
|
-
* The returned object contains the query definition, which is used to run the query using the
|
|
189
|
+
* The returned object contains the query definition, which is used to run the query using the `find()` function.
|
|
200
190
|
*
|
|
201
191
|
* You can refine the query by chaining `FieldsQueryBuilder` functions onto the query. `FieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
|
|
202
192
|
*
|
|
203
193
|
* `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:
|
|
204
|
-
* -
|
|
205
|
-
* -
|
|
206
|
-
* -
|
|
207
|
-
*
|
|
208
|
-
* > **Note:** Only visitors with **Manage Contacts** permissions can query extended fields.
|
|
194
|
+
* - `skip()`
|
|
195
|
+
* - `limit(50)`
|
|
196
|
+
* - `descending('_createdDate')`
|
|
209
197
|
*
|
|
210
|
-
* The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the
|
|
198
|
+
* The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the `items` property in `FieldsQueryResult`.
|
|
211
199
|
*/
|
|
212
200
|
export function queryExtendedFields(payload) {
|
|
213
|
-
const { toJSON: toReq, fromJSON: fromReq } = serializer(_queryExtendedFieldsRequest, {});
|
|
214
|
-
const { fromJSON: fromRes } = serializer(_queryExtendedFieldsResponse, {
|
|
215
|
-
_extendedField,
|
|
216
|
-
});
|
|
217
201
|
function __queryExtendedFields({ host }) {
|
|
218
|
-
const serializedData = toReq(payload);
|
|
219
202
|
const metadata = {
|
|
220
203
|
entityFqdn: 'wix.contacts.v4.extended_field',
|
|
221
204
|
method: 'POST',
|
|
222
205
|
methodFqn: 'com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.QueryExtendedFields',
|
|
223
206
|
url: resolveComWixpressContactsFieldsV4ContactExtendedFieldsServiceV4Url({
|
|
224
207
|
protoPath: '/v4/extended-fields/query',
|
|
225
|
-
data:
|
|
208
|
+
data: payload,
|
|
226
209
|
host,
|
|
227
210
|
}),
|
|
228
|
-
data:
|
|
229
|
-
transformResponse:
|
|
211
|
+
data: payload,
|
|
212
|
+
transformResponse: (payload) => transformPaths(payload, [
|
|
213
|
+
{
|
|
214
|
+
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
215
|
+
paths: [
|
|
216
|
+
{ path: 'fields.createdDate' },
|
|
217
|
+
{ path: 'fields.updatedDate' },
|
|
218
|
+
],
|
|
219
|
+
},
|
|
220
|
+
]),
|
|
230
221
|
};
|
|
231
222
|
return metadata;
|
|
232
223
|
}
|
|
233
|
-
__queryExtendedFields.fromReq = fromReq;
|
|
234
224
|
return __queryExtendedFields;
|
|
235
225
|
}
|
|
236
226
|
//# sourceMappingURL=contacts-v4-extended-field.http.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts-v4-extended-field.http.js","sourceRoot":"","sources":["../../../src/contacts-v4-extended-field.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"contacts-v4-extended-field.http.js","sourceRoot":"","sources":["../../../src/contacts-v4-extended-field.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAoBhD,SAAS,mEAAmE,CAC1E,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,8BAA8B;gBACvC,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,qBAAqB;aAChC;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAAyC;IAKzC,SAAS,2BAA2B,CAAC,EAAE,IAAI,EAAO;QAChD,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,0FAA0F;YAC5F,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,cAAc,CAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,oCAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,2BAA2B,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAgC;IAIhC,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,iFAAiF;YACnF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,cAAc,CAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,oCAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAmC;IAInC,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,oCAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;aACtE;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,OAAc;YACtB,SAAS,EACP,oFAAoF;YACtF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,iCAAiC;gBAC5C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,cAAc,CAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,oCAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAmC;IAEnC,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,QAAe;YACvB,SAAS,EACP,oFAAoF;YACtF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAmC;IAInC,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,oFAAoF;YACtF,GAAG,EAAE,mEAAmE,CAAC;gBACvE,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,cAAc,CAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,oCAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;wBAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;qBAC/B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,qBAAqB,CAAC;AAC/B,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as ambassadorWixContactsV4ExtendedFieldTypes from './contacts-v4-extended-field.types';
|
|
2
2
|
import * as ambassadorWixContactsV4ExtendedFieldUniversalTypes from './contacts-v4-extended-field.universal';
|
|
3
|
-
export
|
|
3
|
+
export type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
4
4
|
getUrl: (context: any) => string;
|
|
5
5
|
httpMethod: K;
|
|
6
6
|
path: string;
|
|
@@ -19,4 +19,4 @@ export declare function renameExtendedField(httpClient: HttpClient): (key: strin
|
|
|
19
19
|
export declare function deleteExtendedField(httpClient: HttpClient): (key: string) => Promise<void>;
|
|
20
20
|
export declare function queryExtendedFields(httpClient: HttpClient): () => import("./contacts-v4-extended-field.universal").FieldsQueryBuilder;
|
|
21
21
|
export { FieldDataType, FieldType, SortOrder, } from './contacts-v4-extended-field.universal';
|
|
22
|
-
export { ExtendedField, ListExtendedFieldsRequest, Sorting, Paging, ListExtendedFieldsResponse, PagingMetadata, FindOrCreateExtendedFieldRequest, FindOrCreateExtendedFieldResponse, GetExtendedFieldRequest, GetExtendedFieldResponse, GetExtendedFieldByLegacyIdRequest, GetExtendedFieldByLegacyIdResponse, UpdateExtendedFieldRequest, UpdateExtendedFieldResponse, DeleteExtendedFieldRequest, DeleteExtendedFieldResponse, PurgeRequest, PurgeResponse, GdprListRequest, GdprListResponse, QueryExtendedFieldsRequest, Query, QueryExtendedFieldsResponse, FindOrCreateExtendedFieldResponseNonNullableFields, GetExtendedFieldResponseNonNullableFields, UpdateExtendedFieldResponseNonNullableFields, QueryExtendedFieldsResponseNonNullableFields, RenameExtendedField, FieldsQueryResult, FieldsQueryBuilder, } from './contacts-v4-extended-field.universal';
|
|
22
|
+
export { ExtendedField, ListExtendedFieldsRequest, Sorting, Paging, ListExtendedFieldsResponse, PagingMetadata, FindOrCreateExtendedFieldRequest, FindOrCreateExtendedFieldResponse, GetExtendedFieldRequest, GetExtendedFieldResponse, GetExtendedFieldByLegacyIdRequest, GetExtendedFieldByLegacyIdResponse, UpdateExtendedFieldRequest, UpdateExtendedFieldResponse, DeleteExtendedFieldRequest, DeleteExtendedFieldResponse, PurgeRequest, PurgeResponse, GdprListRequest, GdprListResponse, QueryExtendedFieldsRequest, Query, QueryExtendedFieldsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, FindOrCreateExtendedFieldResponseNonNullableFields, GetExtendedFieldResponseNonNullableFields, UpdateExtendedFieldResponseNonNullableFields, QueryExtendedFieldsResponseNonNullableFields, RenameExtendedField, FieldsQueryResult, FieldsQueryBuilder, } from './contacts-v4-extended-field.universal';
|
|
@@ -3,7 +3,7 @@ export interface ExtendedField {
|
|
|
3
3
|
/**
|
|
4
4
|
* Extended field namespace.
|
|
5
5
|
*
|
|
6
|
-
* Extended fields created by site
|
|
6
|
+
* Extended fields created by site collaborators or 3rd-party apps
|
|
7
7
|
* are automatically assigned to the `custom` namespace.
|
|
8
8
|
* @readonly
|
|
9
9
|
*/
|
|
@@ -255,6 +255,73 @@ export interface QueryExtendedFieldsResponse {
|
|
|
255
255
|
/** Details on the paged set of results returned. */
|
|
256
256
|
pagingMetadata?: PagingMetadata;
|
|
257
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
|
+
}
|
|
258
325
|
export interface FindOrCreateExtendedFieldResponseNonNullableFields {
|
|
259
326
|
field?: {
|
|
260
327
|
key: string;
|