@wix/auto_sdk_loyalty_imports 1.0.12 → 1.0.14
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/index.d.ts +88 -1
- package/build/cjs/index.js +536 -15
- package/build/cjs/index.js.map +1 -1
- package/build/{internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.universal.d.ts → cjs/loyalty-imports-v1-loyalty-import-imports.universal-CPUezeMW.d.ts} +57 -174
- package/build/cjs/meta.d.ts +338 -1
- package/build/cjs/meta.js +345 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +88 -0
- package/build/es/index.mjs +505 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{cjs/src/loyalty-imports-v1-loyalty-import-imports.universal.d.ts → es/loyalty-imports-v1-loyalty-import-imports.universal-CPUezeMW.d.mts} +57 -174
- package/build/es/{src/loyalty-imports-v1-loyalty-import-imports.types.d.ts → meta.d.mts} +53 -188
- package/build/es/meta.mjs +316 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +88 -1
- package/build/internal/cjs/index.js +536 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/{es/src/loyalty-imports-v1-loyalty-import-imports.universal.d.ts → internal/cjs/loyalty-imports-v1-loyalty-import-imports.universal-CPUezeMW.d.ts} +57 -174
- package/build/internal/cjs/meta.d.ts +338 -1
- package/build/internal/cjs/meta.js +345 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +88 -0
- package/build/internal/es/index.mjs +505 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/{src/loyalty-imports-v1-loyalty-import-imports.universal.d.ts → loyalty-imports-v1-loyalty-import-imports.universal-CPUezeMW.d.mts} +57 -174
- package/build/{cjs/src/loyalty-imports-v1-loyalty-import-imports.types.d.ts → internal/es/meta.d.mts} +53 -188
- package/build/internal/es/meta.mjs +316 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +10 -9
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.context.d.ts +0 -16
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.context.js +0 -23
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.context.js.map +0 -1
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.http.d.ts +0 -46
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.http.js +0 -243
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.http.js.map +0 -1
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.meta.d.ts +0 -18
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.meta.js +0 -142
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.meta.js.map +0 -1
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.public.d.ts +0 -77
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.public.js +0 -61
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.public.js.map +0 -1
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.types.js +0 -41
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.types.js.map +0 -1
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.universal.js +0 -340
- package/build/cjs/src/loyalty-imports-v1-loyalty-import-imports.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.context.d.ts +0 -16
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.context.js +0 -16
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.context.js.map +0 -1
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.http.d.ts +0 -46
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.http.js +0 -234
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.http.js.map +0 -1
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.meta.d.ts +0 -18
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.meta.js +0 -110
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.meta.js.map +0 -1
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.public.d.ts +0 -77
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.public.js +0 -48
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.public.js.map +0 -1
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.types.js +0 -38
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.types.js.map +0 -1
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.universal.js +0 -308
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.universal.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.context.d.ts +0 -16
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.context.js +0 -23
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.context.js.map +0 -1
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.http.d.ts +0 -46
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.http.js +0 -243
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.http.js.map +0 -1
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.meta.d.ts +0 -18
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.meta.js +0 -142
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.meta.js.map +0 -1
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.public.d.ts +0 -77
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.public.js +0 -61
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.public.js.map +0 -1
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.types.d.ts +0 -473
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.types.js +0 -41
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.types.js.map +0 -1
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.universal.js +0 -340
- package/build/internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.context.d.ts +0 -16
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.context.js +0 -16
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.context.js.map +0 -1
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.http.d.ts +0 -46
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.http.js +0 -234
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.http.js.map +0 -1
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.meta.d.ts +0 -18
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.meta.js +0 -110
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.meta.js.map +0 -1
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.public.d.ts +0 -77
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.public.js +0 -48
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.public.js.map +0 -1
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.types.d.ts +0 -473
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.types.js +0 -38
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.types.js.map +0 -1
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.universal.js +0 -308
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.universal.js.map +0 -1
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
import { k as CreateLoyaltyImportRequest$1, a as CreateLoyaltyImportResponse$1, l as GetLoyaltyImportRequest$1, m as GetLoyaltyImportResponse$1, n as GetErrorFileDownloadUrlRequest$1, G as GetErrorFileDownloadUrlResponse$1, o as ExecuteLoyaltyImportRequest$1, b as ExecuteLoyaltyImportResponse$1, p as CreateLoyaltyImportFileUrlRequest$1, c as CreateLoyaltyImportFileUrlResponse$1, Q as QueryLoyaltyImportsRequest$1, u as QueryLoyaltyImportsResponse$1 } from './loyalty-imports-v1-loyalty-import-imports.universal-CPUezeMW.mjs';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* An Import object is a batch import of loyalty points for existing customers.
|
|
3
5
|
* You can use Loyalty Imports to import loyalty points from 3rd-party providers or update existing customer point balances.
|
|
4
6
|
* This object tracks the entire import process from file upload to data processing.
|
|
5
7
|
*/
|
|
6
|
-
|
|
8
|
+
interface LoyaltyImport {
|
|
7
9
|
/**
|
|
8
10
|
* The ID of the import.
|
|
9
11
|
* @format GUID
|
|
@@ -46,7 +48,7 @@ export interface LoyaltyImport {
|
|
|
46
48
|
/** Results of the import process, including success and failure counts. */
|
|
47
49
|
importResult?: ImportResult;
|
|
48
50
|
}
|
|
49
|
-
|
|
51
|
+
declare enum ImportStatus {
|
|
50
52
|
/** Status is unknown or not specified. */
|
|
51
53
|
UNKNOWN = "UNKNOWN",
|
|
52
54
|
/** The import has been initiated but processing has not yet begun. */
|
|
@@ -63,8 +65,8 @@ export declare enum ImportStatus {
|
|
|
63
65
|
FAILED = "FAILED"
|
|
64
66
|
}
|
|
65
67
|
/** @enumType */
|
|
66
|
-
|
|
67
|
-
|
|
68
|
+
type ImportStatusWithLiterals = ImportStatus | 'UNKNOWN' | 'INITIATED' | 'PARSING' | 'PARSED' | 'IMPORTING' | 'IMPORTED' | 'FAILED';
|
|
69
|
+
interface FileMetadata {
|
|
68
70
|
/**
|
|
69
71
|
* Size of the uploaded file in bytes. Max: `10 MB`.
|
|
70
72
|
* @max 104857600
|
|
@@ -97,7 +99,7 @@ export interface FileMetadata {
|
|
|
97
99
|
*/
|
|
98
100
|
sampleDataRows?: SampleDataRow[];
|
|
99
101
|
}
|
|
100
|
-
|
|
102
|
+
interface FileHeader {
|
|
101
103
|
/**
|
|
102
104
|
* Column headings from the first row of the uploaded file.
|
|
103
105
|
* @maxSize 100
|
|
@@ -105,7 +107,7 @@ export interface FileHeader {
|
|
|
105
107
|
*/
|
|
106
108
|
values?: string[];
|
|
107
109
|
}
|
|
108
|
-
|
|
110
|
+
interface HeaderMappingInfo {
|
|
109
111
|
/**
|
|
110
112
|
* Mappings between required loyalty data fields and file columns.
|
|
111
113
|
* Must contain exactly 2 mappings: one for `EMAIL` and one for `POINTS`.
|
|
@@ -114,7 +116,7 @@ export interface HeaderMappingInfo {
|
|
|
114
116
|
*/
|
|
115
117
|
headerMappings?: HeaderMapping[];
|
|
116
118
|
}
|
|
117
|
-
|
|
119
|
+
interface HeaderMapping {
|
|
118
120
|
/** The required loyalty data field that this mapping corresponds to. Must be either `EMAIL` or `POINTS`. */
|
|
119
121
|
columnName?: ColumnNameWithLiterals;
|
|
120
122
|
/**
|
|
@@ -123,15 +125,15 @@ export interface HeaderMapping {
|
|
|
123
125
|
*/
|
|
124
126
|
columnIndex?: number;
|
|
125
127
|
}
|
|
126
|
-
|
|
128
|
+
declare enum ColumnName {
|
|
127
129
|
/** Column containing the customer's email address. */
|
|
128
130
|
EMAIL = "EMAIL",
|
|
129
131
|
/** Column containing the customer's loyalty point balance to be imported or updated. */
|
|
130
132
|
POINTS = "POINTS"
|
|
131
133
|
}
|
|
132
134
|
/** @enumType */
|
|
133
|
-
|
|
134
|
-
|
|
135
|
+
type ColumnNameWithLiterals = ColumnName | 'EMAIL' | 'POINTS';
|
|
136
|
+
interface SampleDataRow {
|
|
135
137
|
/**
|
|
136
138
|
* Values in one sample data row. Each value corresponds to a column in the CSV file.
|
|
137
139
|
* The number of values matches the number of columns in the file.
|
|
@@ -140,7 +142,7 @@ export interface SampleDataRow {
|
|
|
140
142
|
*/
|
|
141
143
|
values?: string[];
|
|
142
144
|
}
|
|
143
|
-
|
|
145
|
+
interface ParseResult {
|
|
144
146
|
/**
|
|
145
147
|
* Number of rows parsed from the uploaded import file.
|
|
146
148
|
* @readonly
|
|
@@ -153,7 +155,7 @@ export interface ParseResult {
|
|
|
153
155
|
*/
|
|
154
156
|
parseErrorReason?: string | null;
|
|
155
157
|
}
|
|
156
|
-
|
|
158
|
+
interface ImportResult {
|
|
157
159
|
/** Whether an error file detailing import failures is available for download. The file includes row-by-row import status, error reasons, and original data. */
|
|
158
160
|
errorFileExists?: boolean;
|
|
159
161
|
/**
|
|
@@ -167,7 +169,7 @@ export interface ImportResult {
|
|
|
167
169
|
*/
|
|
168
170
|
failureCount?: number | null;
|
|
169
171
|
}
|
|
170
|
-
|
|
172
|
+
interface CreateLoyaltyImportRequest {
|
|
171
173
|
/** URL of the file to import. */
|
|
172
174
|
fileUrl: string | null;
|
|
173
175
|
/** Name of the file to import. */
|
|
@@ -175,45 +177,45 @@ export interface CreateLoyaltyImportRequest {
|
|
|
175
177
|
/** Size of the file to import, in bytes. */
|
|
176
178
|
fileSize?: number | null;
|
|
177
179
|
}
|
|
178
|
-
|
|
180
|
+
interface CreateLoyaltyImportResponse {
|
|
179
181
|
/** Created loyalty import. */
|
|
180
182
|
loyaltyImport?: LoyaltyImport;
|
|
181
183
|
}
|
|
182
|
-
|
|
184
|
+
interface GetLoyaltyImportRequest {
|
|
183
185
|
/** Loyalty import ID. */
|
|
184
186
|
loyaltyImportId: string;
|
|
185
187
|
}
|
|
186
|
-
|
|
188
|
+
interface GetLoyaltyImportResponse {
|
|
187
189
|
/** Retrieved loyalty import. */
|
|
188
190
|
loyaltyImport?: LoyaltyImport;
|
|
189
191
|
}
|
|
190
|
-
|
|
192
|
+
interface GetErrorFileDownloadUrlRequest {
|
|
191
193
|
/** Loyalty import ID. */
|
|
192
194
|
loyaltyImportId: string;
|
|
193
195
|
}
|
|
194
|
-
|
|
196
|
+
interface GetErrorFileDownloadUrlResponse {
|
|
195
197
|
/** URL for downloading the error file. */
|
|
196
198
|
url?: string | null;
|
|
197
199
|
}
|
|
198
|
-
|
|
200
|
+
interface ExecuteLoyaltyImportRequest {
|
|
199
201
|
/** Loyalty import ID. */
|
|
200
202
|
loyaltyImportId: string;
|
|
201
203
|
/** Header mapping information for the import file. */
|
|
202
204
|
headerMappingInfo?: HeaderMappingInfo;
|
|
203
205
|
}
|
|
204
|
-
|
|
206
|
+
interface ExecuteLoyaltyImportResponse {
|
|
205
207
|
/** Executed loyalty import. */
|
|
206
208
|
loyaltyImport?: LoyaltyImport;
|
|
207
209
|
}
|
|
208
|
-
|
|
210
|
+
interface CreateLoyaltyImportFileUrlRequest {
|
|
209
211
|
}
|
|
210
|
-
|
|
212
|
+
interface CreateLoyaltyImportFileUrlResponse {
|
|
211
213
|
/** Path where the file will be stored. */
|
|
212
214
|
filePath?: string | null;
|
|
213
215
|
/** URL for uploading the loyalty import file. */
|
|
214
216
|
uploadUrl?: string | null;
|
|
215
217
|
}
|
|
216
|
-
|
|
218
|
+
interface QueryLoyaltyImportsRequest {
|
|
217
219
|
/**
|
|
218
220
|
* Filter object.
|
|
219
221
|
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
@@ -224,7 +226,7 @@ export interface QueryLoyaltyImportsRequest {
|
|
|
224
226
|
*/
|
|
225
227
|
query: CursorQuery;
|
|
226
228
|
}
|
|
227
|
-
|
|
229
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
228
230
|
/**
|
|
229
231
|
* Cursor paging options.
|
|
230
232
|
*
|
|
@@ -246,7 +248,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
246
248
|
sort?: Sorting[];
|
|
247
249
|
}
|
|
248
250
|
/** @oneof */
|
|
249
|
-
|
|
251
|
+
interface CursorQueryPagingMethodOneOf {
|
|
250
252
|
/**
|
|
251
253
|
* Cursor paging options.
|
|
252
254
|
*
|
|
@@ -254,7 +256,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
254
256
|
*/
|
|
255
257
|
cursorPaging?: CursorPaging;
|
|
256
258
|
}
|
|
257
|
-
|
|
259
|
+
interface Sorting {
|
|
258
260
|
/**
|
|
259
261
|
* Name of the field to sort by.
|
|
260
262
|
* @maxLength 512
|
|
@@ -263,13 +265,13 @@ export interface Sorting {
|
|
|
263
265
|
/** Sort order. */
|
|
264
266
|
order?: SortOrderWithLiterals;
|
|
265
267
|
}
|
|
266
|
-
|
|
268
|
+
declare enum SortOrder {
|
|
267
269
|
ASC = "ASC",
|
|
268
270
|
DESC = "DESC"
|
|
269
271
|
}
|
|
270
272
|
/** @enumType */
|
|
271
|
-
|
|
272
|
-
|
|
273
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
274
|
+
interface CursorPaging {
|
|
273
275
|
/**
|
|
274
276
|
* Maximum number of items to return in the results.
|
|
275
277
|
* @max 100
|
|
@@ -284,13 +286,13 @@ export interface CursorPaging {
|
|
|
284
286
|
*/
|
|
285
287
|
cursor?: string | null;
|
|
286
288
|
}
|
|
287
|
-
|
|
289
|
+
interface QueryLoyaltyImportsResponse {
|
|
288
290
|
/** List of loyalty imports matching the query. */
|
|
289
291
|
loyaltyImports?: LoyaltyImport[];
|
|
290
292
|
/** Paging metadata. */
|
|
291
293
|
pagingMetadata?: CursorPagingMetadata;
|
|
292
294
|
}
|
|
293
|
-
|
|
295
|
+
interface CursorPagingMetadata {
|
|
294
296
|
/** Number of items returned in current page. */
|
|
295
297
|
count?: number | null;
|
|
296
298
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -303,7 +305,7 @@ export interface CursorPagingMetadata {
|
|
|
303
305
|
*/
|
|
304
306
|
hasNext?: boolean | null;
|
|
305
307
|
}
|
|
306
|
-
|
|
308
|
+
interface Cursors {
|
|
307
309
|
/**
|
|
308
310
|
* Cursor string pointing to the next page in the list of results.
|
|
309
311
|
* @maxLength 16000
|
|
@@ -315,159 +317,22 @@ export interface Cursors {
|
|
|
315
317
|
*/
|
|
316
318
|
prev?: string | null;
|
|
317
319
|
}
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
}
|
|
330
|
-
|
|
331
|
-
}
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
338
|
-
id?: string;
|
|
339
|
-
/**
|
|
340
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
341
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
342
|
-
*/
|
|
343
|
-
entityFqdn?: string;
|
|
344
|
-
/**
|
|
345
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
346
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
347
|
-
*/
|
|
348
|
-
slug?: string;
|
|
349
|
-
/** ID of the entity associated with the event. */
|
|
350
|
-
entityId?: string;
|
|
351
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
352
|
-
eventTime?: Date | null;
|
|
353
|
-
/**
|
|
354
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
355
|
-
* (for example, GDPR).
|
|
356
|
-
*/
|
|
357
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
358
|
-
/** If present, indicates the action that triggered the event. */
|
|
359
|
-
originatedFrom?: string | null;
|
|
360
|
-
/**
|
|
361
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
362
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
363
|
-
*/
|
|
364
|
-
entityEventSequence?: string | null;
|
|
365
|
-
}
|
|
366
|
-
/** @oneof */
|
|
367
|
-
export interface DomainEventBodyOneOf {
|
|
368
|
-
createdEvent?: EntityCreatedEvent;
|
|
369
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
370
|
-
deletedEvent?: EntityDeletedEvent;
|
|
371
|
-
actionEvent?: ActionEvent;
|
|
372
|
-
}
|
|
373
|
-
export interface EntityCreatedEvent {
|
|
374
|
-
entityAsJson?: string;
|
|
375
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
376
|
-
restoreInfo?: RestoreInfo;
|
|
377
|
-
}
|
|
378
|
-
export interface RestoreInfo {
|
|
379
|
-
deletedDate?: Date | null;
|
|
380
|
-
}
|
|
381
|
-
export interface EntityUpdatedEvent {
|
|
382
|
-
/**
|
|
383
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
384
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
385
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
386
|
-
*/
|
|
387
|
-
currentEntityAsJson?: string;
|
|
388
|
-
}
|
|
389
|
-
export interface EntityDeletedEvent {
|
|
390
|
-
/** Entity that was deleted. */
|
|
391
|
-
deletedEntityAsJson?: string | null;
|
|
392
|
-
}
|
|
393
|
-
export interface ActionEvent {
|
|
394
|
-
bodyAsJson?: string;
|
|
395
|
-
}
|
|
396
|
-
export interface Empty {
|
|
397
|
-
}
|
|
398
|
-
export interface ImportFinished {
|
|
399
|
-
/** Completed loyalty import. */
|
|
400
|
-
loyaltyImport?: LoyaltyImport;
|
|
401
|
-
}
|
|
402
|
-
export interface MessageEnvelope {
|
|
403
|
-
/**
|
|
404
|
-
* App instance ID.
|
|
405
|
-
* @format GUID
|
|
406
|
-
*/
|
|
407
|
-
instanceId?: string | null;
|
|
408
|
-
/**
|
|
409
|
-
* Event type.
|
|
410
|
-
* @maxLength 150
|
|
411
|
-
*/
|
|
412
|
-
eventType?: string;
|
|
413
|
-
/** The identification type and identity data. */
|
|
414
|
-
identity?: IdentificationData;
|
|
415
|
-
/** Stringify payload. */
|
|
416
|
-
data?: string;
|
|
417
|
-
}
|
|
418
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
419
|
-
/**
|
|
420
|
-
* ID of a site visitor that has not logged in to the site.
|
|
421
|
-
* @format GUID
|
|
422
|
-
*/
|
|
423
|
-
anonymousVisitorId?: string;
|
|
424
|
-
/**
|
|
425
|
-
* ID of a site visitor that has logged in to the site.
|
|
426
|
-
* @format GUID
|
|
427
|
-
*/
|
|
428
|
-
memberId?: string;
|
|
429
|
-
/**
|
|
430
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
431
|
-
* @format GUID
|
|
432
|
-
*/
|
|
433
|
-
wixUserId?: string;
|
|
434
|
-
/**
|
|
435
|
-
* ID of an app.
|
|
436
|
-
* @format GUID
|
|
437
|
-
*/
|
|
438
|
-
appId?: string;
|
|
439
|
-
/** @readonly */
|
|
440
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
441
|
-
}
|
|
442
|
-
/** @oneof */
|
|
443
|
-
export interface IdentificationDataIdOneOf {
|
|
444
|
-
/**
|
|
445
|
-
* ID of a site visitor that has not logged in to the site.
|
|
446
|
-
* @format GUID
|
|
447
|
-
*/
|
|
448
|
-
anonymousVisitorId?: string;
|
|
449
|
-
/**
|
|
450
|
-
* ID of a site visitor that has logged in to the site.
|
|
451
|
-
* @format GUID
|
|
452
|
-
*/
|
|
453
|
-
memberId?: string;
|
|
454
|
-
/**
|
|
455
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
456
|
-
* @format GUID
|
|
457
|
-
*/
|
|
458
|
-
wixUserId?: string;
|
|
459
|
-
/**
|
|
460
|
-
* ID of an app.
|
|
461
|
-
* @format GUID
|
|
462
|
-
*/
|
|
463
|
-
appId?: string;
|
|
464
|
-
}
|
|
465
|
-
export declare enum WebhookIdentityType {
|
|
466
|
-
UNKNOWN = "UNKNOWN",
|
|
467
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
468
|
-
MEMBER = "MEMBER",
|
|
469
|
-
WIX_USER = "WIX_USER",
|
|
470
|
-
APP = "APP"
|
|
471
|
-
}
|
|
472
|
-
/** @enumType */
|
|
473
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
320
|
+
|
|
321
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
322
|
+
getUrl: (context: any) => string;
|
|
323
|
+
httpMethod: K;
|
|
324
|
+
path: string;
|
|
325
|
+
pathParams: M;
|
|
326
|
+
__requestType: T;
|
|
327
|
+
__originalRequestType: S;
|
|
328
|
+
__responseType: Q;
|
|
329
|
+
__originalResponseType: R;
|
|
330
|
+
};
|
|
331
|
+
declare function createLoyaltyImport(): __PublicMethodMetaInfo<'POST', {}, CreateLoyaltyImportRequest$1, CreateLoyaltyImportRequest, CreateLoyaltyImportResponse$1, CreateLoyaltyImportResponse>;
|
|
332
|
+
declare function getLoyaltyImport(): __PublicMethodMetaInfo<'GET', {}, GetLoyaltyImportRequest$1, GetLoyaltyImportRequest, GetLoyaltyImportResponse$1, GetLoyaltyImportResponse>;
|
|
333
|
+
declare function getErrorFileDownloadUrl(): __PublicMethodMetaInfo<'GET', {}, GetErrorFileDownloadUrlRequest$1, GetErrorFileDownloadUrlRequest, GetErrorFileDownloadUrlResponse$1, GetErrorFileDownloadUrlResponse>;
|
|
334
|
+
declare function executeLoyaltyImport(): __PublicMethodMetaInfo<'POST', {}, ExecuteLoyaltyImportRequest$1, ExecuteLoyaltyImportRequest, ExecuteLoyaltyImportResponse$1, ExecuteLoyaltyImportResponse>;
|
|
335
|
+
declare function createLoyaltyImportFileUrl(): __PublicMethodMetaInfo<'POST', {}, CreateLoyaltyImportFileUrlRequest$1, CreateLoyaltyImportFileUrlRequest, CreateLoyaltyImportFileUrlResponse$1, CreateLoyaltyImportFileUrlResponse>;
|
|
336
|
+
declare function queryLoyaltyImports(): __PublicMethodMetaInfo<'POST', {}, QueryLoyaltyImportsRequest$1, QueryLoyaltyImportsRequest, QueryLoyaltyImportsResponse$1, QueryLoyaltyImportsResponse>;
|
|
337
|
+
|
|
338
|
+
export { type __PublicMethodMetaInfo, createLoyaltyImport, createLoyaltyImportFileUrl, executeLoyaltyImport, getErrorFileDownloadUrl, getLoyaltyImport, queryLoyaltyImports };
|