@wix/auto_sdk_loyalty_imports 1.0.4 → 1.0.5
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/index.d.mts +88 -0
- package/build/index.d.ts +88 -0
- package/build/index.js +536 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +502 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/index.d.mts +88 -0
- package/build/internal/index.d.ts +88 -0
- package/build/internal/index.js +536 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +502 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/{cjs/src/loyalty-imports-v1-loyalty-import-imports.universal.d.ts → loyalty-imports-v1-loyalty-import-imports.universal-2D8oFVKm.d.mts} +53 -203
- package/build/{cjs/src/loyalty-imports-v1-loyalty-import-imports.universal.d.ts → internal/loyalty-imports-v1-loyalty-import-imports.universal-2D8oFVKm.d.ts} +53 -203
- package/build/{es/src/loyalty-imports-v1-loyalty-import-imports.types.d.ts → internal/meta.d.mts} +50 -231
- package/build/internal/{es/src/loyalty-imports-v1-loyalty-import-imports.types.d.ts → meta.d.ts} +50 -231
- package/build/internal/meta.js +348 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +316 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{es/src/loyalty-imports-v1-loyalty-import-imports.universal.d.ts → loyalty-imports-v1-loyalty-import-imports.universal-2D8oFVKm.d.mts} +53 -203
- package/build/{internal/es/src/loyalty-imports-v1-loyalty-import-imports.universal.d.ts → loyalty-imports-v1-loyalty-import-imports.universal-2D8oFVKm.d.ts} +53 -203
- package/build/{cjs/src/loyalty-imports-v1-loyalty-import-imports.types.d.ts → meta.d.mts} +50 -231
- package/build/{internal/cjs/src/loyalty-imports-v1-loyalty-import-imports.types.d.ts → meta.d.ts} +50 -231
- package/build/meta.js +348 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +316 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- 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/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.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 -338
- 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/package.json +0 -3
- 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 -306
- package/build/es/src/loyalty-imports-v1-loyalty-import-imports.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.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/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.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.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 -338
- 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.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 -306
- package/build/internal/es/src/loyalty-imports-v1-loyalty-import-imports.universal.js.map +0 -1
package/build/internal/{es/src/loyalty-imports-v1-loyalty-import-imports.types.d.ts → meta.d.ts}
RENAMED
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
import { j as CreateLoyaltyImportRequest$1, a as CreateLoyaltyImportResponse$1, k as GetLoyaltyImportRequest$1, l as GetLoyaltyImportResponse$1, m as GetErrorFileDownloadUrlRequest$1, G as GetErrorFileDownloadUrlResponse$1, n as ExecuteLoyaltyImportRequest$1, b as ExecuteLoyaltyImportResponse$1, o as CreateLoyaltyImportFileUrlRequest$1, c as CreateLoyaltyImportFileUrlResponse$1, Q as QueryLoyaltyImportsRequest$1, t as QueryLoyaltyImportsResponse$1 } from './loyalty-imports-v1-loyalty-import-imports.universal-2D8oFVKm.js';
|
|
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. */
|
|
@@ -62,7 +64,7 @@ export declare enum ImportStatus {
|
|
|
62
64
|
/** The import process has failed. */
|
|
63
65
|
FAILED = "FAILED"
|
|
64
66
|
}
|
|
65
|
-
|
|
67
|
+
interface FileMetadata {
|
|
66
68
|
/**
|
|
67
69
|
* Size of the uploaded file in bytes. Max: `10 MB`.
|
|
68
70
|
* @max 104857600
|
|
@@ -95,7 +97,7 @@ export interface FileMetadata {
|
|
|
95
97
|
*/
|
|
96
98
|
sampleDataRows?: SampleDataRow[];
|
|
97
99
|
}
|
|
98
|
-
|
|
100
|
+
interface FileHeader {
|
|
99
101
|
/**
|
|
100
102
|
* Column headings from the first row of the uploaded file.
|
|
101
103
|
* @maxSize 100
|
|
@@ -103,7 +105,7 @@ export interface FileHeader {
|
|
|
103
105
|
*/
|
|
104
106
|
values?: string[];
|
|
105
107
|
}
|
|
106
|
-
|
|
108
|
+
interface HeaderMappingInfo {
|
|
107
109
|
/**
|
|
108
110
|
* Mappings between required loyalty data fields and file columns.
|
|
109
111
|
* Must contain exactly 2 mappings: one for `EMAIL` and one for `POINTS`.
|
|
@@ -112,7 +114,7 @@ export interface HeaderMappingInfo {
|
|
|
112
114
|
*/
|
|
113
115
|
headerMappings?: HeaderMapping[];
|
|
114
116
|
}
|
|
115
|
-
|
|
117
|
+
interface HeaderMapping {
|
|
116
118
|
/** The required loyalty data field that this mapping corresponds to. Must be either `EMAIL` or `POINTS`. */
|
|
117
119
|
columnName?: ColumnName;
|
|
118
120
|
/**
|
|
@@ -121,13 +123,13 @@ export interface HeaderMapping {
|
|
|
121
123
|
*/
|
|
122
124
|
columnIndex?: number;
|
|
123
125
|
}
|
|
124
|
-
|
|
126
|
+
declare enum ColumnName {
|
|
125
127
|
/** Column containing the customer's email address. */
|
|
126
128
|
EMAIL = "EMAIL",
|
|
127
129
|
/** Column containing the customer's loyalty point balance to be imported or updated. */
|
|
128
130
|
POINTS = "POINTS"
|
|
129
131
|
}
|
|
130
|
-
|
|
132
|
+
interface SampleDataRow {
|
|
131
133
|
/**
|
|
132
134
|
* Values in one sample data row. Each value corresponds to a column in the CSV file.
|
|
133
135
|
* The number of values matches the number of columns in the file.
|
|
@@ -136,7 +138,7 @@ export interface SampleDataRow {
|
|
|
136
138
|
*/
|
|
137
139
|
values?: string[];
|
|
138
140
|
}
|
|
139
|
-
|
|
141
|
+
interface ParseResult {
|
|
140
142
|
/**
|
|
141
143
|
* Number of rows parsed from the uploaded import file.
|
|
142
144
|
* @readonly
|
|
@@ -149,7 +151,7 @@ export interface ParseResult {
|
|
|
149
151
|
*/
|
|
150
152
|
parseErrorReason?: string | null;
|
|
151
153
|
}
|
|
152
|
-
|
|
154
|
+
interface ImportResult {
|
|
153
155
|
/** Whether an error file detailing import failures is available for download. The file includes row-by-row import status, error reasons, and original data. */
|
|
154
156
|
errorFileExists?: boolean;
|
|
155
157
|
/**
|
|
@@ -163,7 +165,7 @@ export interface ImportResult {
|
|
|
163
165
|
*/
|
|
164
166
|
failureCount?: number | null;
|
|
165
167
|
}
|
|
166
|
-
|
|
168
|
+
interface CreateLoyaltyImportRequest {
|
|
167
169
|
/** URL of the file to import. */
|
|
168
170
|
fileUrl: string | null;
|
|
169
171
|
/** Name of the file to import. */
|
|
@@ -171,45 +173,45 @@ export interface CreateLoyaltyImportRequest {
|
|
|
171
173
|
/** Size of the file to import, in bytes. */
|
|
172
174
|
fileSize?: number | null;
|
|
173
175
|
}
|
|
174
|
-
|
|
176
|
+
interface CreateLoyaltyImportResponse {
|
|
175
177
|
/** Created loyalty import. */
|
|
176
178
|
loyaltyImport?: LoyaltyImport;
|
|
177
179
|
}
|
|
178
|
-
|
|
180
|
+
interface GetLoyaltyImportRequest {
|
|
179
181
|
/** Loyalty import ID. */
|
|
180
182
|
loyaltyImportId: string;
|
|
181
183
|
}
|
|
182
|
-
|
|
184
|
+
interface GetLoyaltyImportResponse {
|
|
183
185
|
/** Retrieved loyalty import. */
|
|
184
186
|
loyaltyImport?: LoyaltyImport;
|
|
185
187
|
}
|
|
186
|
-
|
|
188
|
+
interface GetErrorFileDownloadUrlRequest {
|
|
187
189
|
/** Loyalty import ID. */
|
|
188
190
|
loyaltyImportId: string;
|
|
189
191
|
}
|
|
190
|
-
|
|
192
|
+
interface GetErrorFileDownloadUrlResponse {
|
|
191
193
|
/** URL for downloading the error file. */
|
|
192
194
|
url?: string | null;
|
|
193
195
|
}
|
|
194
|
-
|
|
196
|
+
interface ExecuteLoyaltyImportRequest {
|
|
195
197
|
/** Loyalty import ID. */
|
|
196
198
|
loyaltyImportId: string;
|
|
197
199
|
/** Header mapping information for the import file. */
|
|
198
200
|
headerMappingInfo?: HeaderMappingInfo;
|
|
199
201
|
}
|
|
200
|
-
|
|
202
|
+
interface ExecuteLoyaltyImportResponse {
|
|
201
203
|
/** Executed loyalty import. */
|
|
202
204
|
loyaltyImport?: LoyaltyImport;
|
|
203
205
|
}
|
|
204
|
-
|
|
206
|
+
interface CreateLoyaltyImportFileUrlRequest {
|
|
205
207
|
}
|
|
206
|
-
|
|
208
|
+
interface CreateLoyaltyImportFileUrlResponse {
|
|
207
209
|
/** Path where the file will be stored. */
|
|
208
210
|
filePath?: string | null;
|
|
209
211
|
/** URL for uploading the loyalty import file. */
|
|
210
212
|
uploadUrl?: string | null;
|
|
211
213
|
}
|
|
212
|
-
|
|
214
|
+
interface QueryLoyaltyImportsRequest {
|
|
213
215
|
/**
|
|
214
216
|
* Filter object.
|
|
215
217
|
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
@@ -220,7 +222,7 @@ export interface QueryLoyaltyImportsRequest {
|
|
|
220
222
|
*/
|
|
221
223
|
query: CursorQuery;
|
|
222
224
|
}
|
|
223
|
-
|
|
225
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
224
226
|
/**
|
|
225
227
|
* Cursor paging options.
|
|
226
228
|
*
|
|
@@ -242,7 +244,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
242
244
|
sort?: Sorting[];
|
|
243
245
|
}
|
|
244
246
|
/** @oneof */
|
|
245
|
-
|
|
247
|
+
interface CursorQueryPagingMethodOneOf {
|
|
246
248
|
/**
|
|
247
249
|
* Cursor paging options.
|
|
248
250
|
*
|
|
@@ -250,7 +252,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
250
252
|
*/
|
|
251
253
|
cursorPaging?: CursorPaging;
|
|
252
254
|
}
|
|
253
|
-
|
|
255
|
+
interface Sorting {
|
|
254
256
|
/**
|
|
255
257
|
* Name of the field to sort by.
|
|
256
258
|
* @maxLength 512
|
|
@@ -259,11 +261,11 @@ export interface Sorting {
|
|
|
259
261
|
/** Sort order. */
|
|
260
262
|
order?: SortOrder;
|
|
261
263
|
}
|
|
262
|
-
|
|
264
|
+
declare enum SortOrder {
|
|
263
265
|
ASC = "ASC",
|
|
264
266
|
DESC = "DESC"
|
|
265
267
|
}
|
|
266
|
-
|
|
268
|
+
interface CursorPaging {
|
|
267
269
|
/**
|
|
268
270
|
* Maximum number of items to return in the results.
|
|
269
271
|
* @max 100
|
|
@@ -278,13 +280,13 @@ export interface CursorPaging {
|
|
|
278
280
|
*/
|
|
279
281
|
cursor?: string | null;
|
|
280
282
|
}
|
|
281
|
-
|
|
283
|
+
interface QueryLoyaltyImportsResponse {
|
|
282
284
|
/** List of loyalty imports matching the query. */
|
|
283
285
|
loyaltyImports?: LoyaltyImport[];
|
|
284
286
|
/** Paging metadata. */
|
|
285
287
|
pagingMetadata?: CursorPagingMetadata;
|
|
286
288
|
}
|
|
287
|
-
|
|
289
|
+
interface CursorPagingMetadata {
|
|
288
290
|
/** Number of items returned in current page. */
|
|
289
291
|
count?: number | null;
|
|
290
292
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -297,7 +299,7 @@ export interface CursorPagingMetadata {
|
|
|
297
299
|
*/
|
|
298
300
|
hasNext?: boolean | null;
|
|
299
301
|
}
|
|
300
|
-
|
|
302
|
+
interface Cursors {
|
|
301
303
|
/**
|
|
302
304
|
* Cursor string pointing to the next page in the list of results.
|
|
303
305
|
* @maxLength 16000
|
|
@@ -309,205 +311,22 @@ export interface Cursors {
|
|
|
309
311
|
*/
|
|
310
312
|
prev?: string | null;
|
|
311
313
|
}
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
}
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
/**
|
|
332
|
-
* Unique event ID.
|
|
333
|
-
* Allows clients to ignore duplicate webhooks.
|
|
334
|
-
*/
|
|
335
|
-
id?: string;
|
|
336
|
-
/**
|
|
337
|
-
* Assumes actions are also always typed to an entity_type
|
|
338
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
339
|
-
*/
|
|
340
|
-
entityFqdn?: string;
|
|
341
|
-
/**
|
|
342
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
343
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
344
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
345
|
-
*/
|
|
346
|
-
slug?: string;
|
|
347
|
-
/** ID of the entity associated with the event. */
|
|
348
|
-
entityId?: string;
|
|
349
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
350
|
-
eventTime?: Date | null;
|
|
351
|
-
/**
|
|
352
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
353
|
-
* (for example, GDPR).
|
|
354
|
-
*/
|
|
355
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
356
|
-
/** If present, indicates the action that triggered the event. */
|
|
357
|
-
originatedFrom?: string | null;
|
|
358
|
-
/**
|
|
359
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
360
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
361
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
362
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
363
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
364
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
365
|
-
*/
|
|
366
|
-
entityEventSequence?: string | null;
|
|
367
|
-
}
|
|
368
|
-
/** @oneof */
|
|
369
|
-
export interface DomainEventBodyOneOf {
|
|
370
|
-
createdEvent?: EntityCreatedEvent;
|
|
371
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
372
|
-
deletedEvent?: EntityDeletedEvent;
|
|
373
|
-
actionEvent?: ActionEvent;
|
|
374
|
-
}
|
|
375
|
-
export interface EntityCreatedEvent {
|
|
376
|
-
entityAsJson?: string;
|
|
377
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
378
|
-
restoreInfo?: RestoreInfo;
|
|
379
|
-
}
|
|
380
|
-
export interface RestoreInfo {
|
|
381
|
-
deletedDate?: Date | null;
|
|
382
|
-
}
|
|
383
|
-
export interface EntityUpdatedEvent {
|
|
384
|
-
/**
|
|
385
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
386
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
387
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
388
|
-
*/
|
|
389
|
-
currentEntityAsJson?: string;
|
|
390
|
-
}
|
|
391
|
-
export interface EntityDeletedEvent {
|
|
392
|
-
/** Entity that was deleted */
|
|
393
|
-
deletedEntityAsJson?: string | null;
|
|
394
|
-
}
|
|
395
|
-
export interface ActionEvent {
|
|
396
|
-
bodyAsJson?: string;
|
|
397
|
-
}
|
|
398
|
-
export interface Empty {
|
|
399
|
-
}
|
|
400
|
-
export interface ImportFinished {
|
|
401
|
-
/** Completed loyalty import. */
|
|
402
|
-
loyaltyImport?: LoyaltyImport;
|
|
403
|
-
}
|
|
404
|
-
export interface MessageEnvelope {
|
|
405
|
-
/**
|
|
406
|
-
* App instance ID.
|
|
407
|
-
* @format GUID
|
|
408
|
-
*/
|
|
409
|
-
instanceId?: string | null;
|
|
410
|
-
/**
|
|
411
|
-
* Event type.
|
|
412
|
-
* @maxLength 150
|
|
413
|
-
*/
|
|
414
|
-
eventType?: string;
|
|
415
|
-
/** The identification type and identity data. */
|
|
416
|
-
identity?: IdentificationData;
|
|
417
|
-
/** Stringify payload. */
|
|
418
|
-
data?: string;
|
|
419
|
-
}
|
|
420
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
421
|
-
/**
|
|
422
|
-
* ID of a site visitor that has not logged in to the site.
|
|
423
|
-
* @format GUID
|
|
424
|
-
*/
|
|
425
|
-
anonymousVisitorId?: string;
|
|
426
|
-
/**
|
|
427
|
-
* ID of a site visitor that has logged in to the site.
|
|
428
|
-
* @format GUID
|
|
429
|
-
*/
|
|
430
|
-
memberId?: string;
|
|
431
|
-
/**
|
|
432
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
433
|
-
* @format GUID
|
|
434
|
-
*/
|
|
435
|
-
wixUserId?: string;
|
|
436
|
-
/**
|
|
437
|
-
* ID of an app.
|
|
438
|
-
* @format GUID
|
|
439
|
-
*/
|
|
440
|
-
appId?: string;
|
|
441
|
-
/** @readonly */
|
|
442
|
-
identityType?: WebhookIdentityType;
|
|
443
|
-
}
|
|
444
|
-
/** @oneof */
|
|
445
|
-
export interface IdentificationDataIdOneOf {
|
|
446
|
-
/**
|
|
447
|
-
* ID of a site visitor that has not logged in to the site.
|
|
448
|
-
* @format GUID
|
|
449
|
-
*/
|
|
450
|
-
anonymousVisitorId?: string;
|
|
451
|
-
/**
|
|
452
|
-
* ID of a site visitor that has logged in to the site.
|
|
453
|
-
* @format GUID
|
|
454
|
-
*/
|
|
455
|
-
memberId?: string;
|
|
456
|
-
/**
|
|
457
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
458
|
-
* @format GUID
|
|
459
|
-
*/
|
|
460
|
-
wixUserId?: string;
|
|
461
|
-
/**
|
|
462
|
-
* ID of an app.
|
|
463
|
-
* @format GUID
|
|
464
|
-
*/
|
|
465
|
-
appId?: string;
|
|
466
|
-
}
|
|
467
|
-
export declare enum WebhookIdentityType {
|
|
468
|
-
UNKNOWN = "UNKNOWN",
|
|
469
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
470
|
-
MEMBER = "MEMBER",
|
|
471
|
-
WIX_USER = "WIX_USER",
|
|
472
|
-
APP = "APP"
|
|
473
|
-
}
|
|
474
|
-
interface FileHeaderNonNullableFields {
|
|
475
|
-
values: string[];
|
|
476
|
-
}
|
|
477
|
-
interface HeaderMappingNonNullableFields {
|
|
478
|
-
columnName: ColumnName;
|
|
479
|
-
columnIndex: number;
|
|
480
|
-
}
|
|
481
|
-
interface HeaderMappingInfoNonNullableFields {
|
|
482
|
-
headerMappings: HeaderMappingNonNullableFields[];
|
|
483
|
-
}
|
|
484
|
-
interface SampleDataRowNonNullableFields {
|
|
485
|
-
values: string[];
|
|
486
|
-
}
|
|
487
|
-
interface FileMetadataNonNullableFields {
|
|
488
|
-
url: string;
|
|
489
|
-
header?: FileHeaderNonNullableFields;
|
|
490
|
-
headerMappingInfo?: HeaderMappingInfoNonNullableFields;
|
|
491
|
-
sampleDataRows: SampleDataRowNonNullableFields[];
|
|
492
|
-
}
|
|
493
|
-
interface ImportResultNonNullableFields {
|
|
494
|
-
errorFileExists: boolean;
|
|
495
|
-
}
|
|
496
|
-
interface LoyaltyImportNonNullableFields {
|
|
497
|
-
status: ImportStatus;
|
|
498
|
-
fileMetadata?: FileMetadataNonNullableFields;
|
|
499
|
-
importResult?: ImportResultNonNullableFields;
|
|
500
|
-
}
|
|
501
|
-
export interface CreateLoyaltyImportResponseNonNullableFields {
|
|
502
|
-
loyaltyImport?: LoyaltyImportNonNullableFields;
|
|
503
|
-
}
|
|
504
|
-
export interface GetLoyaltyImportResponseNonNullableFields {
|
|
505
|
-
loyaltyImport?: LoyaltyImportNonNullableFields;
|
|
506
|
-
}
|
|
507
|
-
export interface ExecuteLoyaltyImportResponseNonNullableFields {
|
|
508
|
-
loyaltyImport?: LoyaltyImportNonNullableFields;
|
|
509
|
-
}
|
|
510
|
-
export interface QueryLoyaltyImportsResponseNonNullableFields {
|
|
511
|
-
loyaltyImports: LoyaltyImportNonNullableFields[];
|
|
512
|
-
}
|
|
513
|
-
export {};
|
|
314
|
+
|
|
315
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
316
|
+
getUrl: (context: any) => string;
|
|
317
|
+
httpMethod: K;
|
|
318
|
+
path: string;
|
|
319
|
+
pathParams: M;
|
|
320
|
+
__requestType: T;
|
|
321
|
+
__originalRequestType: S;
|
|
322
|
+
__responseType: Q;
|
|
323
|
+
__originalResponseType: R;
|
|
324
|
+
};
|
|
325
|
+
declare function createLoyaltyImport(): __PublicMethodMetaInfo<'POST', {}, CreateLoyaltyImportRequest$1, CreateLoyaltyImportRequest, CreateLoyaltyImportResponse$1, CreateLoyaltyImportResponse>;
|
|
326
|
+
declare function getLoyaltyImport(): __PublicMethodMetaInfo<'GET', {}, GetLoyaltyImportRequest$1, GetLoyaltyImportRequest, GetLoyaltyImportResponse$1, GetLoyaltyImportResponse>;
|
|
327
|
+
declare function getErrorFileDownloadUrl(): __PublicMethodMetaInfo<'GET', {}, GetErrorFileDownloadUrlRequest$1, GetErrorFileDownloadUrlRequest, GetErrorFileDownloadUrlResponse$1, GetErrorFileDownloadUrlResponse>;
|
|
328
|
+
declare function executeLoyaltyImport(): __PublicMethodMetaInfo<'POST', {}, ExecuteLoyaltyImportRequest$1, ExecuteLoyaltyImportRequest, ExecuteLoyaltyImportResponse$1, ExecuteLoyaltyImportResponse>;
|
|
329
|
+
declare function createLoyaltyImportFileUrl(): __PublicMethodMetaInfo<'POST', {}, CreateLoyaltyImportFileUrlRequest$1, CreateLoyaltyImportFileUrlRequest, CreateLoyaltyImportFileUrlResponse$1, CreateLoyaltyImportFileUrlResponse>;
|
|
330
|
+
declare function queryLoyaltyImports(): __PublicMethodMetaInfo<'POST', {}, QueryLoyaltyImportsRequest$1, QueryLoyaltyImportsRequest, QueryLoyaltyImportsResponse$1, QueryLoyaltyImportsResponse>;
|
|
331
|
+
|
|
332
|
+
export { type __PublicMethodMetaInfo, createLoyaltyImport, createLoyaltyImportFileUrl, executeLoyaltyImport, getErrorFileDownloadUrl, getLoyaltyImport, queryLoyaltyImports };
|