@adobe/aio-commerce-lib-events 0.3.6 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/dist/cjs/chunk-BZ64pZp-.cjs +1 -0
  3. package/dist/cjs/commerce/index.cjs +1 -14
  4. package/dist/cjs/commerce/index.d.cts +60 -98
  5. package/dist/cjs/io-events/index.cjs +1 -14
  6. package/dist/cjs/io-events/index.d.cts +436 -1911
  7. package/dist/es/chunk-BKfb2J6I.mjs +1 -0
  8. package/dist/es/commerce/index.d.mts +67 -105
  9. package/dist/es/commerce/index.mjs +1 -14
  10. package/dist/es/io-events/index.d.mts +437 -1912
  11. package/dist/es/io-events/index.mjs +1 -14
  12. package/package.json +5 -4
  13. package/dist/cjs/schemas-CwY-HoKq.cjs +0 -14
  14. package/dist/es/schemas-D5c1tsDe.mjs +0 -14
package/dist/cjs/io-events/index.d.cts CHANGED
@@ -1,45 +1,77 @@
1
- /**
2
- * @license
3
- *
4
- * Copyright 2025 Adobe. All rights reserved.
5
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
6
- * you may not use this file except in compliance with the License. You may obtain a copy
7
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
8
- *
9
- * Unless required by applicable law or agreed to in writing, software distributed under
10
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
11
- * OF ANY KIND, either express or implied. See the License for the specific language
12
- * governing permissions and limitations under the License.
13
- */
14
-
15
1
  import * as _adobe_aio_commerce_lib_api1 from "@adobe/aio-commerce-lib-api";
16
2
  import { AdobeIoEventsHttpClient, ApiFunction, IoEventsHttpClientParams } from "@adobe/aio-commerce-lib-api";
17
3
  import { Options } from "@adobe/aio-commerce-lib-api/ky";
18
4
  import * as v from "valibot";
19
- import * as type_fest0 from "type-fest";
20
- import { CamelCasedPropertiesDeep, OmitDeep } from "type-fest";
21
5
  import * as ky4 from "ky";
6
+ import * as type_fest0 from "type-fest";
7
+ import { OmitDeep } from "type-fest";
22
8
 
9
+ //#region source/io-events/types.d.ts
10
+ type HALLink = {
11
+ href: string;
12
+ templated?: boolean;
13
+ type?: string;
14
+ deprecation?: string;
15
+ name?: string;
16
+ profile?: string;
17
+ title?: string;
18
+ hreflang?: string;
19
+ seen?: string;
20
+ };
21
+ //#endregion
22
+ //#region source/io-events/api/event-metadata/types.d.ts
23
+ /** Defines the base fields of an event metadata entity. */
24
+ type IoEventMetadata = {
25
+ description: string;
26
+ label: string;
27
+ event_code: string;
28
+ };
29
+ /** Defines the fields of a sample event entity returned by the Adobe I/O Events API. */
30
+ type SampleEventHalModel = {
31
+ format: string;
32
+ sample_payload?: string;
33
+ _links: {
34
+ self: HALLink;
35
+ };
36
+ };
37
+ /** Defines the fields of an event metadata entity returned by the Adobe I/O Events API. */
38
+ type IoEventMetadataHalModel = IoEventMetadata & {
39
+ _embedded?: {
40
+ sample_event?: SampleEventHalModel;
41
+ };
42
+ _links: {
43
+ "rel:sample_event"?: HALLink;
44
+ "rel:update"?: HALLink;
45
+ self: HALLink;
46
+ };
47
+ };
48
+ /** Defines the fields of an event metadata entity returned by the Adobe I/O Events API. */
49
+ type IoEventMetadataOneResponse = IoEventMetadataHalModel;
50
+ /** Defines the fields of many event metadata entities returned by the Adobe I/O Events API. */
51
+ type IoEventMetadataManyResponse = {
52
+ _embedded: IoEventMetadataHalModel[];
53
+ };
54
+ //#endregion
23
55
  //#region source/io-events/api/event-metadata/schema.d.ts
24
56
  /** The schema of the parameters received by the GET `providers/:id/eventmetadata` Adobe I/O Events API endpoint. */
25
57
  declare const GetAllEventMetadataForProviderSchema: v.ObjectSchema<{
26
- readonly providerId: v.StringSchema<`Expected a string value for property '${string}'`>;
58
+ readonly providerId: v.StringSchema<`Expected a string value for '${string}'`>;
27
59
  }, undefined>;
28
60
  /** The schema of the parameters received by the GET `providers/:id/eventmetadata/:code` Adobe I/O Events API endpoint. */
29
61
  declare const GetEventMetadataForEventAndProviderSchema: v.ObjectSchema<{
30
- readonly eventCode: v.StringSchema<`Expected a string value for property '${string}'`>;
31
- readonly providerId: v.StringSchema<`Expected a string value for property '${string}'`>;
62
+ readonly eventCode: v.StringSchema<`Expected a string value for '${string}'`>;
63
+ readonly providerId: v.StringSchema<`Expected a string value for '${string}'`>;
32
64
  }, undefined>;
33
65
  /** The schema of the parameters received by the POST `providers/:id/eventmetadata` Adobe I/O Events API endpoint. */
34
66
  declare const CreateEventMetadataForProviderSchema: v.ObjectSchema<{
35
- readonly consumerOrgId: v.StringSchema<`Expected a string value for property '${string}'`>;
36
- readonly projectId: v.StringSchema<`Expected a string value for property '${string}'`>;
37
- readonly workspaceId: v.StringSchema<`Expected a string value for property '${string}'`>;
38
- readonly providerId: v.StringSchema<`Expected a string value for property '${string}'`>;
39
- readonly label: v.StringSchema<`Expected a string value for property '${string}'`>;
40
- readonly description: v.StringSchema<`Expected a string value for property '${string}'`>;
41
- readonly eventCode: v.StringSchema<`Expected a string value for property '${string}'`>;
42
- readonly sampleEventTemplate: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.TransformAction<string, string>, v.ParseJsonAction<string, undefined, `Expected valid JSON string for property '${string}'`>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>]>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.ArraySchema<v.UnknownSchema, undefined>], undefined>, v.StringifyJsonAction<unknown[] | {
67
+ readonly consumerOrgId: v.StringSchema<`Expected a string value for '${string}'`>;
68
+ readonly projectId: v.StringSchema<`Expected a string value for '${string}'`>;
69
+ readonly workspaceId: v.StringSchema<`Expected a string value for '${string}'`>;
70
+ readonly providerId: v.StringSchema<`Expected a string value for '${string}'`>;
71
+ readonly label: v.StringSchema<`Expected a string value for '${string}'`>;
72
+ readonly description: v.StringSchema<`Expected a string value for '${string}'`>;
73
+ readonly eventCode: v.StringSchema<`Expected a string value for '${string}'`>;
74
+ readonly sampleEventTemplate: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.TransformAction<string, string>, v.ParseJsonAction<string, undefined, `Expected valid JSON string for property '${string}'`>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>]>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.ArraySchema<v.UnknownSchema, undefined>], undefined>, v.StringifyJsonAction<unknown[] | {
43
75
  [x: string]: unknown;
44
76
  }, undefined, `Expected valid JSON data for property '${string}'`>, v.TransformAction<string, string>]>, undefined>;
45
77
  }, undefined>;
@@ -71,67 +103,7 @@ type CreateEventMetadataForProviderParams = v.InferInput<typeof CreateEventMetad
71
103
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
72
104
  * @throws An {@link HTTPError} If the status code is not 2XX.
73
105
  */
74
- declare function getAllEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: GetAllEventMetadataForProviderParams, fetchOptions?: Options): Promise<{
75
- embedded: {
76
- description: string;
77
- label: string;
78
- eventCode: string;
79
- embedded?: {
80
- sampleEvent?: {
81
- format: string;
82
- samplePayload?: string | undefined;
83
- links: {
84
- self: {
85
- href: string;
86
- templated?: boolean | undefined;
87
- type?: string | undefined;
88
- deprecation?: string | undefined;
89
- name?: string | undefined;
90
- profile?: string | undefined;
91
- title?: string | undefined;
92
- hreflang?: string | undefined;
93
- seen?: string | undefined;
94
- };
95
- };
96
- } | undefined;
97
- } | undefined;
98
- links: {
99
- "rel:sampleEvent"?: {
100
- href: string;
101
- templated?: boolean | undefined;
102
- type?: string | undefined;
103
- deprecation?: string | undefined;
104
- name?: string | undefined;
105
- profile?: string | undefined;
106
- title?: string | undefined;
107
- hreflang?: string | undefined;
108
- seen?: string | undefined;
109
- } | undefined;
110
- "rel:update"?: {
111
- href: string;
112
- templated?: boolean | undefined;
113
- type?: string | undefined;
114
- deprecation?: string | undefined;
115
- name?: string | undefined;
116
- profile?: string | undefined;
117
- title?: string | undefined;
118
- hreflang?: string | undefined;
119
- seen?: string | undefined;
120
- } | undefined;
121
- self: {
122
- href: string;
123
- templated?: boolean | undefined;
124
- type?: string | undefined;
125
- deprecation?: string | undefined;
126
- name?: string | undefined;
127
- profile?: string | undefined;
128
- title?: string | undefined;
129
- hreflang?: string | undefined;
130
- seen?: string | undefined;
131
- };
132
- };
133
- }[];
134
- }>;
106
+ declare function getAllEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: GetAllEventMetadataForProviderParams, fetchOptions?: Options): Promise<IoEventMetadataManyResponse>;
135
107
  /**
136
108
  * Gets event metadata for a specific event code and provider.
137
109
  * @see https://developer.adobe.com/events/docs/api#operation/getByProviderIdAndEventCode
@@ -143,65 +115,7 @@ declare function getAllEventMetadataForProvider(httpClient: AdobeIoEventsHttpCli
143
115
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
144
116
  * @throws An {@link HTTPError} If the status code is not 2XX.
145
117
  */
146
- declare function getEventMetadataForEventAndProvider(httpClient: AdobeIoEventsHttpClient, params: GetEventMetadataForEventAndProviderParams, fetchOptions?: Options): Promise<{
147
- description: string;
148
- label: string;
149
- eventCode: string;
150
- embedded?: {
151
- sampleEvent?: {
152
- format: string;
153
- samplePayload?: string | undefined;
154
- links: {
155
- self: {
156
- href: string;
157
- templated?: boolean | undefined;
158
- type?: string | undefined;
159
- deprecation?: string | undefined;
160
- name?: string | undefined;
161
- profile?: string | undefined;
162
- title?: string | undefined;
163
- hreflang?: string | undefined;
164
- seen?: string | undefined;
165
- };
166
- };
167
- } | undefined;
168
- } | undefined;
169
- links: {
170
- "rel:sampleEvent"?: {
171
- href: string;
172
- templated?: boolean | undefined;
173
- type?: string | undefined;
174
- deprecation?: string | undefined;
175
- name?: string | undefined;
176
- profile?: string | undefined;
177
- title?: string | undefined;
178
- hreflang?: string | undefined;
179
- seen?: string | undefined;
180
- } | undefined;
181
- "rel:update"?: {
182
- href: string;
183
- templated?: boolean | undefined;
184
- type?: string | undefined;
185
- deprecation?: string | undefined;
186
- name?: string | undefined;
187
- profile?: string | undefined;
188
- title?: string | undefined;
189
- hreflang?: string | undefined;
190
- seen?: string | undefined;
191
- } | undefined;
192
- self: {
193
- href: string;
194
- templated?: boolean | undefined;
195
- type?: string | undefined;
196
- deprecation?: string | undefined;
197
- name?: string | undefined;
198
- profile?: string | undefined;
199
- title?: string | undefined;
200
- hreflang?: string | undefined;
201
- seen?: string | undefined;
202
- };
203
- };
204
- }>;
118
+ declare function getEventMetadataForEventAndProvider(httpClient: AdobeIoEventsHttpClient, params: GetEventMetadataForEventAndProviderParams, fetchOptions?: Options): Promise<IoEventMetadataHalModel>;
205
119
  /**
206
120
  * Creates event metadata for a provider.
207
121
  * @see https://developer.adobe.com/events/docs/api#operation/postEventMetadata
@@ -213,87 +127,64 @@ declare function getEventMetadataForEventAndProvider(httpClient: AdobeIoEventsHt
213
127
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
214
128
  * @throws An {@link HTTPError} If the status code is not 2XX.
215
129
  */
216
- declare function createEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: CreateEventMetadataForProviderParams, fetchOptions?: Options): Promise<{
217
- description: string;
130
+ declare function createEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: CreateEventMetadataForProviderParams, fetchOptions?: Options): Promise<IoEventMetadataHalModel>;
131
+ //#endregion
132
+ //#region source/io-events/api/event-providers/types.d.ts
133
+ /** Defines the base fields of an I/O event provider entity. */
134
+ type IoEventProvider = {
135
+ id: string;
136
+ instance_id?: string;
218
137
  label: string;
219
- eventCode: string;
220
- embedded?: {
221
- sampleEvent?: {
222
- format: string;
223
- samplePayload?: string | undefined;
224
- links: {
225
- self: {
226
- href: string;
227
- templated?: boolean | undefined;
228
- type?: string | undefined;
229
- deprecation?: string | undefined;
230
- name?: string | undefined;
231
- profile?: string | undefined;
232
- title?: string | undefined;
233
- hreflang?: string | undefined;
234
- seen?: string | undefined;
235
- };
236
- };
237
- } | undefined;
238
- } | undefined;
239
- links: {
240
- "rel:sampleEvent"?: {
241
- href: string;
242
- templated?: boolean | undefined;
243
- type?: string | undefined;
244
- deprecation?: string | undefined;
245
- name?: string | undefined;
246
- profile?: string | undefined;
247
- title?: string | undefined;
248
- hreflang?: string | undefined;
249
- seen?: string | undefined;
250
- } | undefined;
251
- "rel:update"?: {
252
- href: string;
253
- templated?: boolean | undefined;
254
- type?: string | undefined;
255
- deprecation?: string | undefined;
256
- name?: string | undefined;
257
- profile?: string | undefined;
258
- title?: string | undefined;
259
- hreflang?: string | undefined;
260
- seen?: string | undefined;
261
- } | undefined;
262
- self: {
263
- href: string;
264
- templated?: boolean | undefined;
265
- type?: string | undefined;
266
- deprecation?: string | undefined;
267
- name?: string | undefined;
268
- profile?: string | undefined;
269
- title?: string | undefined;
270
- hreflang?: string | undefined;
271
- seen?: string | undefined;
272
- };
138
+ source: string;
139
+ publisher: string;
140
+ provider_metadata: string;
141
+ event_delivery_format: string;
142
+ description?: string;
143
+ docs_url?: string;
144
+ };
145
+ /** Defines the fields of an I/O event provider entity returned by the Adobe I/O Events API. */
146
+ type IoEventProviderHalModel = IoEventProvider & {
147
+ _embedded?: {
148
+ eventmetadata: IoEventMetadataHalModel[];
273
149
  };
274
- }>;
150
+ _links: {
151
+ self: HALLink;
152
+ "rel:eventmetadata"?: HALLink;
153
+ };
154
+ };
155
+ /** Defines the fields of an I/O event provider entity returned by the Adobe I/O Events API. */
156
+ type IoEventProviderOneResponse = IoEventProviderHalModel;
157
+ /** Defines the fields of many I/O event provider entities returned by the Adobe I/O Events API. */
158
+ type IoEventProviderManyResponse = {
159
+ _embedded: {
160
+ providers: IoEventProviderHalModel[];
161
+ };
162
+ _links: {
163
+ self: HALLink;
164
+ };
165
+ };
275
166
  //#endregion
276
167
  //#region source/io-events/api/event-providers/schema.d.ts
277
168
  declare const EventProviderListAllParamsSchema: v.ObjectSchema<{
278
- readonly consumerOrgId: v.StringSchema<`Expected a string value for property '${string}'`>;
279
- readonly withEventMetadata: v.OptionalSchema<v.BooleanSchema<`Expected a boolean value for property '${string}'`>, undefined>;
169
+ readonly consumerOrgId: v.StringSchema<`Expected a string value for '${string}'`>;
170
+ readonly withEventMetadata: v.OptionalSchema<v.BooleanSchema<`Expected a boolean value for '${string}'`>, undefined>;
280
171
  readonly filterBy: v.OptionalSchema<v.ObjectSchema<{
281
- readonly instanceId: v.OptionalSchema<v.StringSchema<`Expected a string value for property '${string}'`>, undefined>;
172
+ readonly instanceId: v.OptionalSchema<v.StringSchema<`Expected a string value for '${string}'`>, undefined>;
282
173
  readonly providerTypes: v.OptionalSchema<v.UnionSchema<[v.ArraySchema<v.PicklistSchema<readonly ["dx_commerce_events", "3rd_party_custom_events"], undefined>, "Expected an array of event provider types">], undefined>, undefined>;
283
174
  }, undefined>, undefined>;
284
175
  }, undefined>;
285
176
  declare const EventProviderGetByIdParamsSchema: v.ObjectSchema<{
286
- readonly providerId: v.StringSchema<`Expected a string value for property '${string}'`>;
287
- readonly withEventMetadata: v.OptionalSchema<v.BooleanSchema<`Expected a boolean value for property '${string}'`>, undefined>;
177
+ readonly providerId: v.StringSchema<`Expected a string value for '${string}'`>;
178
+ readonly withEventMetadata: v.OptionalSchema<v.BooleanSchema<`Expected a boolean value for '${string}'`>, undefined>;
288
179
  }, undefined>;
289
180
  declare const EventProviderCreateParamsSchema: v.ObjectSchema<{
290
- readonly consumerOrgId: v.StringSchema<`Expected a string value for property '${string}'`>;
291
- readonly projectId: v.StringSchema<`Expected a string value for property '${string}'`>;
292
- readonly workspaceId: v.StringSchema<`Expected a string value for property '${string}'`>;
293
- readonly label: v.StringSchema<`Expected a string value for property '${string}'`>;
294
- readonly description: v.OptionalSchema<v.StringSchema<`Expected a string value for property '${string}'`>, undefined>;
295
- readonly docsUrl: v.OptionalSchema<v.StringSchema<`Expected a string value for property '${string}'`>, undefined>;
296
- readonly instanceId: v.OptionalSchema<v.StringSchema<`Expected a string value for property '${string}'`>, undefined>;
181
+ readonly consumerOrgId: v.StringSchema<`Expected a string value for '${string}'`>;
182
+ readonly projectId: v.StringSchema<`Expected a string value for '${string}'`>;
183
+ readonly workspaceId: v.StringSchema<`Expected a string value for '${string}'`>;
184
+ readonly label: v.StringSchema<`Expected a string value for '${string}'`>;
185
+ readonly description: v.OptionalSchema<v.StringSchema<`Expected a string value for '${string}'`>, undefined>;
186
+ readonly docsUrl: v.OptionalSchema<v.StringSchema<`Expected a string value for '${string}'`>, undefined>;
187
+ readonly instanceId: v.OptionalSchema<v.StringSchema<`Expected a string value for '${string}'`>, undefined>;
297
188
  readonly providerType: v.OptionalSchema<v.PicklistSchema<readonly ["dx_commerce_events", "3rd_party_custom_events"], undefined>, undefined>;
298
189
  readonly dataResidencyRegion: v.OptionalSchema<v.PicklistSchema<readonly ["va6", "irl1"], undefined>, undefined>;
299
190
  }, undefined>;
@@ -322,119 +213,7 @@ type EventProviderCreateParams = v.InferInput<typeof EventProviderCreateParamsSc
322
213
  * @param params - The parameters to list the event providers with.
323
214
  * @param fetchOptions - The {@link Options} to use to make the request.
324
215
  */
325
- declare function getAllEventProviders(httpClient: AdobeIoEventsHttpClient, params: EventProviderListAllParams, fetchOptions?: Options): Promise<{
326
- embedded: {
327
- providers: {
328
- id: string;
329
- instanceId?: string | undefined;
330
- label: string;
331
- source: string;
332
- publisher: string;
333
- providerMetadata: string;
334
- eventDeliveryFormat: string;
335
- description?: string | undefined;
336
- docsUrl?: string | undefined;
337
- embedded?: {
338
- eventmetadata: {
339
- description: string;
340
- label: string;
341
- eventCode: string;
342
- embedded?: {
343
- sampleEvent?: {
344
- format: string;
345
- samplePayload?: string | undefined;
346
- links: {
347
- self: {
348
- href: string;
349
- templated?: boolean | undefined;
350
- type?: string | undefined;
351
- deprecation?: string | undefined;
352
- name?: string | undefined;
353
- profile?: string | undefined;
354
- title?: string | undefined;
355
- hreflang?: string | undefined;
356
- seen?: string | undefined;
357
- };
358
- };
359
- } | undefined;
360
- } | undefined;
361
- links: {
362
- "rel:sampleEvent"?: {
363
- href: string;
364
- templated?: boolean | undefined;
365
- type?: string | undefined;
366
- deprecation?: string | undefined;
367
- name?: string | undefined;
368
- profile?: string | undefined;
369
- title?: string | undefined;
370
- hreflang?: string | undefined;
371
- seen?: string | undefined;
372
- } | undefined;
373
- "rel:update"?: {
374
- href: string;
375
- templated?: boolean | undefined;
376
- type?: string | undefined;
377
- deprecation?: string | undefined;
378
- name?: string | undefined;
379
- profile?: string | undefined;
380
- title?: string | undefined;
381
- hreflang?: string | undefined;
382
- seen?: string | undefined;
383
- } | undefined;
384
- self: {
385
- href: string;
386
- templated?: boolean | undefined;
387
- type?: string | undefined;
388
- deprecation?: string | undefined;
389
- name?: string | undefined;
390
- profile?: string | undefined;
391
- title?: string | undefined;
392
- hreflang?: string | undefined;
393
- seen?: string | undefined;
394
- };
395
- };
396
- }[];
397
- } | undefined;
398
- links: {
399
- self: {
400
- href: string;
401
- templated?: boolean | undefined;
402
- type?: string | undefined;
403
- deprecation?: string | undefined;
404
- name?: string | undefined;
405
- profile?: string | undefined;
406
- title?: string | undefined;
407
- hreflang?: string | undefined;
408
- seen?: string | undefined;
409
- };
410
- "rel:eventmetadata"?: {
411
- href: string;
412
- templated?: boolean | undefined;
413
- type?: string | undefined;
414
- deprecation?: string | undefined;
415
- name?: string | undefined;
416
- profile?: string | undefined;
417
- title?: string | undefined;
418
- hreflang?: string | undefined;
419
- seen?: string | undefined;
420
- } | undefined;
421
- };
422
- }[];
423
- };
424
- links: {
425
- self: {
426
- href: string;
427
- templated?: boolean | undefined;
428
- type?: string | undefined;
429
- deprecation?: string | undefined;
430
- name?: string | undefined;
431
- profile?: string | undefined;
432
- title?: string | undefined;
433
- hreflang?: string | undefined;
434
- seen?: string | undefined;
435
- };
436
- };
437
- }>;
216
+ declare function getAllEventProviders(httpClient: AdobeIoEventsHttpClient, params: EventProviderListAllParams, fetchOptions?: Options): Promise<IoEventProviderManyResponse>;
438
217
  /**
439
218
  * Gets an event provider by ID.
440
219
  * @see https://developer.adobe.com/events/docs/api#operation/getProvidersById
@@ -446,102 +225,7 @@ declare function getAllEventProviders(httpClient: AdobeIoEventsHttpClient, param
446
225
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
447
226
  * @throws An {@link HTTPError} If the status code is not 2XX.
448
227
  */
449
- declare function getEventProviderById(httpClient: AdobeIoEventsHttpClient, params: EventProviderGetByIdParams, fetchOptions?: Options): Promise<{
450
- id: string;
451
- instanceId?: string | undefined;
452
- label: string;
453
- source: string;
454
- publisher: string;
455
- providerMetadata: string;
456
- eventDeliveryFormat: string;
457
- description?: string | undefined;
458
- docsUrl?: string | undefined;
459
- embedded?: {
460
- eventmetadata: {
461
- description: string;
462
- label: string;
463
- eventCode: string;
464
- embedded?: {
465
- sampleEvent?: {
466
- format: string;
467
- samplePayload?: string | undefined;
468
- links: {
469
- self: {
470
- href: string;
471
- templated?: boolean | undefined;
472
- type?: string | undefined;
473
- deprecation?: string | undefined;
474
- name?: string | undefined;
475
- profile?: string | undefined;
476
- title?: string | undefined;
477
- hreflang?: string | undefined;
478
- seen?: string | undefined;
479
- };
480
- };
481
- } | undefined;
482
- } | undefined;
483
- links: {
484
- "rel:sampleEvent"?: {
485
- href: string;
486
- templated?: boolean | undefined;
487
- type?: string | undefined;
488
- deprecation?: string | undefined;
489
- name?: string | undefined;
490
- profile?: string | undefined;
491
- title?: string | undefined;
492
- hreflang?: string | undefined;
493
- seen?: string | undefined;
494
- } | undefined;
495
- "rel:update"?: {
496
- href: string;
497
- templated?: boolean | undefined;
498
- type?: string | undefined;
499
- deprecation?: string | undefined;
500
- name?: string | undefined;
501
- profile?: string | undefined;
502
- title?: string | undefined;
503
- hreflang?: string | undefined;
504
- seen?: string | undefined;
505
- } | undefined;
506
- self: {
507
- href: string;
508
- templated?: boolean | undefined;
509
- type?: string | undefined;
510
- deprecation?: string | undefined;
511
- name?: string | undefined;
512
- profile?: string | undefined;
513
- title?: string | undefined;
514
- hreflang?: string | undefined;
515
- seen?: string | undefined;
516
- };
517
- };
518
- }[];
519
- } | undefined;
520
- links: {
521
- self: {
522
- href: string;
523
- templated?: boolean | undefined;
524
- type?: string | undefined;
525
- deprecation?: string | undefined;
526
- name?: string | undefined;
527
- profile?: string | undefined;
528
- title?: string | undefined;
529
- hreflang?: string | undefined;
530
- seen?: string | undefined;
531
- };
532
- "rel:eventmetadata"?: {
533
- href: string;
534
- templated?: boolean | undefined;
535
- type?: string | undefined;
536
- deprecation?: string | undefined;
537
- name?: string | undefined;
538
- profile?: string | undefined;
539
- title?: string | undefined;
540
- hreflang?: string | undefined;
541
- seen?: string | undefined;
542
- } | undefined;
543
- };
544
- }>;
228
+ declare function getEventProviderById(httpClient: AdobeIoEventsHttpClient, params: EventProviderGetByIdParams, fetchOptions?: Options): Promise<IoEventProviderHalModel>;
545
229
  /**
546
230
  * Creates an event provider.
547
231
  * @see https://developer.adobe.com/events/docs/api#operation/createProvider
@@ -553,102 +237,7 @@ declare function getEventProviderById(httpClient: AdobeIoEventsHttpClient, param
553
237
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
554
238
  * @throws An {@link HTTPError} If the status code is not 2XX.
555
239
  */
556
- declare function createEventProvider(httpClient: AdobeIoEventsHttpClient, params: EventProviderCreateParams, fetchOptions?: Options): Promise<{
557
- id: string;
558
- instanceId?: string | undefined;
559
- label: string;
560
- source: string;
561
- publisher: string;
562
- providerMetadata: string;
563
- eventDeliveryFormat: string;
564
- description?: string | undefined;
565
- docsUrl?: string | undefined;
566
- embedded?: {
567
- eventmetadata: {
568
- description: string;
569
- label: string;
570
- eventCode: string;
571
- embedded?: {
572
- sampleEvent?: {
573
- format: string;
574
- samplePayload?: string | undefined;
575
- links: {
576
- self: {
577
- href: string;
578
- templated?: boolean | undefined;
579
- type?: string | undefined;
580
- deprecation?: string | undefined;
581
- name?: string | undefined;
582
- profile?: string | undefined;
583
- title?: string | undefined;
584
- hreflang?: string | undefined;
585
- seen?: string | undefined;
586
- };
587
- };
588
- } | undefined;
589
- } | undefined;
590
- links: {
591
- "rel:sampleEvent"?: {
592
- href: string;
593
- templated?: boolean | undefined;
594
- type?: string | undefined;
595
- deprecation?: string | undefined;
596
- name?: string | undefined;
597
- profile?: string | undefined;
598
- title?: string | undefined;
599
- hreflang?: string | undefined;
600
- seen?: string | undefined;
601
- } | undefined;
602
- "rel:update"?: {
603
- href: string;
604
- templated?: boolean | undefined;
605
- type?: string | undefined;
606
- deprecation?: string | undefined;
607
- name?: string | undefined;
608
- profile?: string | undefined;
609
- title?: string | undefined;
610
- hreflang?: string | undefined;
611
- seen?: string | undefined;
612
- } | undefined;
613
- self: {
614
- href: string;
615
- templated?: boolean | undefined;
616
- type?: string | undefined;
617
- deprecation?: string | undefined;
618
- name?: string | undefined;
619
- profile?: string | undefined;
620
- title?: string | undefined;
621
- hreflang?: string | undefined;
622
- seen?: string | undefined;
623
- };
624
- };
625
- }[];
626
- } | undefined;
627
- links: {
628
- self: {
629
- href: string;
630
- templated?: boolean | undefined;
631
- type?: string | undefined;
632
- deprecation?: string | undefined;
633
- name?: string | undefined;
634
- profile?: string | undefined;
635
- title?: string | undefined;
636
- hreflang?: string | undefined;
637
- seen?: string | undefined;
638
- };
639
- "rel:eventmetadata"?: {
640
- href: string;
641
- templated?: boolean | undefined;
642
- type?: string | undefined;
643
- deprecation?: string | undefined;
644
- name?: string | undefined;
645
- profile?: string | undefined;
646
- title?: string | undefined;
647
- hreflang?: string | undefined;
648
- seen?: string | undefined;
649
- } | undefined;
650
- };
651
- }>;
240
+ declare function createEventProvider(httpClient: AdobeIoEventsHttpClient, params: EventProviderCreateParams, fetchOptions?: Options): Promise<IoEventProviderHalModel>;
652
241
  //#endregion
653
242
  //#region source/io-events/api/event-providers/shorthands.d.ts
654
243
  /**
@@ -662,119 +251,7 @@ declare function createEventProvider(httpClient: AdobeIoEventsHttpClient, params
662
251
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
663
252
  * @throws An {@link HTTPError} If the status code is not 2XX.
664
253
  */
665
- declare function getAllCommerceEventProviders(httpClient: AdobeIoEventsHttpClient, params: OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: Options): Promise<{
666
- embedded: {
667
- providers: {
668
- id: string;
669
- instanceId?: string | undefined;
670
- label: string;
671
- source: string;
672
- publisher: string;
673
- providerMetadata: string;
674
- eventDeliveryFormat: string;
675
- description?: string | undefined;
676
- docsUrl?: string | undefined;
677
- embedded?: {
678
- eventmetadata: {
679
- description: string;
680
- label: string;
681
- eventCode: string;
682
- embedded?: {
683
- sampleEvent?: {
684
- format: string;
685
- samplePayload?: string | undefined;
686
- links: {
687
- self: {
688
- href: string;
689
- templated?: boolean | undefined;
690
- type?: string | undefined;
691
- deprecation?: string | undefined;
692
- name?: string | undefined;
693
- profile?: string | undefined;
694
- title?: string | undefined;
695
- hreflang?: string | undefined;
696
- seen?: string | undefined;
697
- };
698
- };
699
- } | undefined;
700
- } | undefined;
701
- links: {
702
- "rel:sampleEvent"?: {
703
- href: string;
704
- templated?: boolean | undefined;
705
- type?: string | undefined;
706
- deprecation?: string | undefined;
707
- name?: string | undefined;
708
- profile?: string | undefined;
709
- title?: string | undefined;
710
- hreflang?: string | undefined;
711
- seen?: string | undefined;
712
- } | undefined;
713
- "rel:update"?: {
714
- href: string;
715
- templated?: boolean | undefined;
716
- type?: string | undefined;
717
- deprecation?: string | undefined;
718
- name?: string | undefined;
719
- profile?: string | undefined;
720
- title?: string | undefined;
721
- hreflang?: string | undefined;
722
- seen?: string | undefined;
723
- } | undefined;
724
- self: {
725
- href: string;
726
- templated?: boolean | undefined;
727
- type?: string | undefined;
728
- deprecation?: string | undefined;
729
- name?: string | undefined;
730
- profile?: string | undefined;
731
- title?: string | undefined;
732
- hreflang?: string | undefined;
733
- seen?: string | undefined;
734
- };
735
- };
736
- }[];
737
- } | undefined;
738
- links: {
739
- self: {
740
- href: string;
741
- templated?: boolean | undefined;
742
- type?: string | undefined;
743
- deprecation?: string | undefined;
744
- name?: string | undefined;
745
- profile?: string | undefined;
746
- title?: string | undefined;
747
- hreflang?: string | undefined;
748
- seen?: string | undefined;
749
- };
750
- "rel:eventmetadata"?: {
751
- href: string;
752
- templated?: boolean | undefined;
753
- type?: string | undefined;
754
- deprecation?: string | undefined;
755
- name?: string | undefined;
756
- profile?: string | undefined;
757
- title?: string | undefined;
758
- hreflang?: string | undefined;
759
- seen?: string | undefined;
760
- } | undefined;
761
- };
762
- }[];
763
- };
764
- links: {
765
- self: {
766
- href: string;
767
- templated?: boolean | undefined;
768
- type?: string | undefined;
769
- deprecation?: string | undefined;
770
- name?: string | undefined;
771
- profile?: string | undefined;
772
- title?: string | undefined;
773
- hreflang?: string | undefined;
774
- seen?: string | undefined;
775
- };
776
- };
777
- }>;
254
+ declare function getAllCommerceEventProviders(httpClient: AdobeIoEventsHttpClient, params: OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: Options): Promise<IoEventProviderManyResponse>;
778
255
  /**
779
256
  * Lists all 3rd Party Custom Events (of type `3rd_party_custom_events`) event providers for the given consumer organization ID.
780
257
  * @see https://developer.adobe.com/events/docs/api#operation/getProvidersByConsumerOrgId
@@ -786,119 +263,7 @@ declare function getAllCommerceEventProviders(httpClient: AdobeIoEventsHttpClien
786
263
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
787
264
  * @throws An {@link HTTPError} If the status code is not 2XX.
788
265
  */
789
- declare function getAll3rdPartyCustomEventProviders(httpClient: AdobeIoEventsHttpClient, params: OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: Options): Promise<{
790
- embedded: {
791
- providers: {
792
- id: string;
793
- instanceId?: string | undefined;
794
- label: string;
795
- source: string;
796
- publisher: string;
797
- providerMetadata: string;
798
- eventDeliveryFormat: string;
799
- description?: string | undefined;
800
- docsUrl?: string | undefined;
801
- embedded?: {
802
- eventmetadata: {
803
- description: string;
804
- label: string;
805
- eventCode: string;
806
- embedded?: {
807
- sampleEvent?: {
808
- format: string;
809
- samplePayload?: string | undefined;
810
- links: {
811
- self: {
812
- href: string;
813
- templated?: boolean | undefined;
814
- type?: string | undefined;
815
- deprecation?: string | undefined;
816
- name?: string | undefined;
817
- profile?: string | undefined;
818
- title?: string | undefined;
819
- hreflang?: string | undefined;
820
- seen?: string | undefined;
821
- };
822
- };
823
- } | undefined;
824
- } | undefined;
825
- links: {
826
- "rel:sampleEvent"?: {
827
- href: string;
828
- templated?: boolean | undefined;
829
- type?: string | undefined;
830
- deprecation?: string | undefined;
831
- name?: string | undefined;
832
- profile?: string | undefined;
833
- title?: string | undefined;
834
- hreflang?: string | undefined;
835
- seen?: string | undefined;
836
- } | undefined;
837
- "rel:update"?: {
838
- href: string;
839
- templated?: boolean | undefined;
840
- type?: string | undefined;
841
- deprecation?: string | undefined;
842
- name?: string | undefined;
843
- profile?: string | undefined;
844
- title?: string | undefined;
845
- hreflang?: string | undefined;
846
- seen?: string | undefined;
847
- } | undefined;
848
- self: {
849
- href: string;
850
- templated?: boolean | undefined;
851
- type?: string | undefined;
852
- deprecation?: string | undefined;
853
- name?: string | undefined;
854
- profile?: string | undefined;
855
- title?: string | undefined;
856
- hreflang?: string | undefined;
857
- seen?: string | undefined;
858
- };
859
- };
860
- }[];
861
- } | undefined;
862
- links: {
863
- self: {
864
- href: string;
865
- templated?: boolean | undefined;
866
- type?: string | undefined;
867
- deprecation?: string | undefined;
868
- name?: string | undefined;
869
- profile?: string | undefined;
870
- title?: string | undefined;
871
- hreflang?: string | undefined;
872
- seen?: string | undefined;
873
- };
874
- "rel:eventmetadata"?: {
875
- href: string;
876
- templated?: boolean | undefined;
877
- type?: string | undefined;
878
- deprecation?: string | undefined;
879
- name?: string | undefined;
880
- profile?: string | undefined;
881
- title?: string | undefined;
882
- hreflang?: string | undefined;
883
- seen?: string | undefined;
884
- } | undefined;
885
- };
886
- }[];
887
- };
888
- links: {
889
- self: {
890
- href: string;
891
- templated?: boolean | undefined;
892
- type?: string | undefined;
893
- deprecation?: string | undefined;
894
- name?: string | undefined;
895
- profile?: string | undefined;
896
- title?: string | undefined;
897
- hreflang?: string | undefined;
898
- seen?: string | undefined;
899
- };
900
- };
901
- }>;
266
+ declare function getAll3rdPartyCustomEventProviders(httpClient: AdobeIoEventsHttpClient, params: OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: Options): Promise<IoEventProviderManyResponse>;
902
267
  /**
903
268
  * Creates a Commerce (of type `dx_commerce_events`) event provider.
904
269
  * @see https://developer.adobe.com/events/docs/api#operation/createProvider
@@ -910,102 +275,7 @@ declare function getAll3rdPartyCustomEventProviders(httpClient: AdobeIoEventsHtt
910
275
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
911
276
  * @throws An {@link HTTPError} If the status code is not 2XX.
912
277
  */
913
- declare function createCommerceEventProvider(httpClient: AdobeIoEventsHttpClient, params: OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: Options): Promise<{
914
- id: string;
915
- instanceId?: string | undefined;
916
- label: string;
917
- source: string;
918
- publisher: string;
919
- providerMetadata: string;
920
- eventDeliveryFormat: string;
921
- description?: string | undefined;
922
- docsUrl?: string | undefined;
923
- embedded?: {
924
- eventmetadata: {
925
- description: string;
926
- label: string;
927
- eventCode: string;
928
- embedded?: {
929
- sampleEvent?: {
930
- format: string;
931
- samplePayload?: string | undefined;
932
- links: {
933
- self: {
934
- href: string;
935
- templated?: boolean | undefined;
936
- type?: string | undefined;
937
- deprecation?: string | undefined;
938
- name?: string | undefined;
939
- profile?: string | undefined;
940
- title?: string | undefined;
941
- hreflang?: string | undefined;
942
- seen?: string | undefined;
943
- };
944
- };
945
- } | undefined;
946
- } | undefined;
947
- links: {
948
- "rel:sampleEvent"?: {
949
- href: string;
950
- templated?: boolean | undefined;
951
- type?: string | undefined;
952
- deprecation?: string | undefined;
953
- name?: string | undefined;
954
- profile?: string | undefined;
955
- title?: string | undefined;
956
- hreflang?: string | undefined;
957
- seen?: string | undefined;
958
- } | undefined;
959
- "rel:update"?: {
960
- href: string;
961
- templated?: boolean | undefined;
962
- type?: string | undefined;
963
- deprecation?: string | undefined;
964
- name?: string | undefined;
965
- profile?: string | undefined;
966
- title?: string | undefined;
967
- hreflang?: string | undefined;
968
- seen?: string | undefined;
969
- } | undefined;
970
- self: {
971
- href: string;
972
- templated?: boolean | undefined;
973
- type?: string | undefined;
974
- deprecation?: string | undefined;
975
- name?: string | undefined;
976
- profile?: string | undefined;
977
- title?: string | undefined;
978
- hreflang?: string | undefined;
979
- seen?: string | undefined;
980
- };
981
- };
982
- }[];
983
- } | undefined;
984
- links: {
985
- self: {
986
- href: string;
987
- templated?: boolean | undefined;
988
- type?: string | undefined;
989
- deprecation?: string | undefined;
990
- name?: string | undefined;
991
- profile?: string | undefined;
992
- title?: string | undefined;
993
- hreflang?: string | undefined;
994
- seen?: string | undefined;
995
- };
996
- "rel:eventmetadata"?: {
997
- href: string;
998
- templated?: boolean | undefined;
999
- type?: string | undefined;
1000
- deprecation?: string | undefined;
1001
- name?: string | undefined;
1002
- profile?: string | undefined;
1003
- title?: string | undefined;
1004
- hreflang?: string | undefined;
1005
- seen?: string | undefined;
1006
- } | undefined;
1007
- };
1008
- }>;
278
+ declare function createCommerceEventProvider(httpClient: AdobeIoEventsHttpClient, params: OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: Options): Promise<IoEventProviderHalModel>;
1009
279
  /**
1010
280
  * Creates a 3rd Party Custom Events (of type `3rd_party_custom_events`) event provider.
1011
281
  * @see https://developer.adobe.com/events/docs/api#operation/createProvider
@@ -1017,1098 +287,353 @@ declare function createCommerceEventProvider(httpClient: AdobeIoEventsHttpClient
1017
287
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
1018
288
  * @throws An {@link HTTPError} If the status code is not 2XX.
1019
289
  */
1020
- declare function create3rdPartyCustomEventProvider(httpClient: AdobeIoEventsHttpClient, params: OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: Options): Promise<{
1021
- id: string;
1022
- instanceId?: string | undefined;
1023
- label: string;
1024
- source: string;
1025
- publisher: string;
1026
- providerMetadata: string;
1027
- eventDeliveryFormat: string;
1028
- description?: string | undefined;
1029
- docsUrl?: string | undefined;
1030
- embedded?: {
1031
- eventmetadata: {
1032
- description: string;
1033
- label: string;
1034
- eventCode: string;
1035
- embedded?: {
1036
- sampleEvent?: {
1037
- format: string;
1038
- samplePayload?: string | undefined;
1039
- links: {
1040
- self: {
1041
- href: string;
1042
- templated?: boolean | undefined;
1043
- type?: string | undefined;
1044
- deprecation?: string | undefined;
1045
- name?: string | undefined;
1046
- profile?: string | undefined;
1047
- title?: string | undefined;
1048
- hreflang?: string | undefined;
1049
- seen?: string | undefined;
1050
- };
1051
- };
1052
- } | undefined;
1053
- } | undefined;
1054
- links: {
1055
- "rel:sampleEvent"?: {
1056
- href: string;
1057
- templated?: boolean | undefined;
1058
- type?: string | undefined;
1059
- deprecation?: string | undefined;
1060
- name?: string | undefined;
1061
- profile?: string | undefined;
1062
- title?: string | undefined;
1063
- hreflang?: string | undefined;
1064
- seen?: string | undefined;
1065
- } | undefined;
1066
- "rel:update"?: {
1067
- href: string;
1068
- templated?: boolean | undefined;
1069
- type?: string | undefined;
1070
- deprecation?: string | undefined;
1071
- name?: string | undefined;
1072
- profile?: string | undefined;
1073
- title?: string | undefined;
1074
- hreflang?: string | undefined;
1075
- seen?: string | undefined;
1076
- } | undefined;
1077
- self: {
1078
- href: string;
1079
- templated?: boolean | undefined;
1080
- type?: string | undefined;
1081
- deprecation?: string | undefined;
1082
- name?: string | undefined;
1083
- profile?: string | undefined;
1084
- title?: string | undefined;
1085
- hreflang?: string | undefined;
1086
- seen?: string | undefined;
1087
- };
1088
- };
1089
- }[];
1090
- } | undefined;
1091
- links: {
1092
- self: {
1093
- href: string;
1094
- templated?: boolean | undefined;
1095
- type?: string | undefined;
1096
- deprecation?: string | undefined;
1097
- name?: string | undefined;
1098
- profile?: string | undefined;
1099
- title?: string | undefined;
1100
- hreflang?: string | undefined;
1101
- seen?: string | undefined;
1102
- };
1103
- "rel:eventmetadata"?: {
1104
- href: string;
1105
- templated?: boolean | undefined;
1106
- type?: string | undefined;
1107
- deprecation?: string | undefined;
1108
- name?: string | undefined;
1109
- profile?: string | undefined;
1110
- title?: string | undefined;
1111
- hreflang?: string | undefined;
1112
- seen?: string | undefined;
1113
- } | undefined;
1114
- };
1115
- }>;
290
+ declare function create3rdPartyCustomEventProvider(httpClient: AdobeIoEventsHttpClient, params: OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: Options): Promise<IoEventProviderHalModel>;
1116
291
  //#endregion
1117
- //#region source/io-events/lib/api-client.d.ts
1118
- /**
1119
- * Creates a new API client for the Adobe I/O Events API client.
1120
- * @param params - The parameters to build the Adobe I/O Events HTTP client that will communicate with the Adobe I/O Events API.
1121
- */
1122
- declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams): _adobe_aio_commerce_lib_api1.ApiClientRecord<AdobeIoEventsHttpClient, {
1123
- getAllCommerceEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: ky4.Options): Promise<{
1124
- embedded: {
1125
- providers: {
1126
- id: string;
1127
- instanceId?: string | undefined;
1128
- label: string;
1129
- source: string;
1130
- publisher: string;
1131
- providerMetadata: string;
1132
- eventDeliveryFormat: string;
1133
- description?: string | undefined;
1134
- docsUrl?: string | undefined;
1135
- embedded?: {
1136
- eventmetadata: {
1137
- description: string;
1138
- label: string;
1139
- eventCode: string;
1140
- embedded?: {
1141
- sampleEvent?: {
1142
- format: string;
1143
- samplePayload?: string | undefined;
1144
- links: {
1145
- self: {
1146
- href: string;
1147
- templated?: boolean | undefined;
1148
- type?: string | undefined;
1149
- deprecation?: string | undefined;
1150
- name?: string | undefined;
1151
- profile?: string | undefined;
1152
- title?: string | undefined;
1153
- hreflang?: string | undefined;
1154
- seen?: string | undefined;
1155
- };
1156
- };
1157
- } | undefined;
1158
- } | undefined;
1159
- links: {
1160
- "rel:sampleEvent"?: {
1161
- href: string;
1162
- templated?: boolean | undefined;
1163
- type?: string | undefined;
1164
- deprecation?: string | undefined;
1165
- name?: string | undefined;
1166
- profile?: string | undefined;
1167
- title?: string | undefined;
1168
- hreflang?: string | undefined;
1169
- seen?: string | undefined;
1170
- } | undefined;
1171
- "rel:update"?: {
1172
- href: string;
1173
- templated?: boolean | undefined;
1174
- type?: string | undefined;
1175
- deprecation?: string | undefined;
1176
- name?: string | undefined;
1177
- profile?: string | undefined;
1178
- title?: string | undefined;
1179
- hreflang?: string | undefined;
1180
- seen?: string | undefined;
1181
- } | undefined;
1182
- self: {
1183
- href: string;
1184
- templated?: boolean | undefined;
1185
- type?: string | undefined;
1186
- deprecation?: string | undefined;
1187
- name?: string | undefined;
1188
- profile?: string | undefined;
1189
- title?: string | undefined;
1190
- hreflang?: string | undefined;
1191
- seen?: string | undefined;
1192
- };
1193
- };
1194
- }[];
1195
- } | undefined;
1196
- links: {
1197
- self: {
1198
- href: string;
1199
- templated?: boolean | undefined;
1200
- type?: string | undefined;
1201
- deprecation?: string | undefined;
1202
- name?: string | undefined;
1203
- profile?: string | undefined;
1204
- title?: string | undefined;
1205
- hreflang?: string | undefined;
1206
- seen?: string | undefined;
1207
- };
1208
- "rel:eventmetadata"?: {
1209
- href: string;
1210
- templated?: boolean | undefined;
1211
- type?: string | undefined;
1212
- deprecation?: string | undefined;
1213
- name?: string | undefined;
1214
- profile?: string | undefined;
1215
- title?: string | undefined;
1216
- hreflang?: string | undefined;
1217
- seen?: string | undefined;
1218
- } | undefined;
1219
- };
1220
- }[];
1221
- };
1222
- links: {
1223
- self: {
1224
- href: string;
1225
- templated?: boolean | undefined;
1226
- type?: string | undefined;
1227
- deprecation?: string | undefined;
1228
- name?: string | undefined;
1229
- profile?: string | undefined;
1230
- title?: string | undefined;
1231
- hreflang?: string | undefined;
1232
- seen?: string | undefined;
1233
- };
1234
- };
1235
- }>;
1236
- getAll3rdPartyCustomEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: ky4.Options): Promise<{
1237
- embedded: {
1238
- providers: {
1239
- id: string;
1240
- instanceId?: string | undefined;
1241
- label: string;
1242
- source: string;
1243
- publisher: string;
1244
- providerMetadata: string;
1245
- eventDeliveryFormat: string;
1246
- description?: string | undefined;
1247
- docsUrl?: string | undefined;
1248
- embedded?: {
1249
- eventmetadata: {
1250
- description: string;
1251
- label: string;
1252
- eventCode: string;
1253
- embedded?: {
1254
- sampleEvent?: {
1255
- format: string;
1256
- samplePayload?: string | undefined;
1257
- links: {
1258
- self: {
1259
- href: string;
1260
- templated?: boolean | undefined;
1261
- type?: string | undefined;
1262
- deprecation?: string | undefined;
1263
- name?: string | undefined;
1264
- profile?: string | undefined;
1265
- title?: string | undefined;
1266
- hreflang?: string | undefined;
1267
- seen?: string | undefined;
1268
- };
1269
- };
1270
- } | undefined;
1271
- } | undefined;
1272
- links: {
1273
- "rel:sampleEvent"?: {
1274
- href: string;
1275
- templated?: boolean | undefined;
1276
- type?: string | undefined;
1277
- deprecation?: string | undefined;
1278
- name?: string | undefined;
1279
- profile?: string | undefined;
1280
- title?: string | undefined;
1281
- hreflang?: string | undefined;
1282
- seen?: string | undefined;
1283
- } | undefined;
1284
- "rel:update"?: {
1285
- href: string;
1286
- templated?: boolean | undefined;
1287
- type?: string | undefined;
1288
- deprecation?: string | undefined;
1289
- name?: string | undefined;
1290
- profile?: string | undefined;
1291
- title?: string | undefined;
1292
- hreflang?: string | undefined;
1293
- seen?: string | undefined;
1294
- } | undefined;
1295
- self: {
1296
- href: string;
1297
- templated?: boolean | undefined;
1298
- type?: string | undefined;
1299
- deprecation?: string | undefined;
1300
- name?: string | undefined;
1301
- profile?: string | undefined;
1302
- title?: string | undefined;
1303
- hreflang?: string | undefined;
1304
- seen?: string | undefined;
1305
- };
1306
- };
1307
- }[];
1308
- } | undefined;
1309
- links: {
1310
- self: {
1311
- href: string;
1312
- templated?: boolean | undefined;
1313
- type?: string | undefined;
1314
- deprecation?: string | undefined;
1315
- name?: string | undefined;
1316
- profile?: string | undefined;
1317
- title?: string | undefined;
1318
- hreflang?: string | undefined;
1319
- seen?: string | undefined;
1320
- };
1321
- "rel:eventmetadata"?: {
1322
- href: string;
1323
- templated?: boolean | undefined;
1324
- type?: string | undefined;
1325
- deprecation?: string | undefined;
1326
- name?: string | undefined;
1327
- profile?: string | undefined;
1328
- title?: string | undefined;
1329
- hreflang?: string | undefined;
1330
- seen?: string | undefined;
1331
- } | undefined;
1332
- };
1333
- }[];
1334
- };
1335
- links: {
1336
- self: {
1337
- href: string;
1338
- templated?: boolean | undefined;
1339
- type?: string | undefined;
1340
- deprecation?: string | undefined;
1341
- name?: string | undefined;
1342
- profile?: string | undefined;
1343
- title?: string | undefined;
1344
- hreflang?: string | undefined;
1345
- seen?: string | undefined;
1346
- };
1347
- };
1348
- }>;
1349
- createCommerceEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: ky4.Options): Promise<{
1350
- id: string;
1351
- instanceId?: string | undefined;
1352
- label: string;
1353
- source: string;
1354
- publisher: string;
1355
- providerMetadata: string;
1356
- eventDeliveryFormat: string;
1357
- description?: string | undefined;
1358
- docsUrl?: string | undefined;
1359
- embedded?: {
1360
- eventmetadata: {
1361
- description: string;
1362
- label: string;
1363
- eventCode: string;
1364
- embedded?: {
1365
- sampleEvent?: {
1366
- format: string;
1367
- samplePayload?: string | undefined;
1368
- links: {
1369
- self: {
1370
- href: string;
1371
- templated?: boolean | undefined;
1372
- type?: string | undefined;
1373
- deprecation?: string | undefined;
1374
- name?: string | undefined;
1375
- profile?: string | undefined;
1376
- title?: string | undefined;
1377
- hreflang?: string | undefined;
1378
- seen?: string | undefined;
1379
- };
1380
- };
1381
- } | undefined;
1382
- } | undefined;
1383
- links: {
1384
- "rel:sampleEvent"?: {
1385
- href: string;
1386
- templated?: boolean | undefined;
1387
- type?: string | undefined;
1388
- deprecation?: string | undefined;
1389
- name?: string | undefined;
1390
- profile?: string | undefined;
1391
- title?: string | undefined;
1392
- hreflang?: string | undefined;
1393
- seen?: string | undefined;
1394
- } | undefined;
1395
- "rel:update"?: {
1396
- href: string;
1397
- templated?: boolean | undefined;
1398
- type?: string | undefined;
1399
- deprecation?: string | undefined;
1400
- name?: string | undefined;
1401
- profile?: string | undefined;
1402
- title?: string | undefined;
1403
- hreflang?: string | undefined;
1404
- seen?: string | undefined;
1405
- } | undefined;
1406
- self: {
1407
- href: string;
1408
- templated?: boolean | undefined;
1409
- type?: string | undefined;
1410
- deprecation?: string | undefined;
1411
- name?: string | undefined;
1412
- profile?: string | undefined;
1413
- title?: string | undefined;
1414
- hreflang?: string | undefined;
1415
- seen?: string | undefined;
1416
- };
1417
- };
1418
- }[];
1419
- } | undefined;
1420
- links: {
1421
- self: {
1422
- href: string;
1423
- templated?: boolean | undefined;
1424
- type?: string | undefined;
1425
- deprecation?: string | undefined;
1426
- name?: string | undefined;
1427
- profile?: string | undefined;
1428
- title?: string | undefined;
1429
- hreflang?: string | undefined;
1430
- seen?: string | undefined;
1431
- };
1432
- "rel:eventmetadata"?: {
1433
- href: string;
1434
- templated?: boolean | undefined;
1435
- type?: string | undefined;
1436
- deprecation?: string | undefined;
1437
- name?: string | undefined;
1438
- profile?: string | undefined;
1439
- title?: string | undefined;
1440
- hreflang?: string | undefined;
1441
- seen?: string | undefined;
1442
- } | undefined;
1443
- };
1444
- }>;
1445
- create3rdPartyCustomEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: ky4.Options): Promise<{
1446
- id: string;
1447
- instanceId?: string | undefined;
1448
- label: string;
1449
- source: string;
1450
- publisher: string;
1451
- providerMetadata: string;
1452
- eventDeliveryFormat: string;
1453
- description?: string | undefined;
1454
- docsUrl?: string | undefined;
1455
- embedded?: {
1456
- eventmetadata: {
1457
- description: string;
1458
- label: string;
1459
- eventCode: string;
1460
- embedded?: {
1461
- sampleEvent?: {
1462
- format: string;
1463
- samplePayload?: string | undefined;
1464
- links: {
1465
- self: {
1466
- href: string;
1467
- templated?: boolean | undefined;
1468
- type?: string | undefined;
1469
- deprecation?: string | undefined;
1470
- name?: string | undefined;
1471
- profile?: string | undefined;
1472
- title?: string | undefined;
1473
- hreflang?: string | undefined;
1474
- seen?: string | undefined;
1475
- };
1476
- };
1477
- } | undefined;
1478
- } | undefined;
1479
- links: {
1480
- "rel:sampleEvent"?: {
1481
- href: string;
1482
- templated?: boolean | undefined;
1483
- type?: string | undefined;
1484
- deprecation?: string | undefined;
1485
- name?: string | undefined;
1486
- profile?: string | undefined;
1487
- title?: string | undefined;
1488
- hreflang?: string | undefined;
1489
- seen?: string | undefined;
1490
- } | undefined;
1491
- "rel:update"?: {
1492
- href: string;
1493
- templated?: boolean | undefined;
1494
- type?: string | undefined;
1495
- deprecation?: string | undefined;
1496
- name?: string | undefined;
1497
- profile?: string | undefined;
1498
- title?: string | undefined;
1499
- hreflang?: string | undefined;
1500
- seen?: string | undefined;
1501
- } | undefined;
1502
- self: {
1503
- href: string;
1504
- templated?: boolean | undefined;
1505
- type?: string | undefined;
1506
- deprecation?: string | undefined;
1507
- name?: string | undefined;
1508
- profile?: string | undefined;
1509
- title?: string | undefined;
1510
- hreflang?: string | undefined;
1511
- seen?: string | undefined;
1512
- };
1513
- };
1514
- }[];
1515
- } | undefined;
1516
- links: {
1517
- self: {
1518
- href: string;
1519
- templated?: boolean | undefined;
1520
- type?: string | undefined;
1521
- deprecation?: string | undefined;
1522
- name?: string | undefined;
1523
- profile?: string | undefined;
1524
- title?: string | undefined;
1525
- hreflang?: string | undefined;
1526
- seen?: string | undefined;
1527
- };
1528
- "rel:eventmetadata"?: {
1529
- href: string;
1530
- templated?: boolean | undefined;
1531
- type?: string | undefined;
1532
- deprecation?: string | undefined;
1533
- name?: string | undefined;
1534
- profile?: string | undefined;
1535
- title?: string | undefined;
1536
- hreflang?: string | undefined;
1537
- seen?: string | undefined;
1538
- } | undefined;
1539
- };
1540
- }>;
1541
- getAllEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: GetAllEventMetadataForProviderParams, fetchOptions?: ky4.Options): Promise<{
1542
- embedded: {
1543
- description: string;
1544
- label: string;
1545
- eventCode: string;
1546
- embedded?: {
1547
- sampleEvent?: {
1548
- format: string;
1549
- samplePayload?: string | undefined;
1550
- links: {
1551
- self: {
1552
- href: string;
1553
- templated?: boolean | undefined;
1554
- type?: string | undefined;
1555
- deprecation?: string | undefined;
1556
- name?: string | undefined;
1557
- profile?: string | undefined;
1558
- title?: string | undefined;
1559
- hreflang?: string | undefined;
1560
- seen?: string | undefined;
1561
- };
1562
- };
1563
- } | undefined;
1564
- } | undefined;
1565
- links: {
1566
- "rel:sampleEvent"?: {
1567
- href: string;
1568
- templated?: boolean | undefined;
1569
- type?: string | undefined;
1570
- deprecation?: string | undefined;
1571
- name?: string | undefined;
1572
- profile?: string | undefined;
1573
- title?: string | undefined;
1574
- hreflang?: string | undefined;
1575
- seen?: string | undefined;
1576
- } | undefined;
1577
- "rel:update"?: {
1578
- href: string;
1579
- templated?: boolean | undefined;
1580
- type?: string | undefined;
1581
- deprecation?: string | undefined;
1582
- name?: string | undefined;
1583
- profile?: string | undefined;
1584
- title?: string | undefined;
1585
- hreflang?: string | undefined;
1586
- seen?: string | undefined;
1587
- } | undefined;
1588
- self: {
1589
- href: string;
1590
- templated?: boolean | undefined;
1591
- type?: string | undefined;
1592
- deprecation?: string | undefined;
1593
- name?: string | undefined;
1594
- profile?: string | undefined;
1595
- title?: string | undefined;
1596
- hreflang?: string | undefined;
1597
- seen?: string | undefined;
1598
- };
1599
- };
1600
- }[];
1601
- }>;
1602
- getEventMetadataForEventAndProvider(httpClient: AdobeIoEventsHttpClient, params: GetEventMetadataForEventAndProviderParams, fetchOptions?: ky4.Options): Promise<{
1603
- description: string;
1604
- label: string;
1605
- eventCode: string;
1606
- embedded?: {
1607
- sampleEvent?: {
1608
- format: string;
1609
- samplePayload?: string | undefined;
1610
- links: {
1611
- self: {
1612
- href: string;
1613
- templated?: boolean | undefined;
1614
- type?: string | undefined;
1615
- deprecation?: string | undefined;
1616
- name?: string | undefined;
1617
- profile?: string | undefined;
1618
- title?: string | undefined;
1619
- hreflang?: string | undefined;
1620
- seen?: string | undefined;
1621
- };
1622
- };
1623
- } | undefined;
1624
- } | undefined;
1625
- links: {
1626
- "rel:sampleEvent"?: {
1627
- href: string;
1628
- templated?: boolean | undefined;
1629
- type?: string | undefined;
1630
- deprecation?: string | undefined;
1631
- name?: string | undefined;
1632
- profile?: string | undefined;
1633
- title?: string | undefined;
1634
- hreflang?: string | undefined;
1635
- seen?: string | undefined;
1636
- } | undefined;
1637
- "rel:update"?: {
1638
- href: string;
1639
- templated?: boolean | undefined;
1640
- type?: string | undefined;
1641
- deprecation?: string | undefined;
1642
- name?: string | undefined;
1643
- profile?: string | undefined;
1644
- title?: string | undefined;
1645
- hreflang?: string | undefined;
1646
- seen?: string | undefined;
1647
- } | undefined;
1648
- self: {
1649
- href: string;
1650
- templated?: boolean | undefined;
1651
- type?: string | undefined;
1652
- deprecation?: string | undefined;
1653
- name?: string | undefined;
1654
- profile?: string | undefined;
1655
- title?: string | undefined;
1656
- hreflang?: string | undefined;
1657
- seen?: string | undefined;
1658
- };
1659
- };
1660
- }>;
1661
- createEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: CreateEventMetadataForProviderParams, fetchOptions?: ky4.Options): Promise<{
1662
- description: string;
1663
- label: string;
292
+ //#region source/io-events/api/event-registrations/schema.d.ts
293
+ /** Schema for delivery type validation. */
294
+ declare const DeliveryTypeSchema: v.PicklistSchema<readonly ["webhook", "webhook_batch", "journal", "aws_eventbridge"], `Expected delivery type to be one of: ${string}`>;
295
+ /** Schema for events of interest. */
296
+ declare const EventsOfInterestSchema: v.ObjectSchema<{
297
+ readonly providerId: v.StringSchema<`Expected a string value for '${string}'`>;
298
+ readonly eventCode: v.StringSchema<`Expected a string value for '${string}'`>;
299
+ readonly providerMetadataId: v.OptionalSchema<v.StringSchema<`Expected a string value for '${string}'`>, undefined>;
300
+ }, undefined>;
301
+ /** Schema for AWS EventBridge destination metadata. */
302
+ declare const DestinationMetadataSchema: v.ObjectSchema<{
303
+ readonly awsRegion: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, "Expected AWS region in format like 'us-east-1'">]>, undefined>;
304
+ readonly awsAccountId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, "Expected AWS account ID to be a 12-digit number">]>, undefined>;
305
+ }, undefined>;
306
+ /** Schema for subscriber-defined filter. */
307
+ declare const SubscriberFilterSchema: v.ObjectSchema<{
308
+ readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MinLengthAction<string, 3, "Expected subscriber filter name to be at least 3 characters">, v.MaxLengthAction<string, 80, "Expected subscriber filter name to be at most 80 characters">]>;
309
+ readonly description: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MaxLengthAction<string, 250, "Expected subscriber filter description to be at most 250 characters">]>, undefined>;
310
+ readonly subscriberFilter: v.StringSchema<`Expected a string value for '${string}'`>;
311
+ }, undefined>;
312
+ /** Schema for getting all registrations for a workspace. */
313
+ declare const GetAllRegistrationsParamsSchema: v.ObjectSchema<{
314
+ readonly consumerOrgId: v.StringSchema<`Expected a string value for '${string}'`>;
315
+ readonly projectId: v.StringSchema<`Expected a string value for '${string}'`>;
316
+ readonly workspaceId: v.StringSchema<`Expected a string value for '${string}'`>;
317
+ }, undefined>;
318
+ /** Schema for getting all registrations for a consumer organization. */
319
+ declare const GetAllRegistrationsByConsumerOrgParamsSchema: v.ObjectSchema<{
320
+ readonly consumerOrgId: v.StringSchema<`Expected a string value for '${string}'`>;
321
+ }, undefined>;
322
+ /** Schema for getting a registration by ID. */
323
+ declare const GetRegistrationByIdParamsSchema: v.ObjectSchema<{
324
+ readonly registrationId: v.StringSchema<`Expected a string value for '${string}'`>;
325
+ readonly consumerOrgId: v.StringSchema<`Expected a string value for '${string}'`>;
326
+ readonly projectId: v.StringSchema<`Expected a string value for '${string}'`>;
327
+ readonly workspaceId: v.StringSchema<`Expected a string value for '${string}'`>;
328
+ }, undefined>;
329
+ /** Schema for creating a registration. */
330
+ declare const CreateRegistrationParamsSchema: v.ObjectSchema<{
331
+ readonly clientId: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MinLengthAction<string, 3, "Expected clientId to be at least 1 character">, v.MaxLengthAction<string, 255, "Expected clientId to be at most 255 characters">]>;
332
+ readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MinLengthAction<string, 3, "Expected registration name to be at least 3 characters">, v.MaxLengthAction<string, 255, "Expected registration name to be at most 255 characters">]>;
333
+ readonly description: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MaxLengthAction<string, 5000, "Expected description to be at most 5000 characters">]>, undefined>;
334
+ readonly webhookUrl: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MaxLengthAction<string, 4000, "Expected webhook URL to be at most 4000 characters">]>, undefined>;
335
+ readonly eventsOfInterest: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
336
+ readonly providerId: v.StringSchema<`Expected a string value for '${string}'`>;
337
+ readonly eventCode: v.StringSchema<`Expected a string value for '${string}'`>;
338
+ readonly providerMetadataId: v.OptionalSchema<v.StringSchema<`Expected a string value for '${string}'`>, undefined>;
339
+ }, undefined>, "Expected eventsOfInterest to be an array of event interest objects">, v.MinLengthAction<{
340
+ providerId: string;
1664
341
  eventCode: string;
1665
- embedded?: {
1666
- sampleEvent?: {
1667
- format: string;
1668
- samplePayload?: string | undefined;
1669
- links: {
1670
- self: {
1671
- href: string;
1672
- templated?: boolean | undefined;
1673
- type?: string | undefined;
1674
- deprecation?: string | undefined;
1675
- name?: string | undefined;
1676
- profile?: string | undefined;
1677
- title?: string | undefined;
1678
- hreflang?: string | undefined;
1679
- seen?: string | undefined;
1680
- };
1681
- };
1682
- } | undefined;
1683
- } | undefined;
1684
- links: {
1685
- "rel:sampleEvent"?: {
1686
- href: string;
1687
- templated?: boolean | undefined;
1688
- type?: string | undefined;
1689
- deprecation?: string | undefined;
1690
- name?: string | undefined;
1691
- profile?: string | undefined;
1692
- title?: string | undefined;
1693
- hreflang?: string | undefined;
1694
- seen?: string | undefined;
1695
- } | undefined;
1696
- "rel:update"?: {
1697
- href: string;
1698
- templated?: boolean | undefined;
1699
- type?: string | undefined;
1700
- deprecation?: string | undefined;
1701
- name?: string | undefined;
1702
- profile?: string | undefined;
1703
- title?: string | undefined;
1704
- hreflang?: string | undefined;
1705
- seen?: string | undefined;
1706
- } | undefined;
1707
- self: {
1708
- href: string;
1709
- templated?: boolean | undefined;
1710
- type?: string | undefined;
1711
- deprecation?: string | undefined;
1712
- name?: string | undefined;
1713
- profile?: string | undefined;
1714
- title?: string | undefined;
1715
- hreflang?: string | undefined;
1716
- seen?: string | undefined;
1717
- };
1718
- };
1719
- }>;
1720
- getAllEventProviders(httpClient: AdobeIoEventsHttpClient, params: EventProviderListAllParams, fetchOptions?: ky4.Options): Promise<{
1721
- embedded: {
1722
- providers: {
1723
- id: string;
1724
- instanceId?: string | undefined;
1725
- label: string;
1726
- source: string;
1727
- publisher: string;
1728
- providerMetadata: string;
1729
- eventDeliveryFormat: string;
1730
- description?: string | undefined;
1731
- docsUrl?: string | undefined;
1732
- embedded?: {
1733
- eventmetadata: {
1734
- description: string;
1735
- label: string;
1736
- eventCode: string;
1737
- embedded?: {
1738
- sampleEvent?: {
1739
- format: string;
1740
- samplePayload?: string | undefined;
1741
- links: {
1742
- self: {
1743
- href: string;
1744
- templated?: boolean | undefined;
1745
- type?: string | undefined;
1746
- deprecation?: string | undefined;
1747
- name?: string | undefined;
1748
- profile?: string | undefined;
1749
- title?: string | undefined;
1750
- hreflang?: string | undefined;
1751
- seen?: string | undefined;
1752
- };
1753
- };
1754
- } | undefined;
1755
- } | undefined;
1756
- links: {
1757
- "rel:sampleEvent"?: {
1758
- href: string;
1759
- templated?: boolean | undefined;
1760
- type?: string | undefined;
1761
- deprecation?: string | undefined;
1762
- name?: string | undefined;
1763
- profile?: string | undefined;
1764
- title?: string | undefined;
1765
- hreflang?: string | undefined;
1766
- seen?: string | undefined;
1767
- } | undefined;
1768
- "rel:update"?: {
1769
- href: string;
1770
- templated?: boolean | undefined;
1771
- type?: string | undefined;
1772
- deprecation?: string | undefined;
1773
- name?: string | undefined;
1774
- profile?: string | undefined;
1775
- title?: string | undefined;
1776
- hreflang?: string | undefined;
1777
- seen?: string | undefined;
1778
- } | undefined;
1779
- self: {
1780
- href: string;
1781
- templated?: boolean | undefined;
1782
- type?: string | undefined;
1783
- deprecation?: string | undefined;
1784
- name?: string | undefined;
1785
- profile?: string | undefined;
1786
- title?: string | undefined;
1787
- hreflang?: string | undefined;
1788
- seen?: string | undefined;
1789
- };
1790
- };
1791
- }[];
1792
- } | undefined;
1793
- links: {
1794
- self: {
1795
- href: string;
1796
- templated?: boolean | undefined;
1797
- type?: string | undefined;
1798
- deprecation?: string | undefined;
1799
- name?: string | undefined;
1800
- profile?: string | undefined;
1801
- title?: string | undefined;
1802
- hreflang?: string | undefined;
1803
- seen?: string | undefined;
1804
- };
1805
- "rel:eventmetadata"?: {
1806
- href: string;
1807
- templated?: boolean | undefined;
1808
- type?: string | undefined;
1809
- deprecation?: string | undefined;
1810
- name?: string | undefined;
1811
- profile?: string | undefined;
1812
- title?: string | undefined;
1813
- hreflang?: string | undefined;
1814
- seen?: string | undefined;
1815
- } | undefined;
1816
- };
1817
- }[];
1818
- };
1819
- links: {
1820
- self: {
1821
- href: string;
1822
- templated?: boolean | undefined;
1823
- type?: string | undefined;
1824
- deprecation?: string | undefined;
1825
- name?: string | undefined;
1826
- profile?: string | undefined;
1827
- title?: string | undefined;
1828
- hreflang?: string | undefined;
1829
- seen?: string | undefined;
1830
- };
1831
- };
1832
- }>;
1833
- getEventProviderById(httpClient: AdobeIoEventsHttpClient, params: EventProviderGetByIdParams, fetchOptions?: ky4.Options): Promise<{
1834
- id: string;
1835
- instanceId?: string | undefined;
1836
- label: string;
1837
- source: string;
1838
- publisher: string;
1839
- providerMetadata: string;
1840
- eventDeliveryFormat: string;
342
+ providerMetadataId?: string | undefined;
343
+ }[], 1, "Expected at least one event of interest">]>;
344
+ readonly deliveryType: v.PicklistSchema<readonly ["webhook", "webhook_batch", "journal", "aws_eventbridge"], `Expected delivery type to be one of: ${string}`>;
345
+ readonly runtimeAction: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MaxLengthAction<string, 255, "Expected runtime action to be at most 255 characters">]>, undefined>;
346
+ readonly enabled: v.OptionalSchema<v.BooleanSchema<`Expected a boolean value for '${string}'`>, undefined>;
347
+ readonly destinationMetadata: v.OptionalSchema<v.ObjectSchema<{
348
+ readonly awsRegion: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, "Expected AWS region in format like 'us-east-1'">]>, undefined>;
349
+ readonly awsAccountId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, "Expected AWS account ID to be a 12-digit number">]>, undefined>;
350
+ }, undefined>, undefined>;
351
+ readonly subscriberFilters: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
352
+ readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MinLengthAction<string, 3, "Expected subscriber filter name to be at least 3 characters">, v.MaxLengthAction<string, 80, "Expected subscriber filter name to be at most 80 characters">]>;
353
+ readonly description: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MaxLengthAction<string, 250, "Expected subscriber filter description to be at most 250 characters">]>, undefined>;
354
+ readonly subscriberFilter: v.StringSchema<`Expected a string value for '${string}'`>;
355
+ }, undefined>, "Expected subscriberFilters to be an array of subscriber filter objects">, v.MaxLengthAction<{
356
+ name: string;
1841
357
  description?: string | undefined;
1842
- docsUrl?: string | undefined;
1843
- embedded?: {
1844
- eventmetadata: {
1845
- description: string;
1846
- label: string;
1847
- eventCode: string;
1848
- embedded?: {
1849
- sampleEvent?: {
1850
- format: string;
1851
- samplePayload?: string | undefined;
1852
- links: {
1853
- self: {
1854
- href: string;
1855
- templated?: boolean | undefined;
1856
- type?: string | undefined;
1857
- deprecation?: string | undefined;
1858
- name?: string | undefined;
1859
- profile?: string | undefined;
1860
- title?: string | undefined;
1861
- hreflang?: string | undefined;
1862
- seen?: string | undefined;
1863
- };
1864
- };
1865
- } | undefined;
1866
- } | undefined;
1867
- links: {
1868
- "rel:sampleEvent"?: {
1869
- href: string;
1870
- templated?: boolean | undefined;
1871
- type?: string | undefined;
1872
- deprecation?: string | undefined;
1873
- name?: string | undefined;
1874
- profile?: string | undefined;
1875
- title?: string | undefined;
1876
- hreflang?: string | undefined;
1877
- seen?: string | undefined;
1878
- } | undefined;
1879
- "rel:update"?: {
1880
- href: string;
1881
- templated?: boolean | undefined;
1882
- type?: string | undefined;
1883
- deprecation?: string | undefined;
1884
- name?: string | undefined;
1885
- profile?: string | undefined;
1886
- title?: string | undefined;
1887
- hreflang?: string | undefined;
1888
- seen?: string | undefined;
1889
- } | undefined;
1890
- self: {
1891
- href: string;
1892
- templated?: boolean | undefined;
1893
- type?: string | undefined;
1894
- deprecation?: string | undefined;
1895
- name?: string | undefined;
1896
- profile?: string | undefined;
1897
- title?: string | undefined;
1898
- hreflang?: string | undefined;
1899
- seen?: string | undefined;
1900
- };
1901
- };
1902
- }[];
1903
- } | undefined;
1904
- links: {
1905
- self: {
1906
- href: string;
1907
- templated?: boolean | undefined;
1908
- type?: string | undefined;
1909
- deprecation?: string | undefined;
1910
- name?: string | undefined;
1911
- profile?: string | undefined;
1912
- title?: string | undefined;
1913
- hreflang?: string | undefined;
1914
- seen?: string | undefined;
1915
- };
1916
- "rel:eventmetadata"?: {
1917
- href: string;
1918
- templated?: boolean | undefined;
1919
- type?: string | undefined;
1920
- deprecation?: string | undefined;
1921
- name?: string | undefined;
1922
- profile?: string | undefined;
1923
- title?: string | undefined;
1924
- hreflang?: string | undefined;
1925
- seen?: string | undefined;
1926
- } | undefined;
1927
- };
1928
- }>;
1929
- createEventProvider(httpClient: AdobeIoEventsHttpClient, params: EventProviderCreateParams, fetchOptions?: ky4.Options): Promise<{
1930
- id: string;
1931
- instanceId?: string | undefined;
1932
- label: string;
1933
- source: string;
1934
- publisher: string;
1935
- providerMetadata: string;
1936
- eventDeliveryFormat: string;
358
+ subscriberFilter: string;
359
+ }[], 1, "Expected at most 1 subscriber filter">]>, undefined>;
360
+ readonly consumerOrgId: v.StringSchema<`Expected a string value for '${string}'`>;
361
+ readonly projectId: v.StringSchema<`Expected a string value for '${string}'`>;
362
+ readonly workspaceId: v.StringSchema<`Expected a string value for '${string}'`>;
363
+ }, undefined>;
364
+ /** Schema for updating a registration. */
365
+ declare const UpdateRegistrationParamsSchema: v.ObjectSchema<{
366
+ readonly clientId: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MinLengthAction<string, 3, "Expected clientId to be at least 1 character">, v.MaxLengthAction<string, 255, "Expected clientId to be at most 255 characters">]>;
367
+ readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MinLengthAction<string, 3, "Expected registration name to be at least 3 characters">, v.MaxLengthAction<string, 255, "Expected registration name to be at most 255 characters">]>;
368
+ readonly description: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MaxLengthAction<string, 5000, "Expected description to be at most 5000 characters">]>, undefined>;
369
+ readonly webhookUrl: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MaxLengthAction<string, 4000, "Expected webhook URL to be at most 4000 characters">]>, undefined>;
370
+ readonly eventsOfInterest: v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
371
+ readonly providerId: v.StringSchema<`Expected a string value for '${string}'`>;
372
+ readonly eventCode: v.StringSchema<`Expected a string value for '${string}'`>;
373
+ readonly providerMetadataId: v.OptionalSchema<v.StringSchema<`Expected a string value for '${string}'`>, undefined>;
374
+ }, undefined>, "Expected eventsOfInterest to be an array of event interest objects">, v.MinLengthAction<{
375
+ providerId: string;
376
+ eventCode: string;
377
+ providerMetadataId?: string | undefined;
378
+ }[], 1, "Expected at least one event of interest">]>;
379
+ readonly deliveryType: v.PicklistSchema<readonly ["webhook", "webhook_batch", "journal", "aws_eventbridge"], `Expected delivery type to be one of: ${string}`>;
380
+ readonly runtimeAction: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MaxLengthAction<string, 255, "Expected runtime action to be at most 255 characters">]>, undefined>;
381
+ readonly enabled: v.OptionalSchema<v.BooleanSchema<`Expected a boolean value for '${string}'`>, undefined>;
382
+ readonly destinationMetadata: v.OptionalSchema<v.ObjectSchema<{
383
+ readonly awsRegion: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, "Expected AWS region in format like 'us-east-1'">]>, undefined>;
384
+ readonly awsAccountId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, "Expected AWS account ID to be a 12-digit number">]>, undefined>;
385
+ }, undefined>, undefined>;
386
+ readonly subscriberFilters: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
387
+ readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MinLengthAction<string, 3, "Expected subscriber filter name to be at least 3 characters">, v.MaxLengthAction<string, 80, "Expected subscriber filter name to be at most 80 characters">]>;
388
+ readonly description: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.MaxLengthAction<string, 250, "Expected subscriber filter description to be at most 250 characters">]>, undefined>;
389
+ readonly subscriberFilter: v.StringSchema<`Expected a string value for '${string}'`>;
390
+ }, undefined>, "Expected subscriberFilters to be an array of subscriber filter objects">, v.MaxLengthAction<{
391
+ name: string;
1937
392
  description?: string | undefined;
1938
- docsUrl?: string | undefined;
1939
- embedded?: {
1940
- eventmetadata: {
1941
- description: string;
1942
- label: string;
1943
- eventCode: string;
1944
- embedded?: {
1945
- sampleEvent?: {
1946
- format: string;
1947
- samplePayload?: string | undefined;
1948
- links: {
1949
- self: {
1950
- href: string;
1951
- templated?: boolean | undefined;
1952
- type?: string | undefined;
1953
- deprecation?: string | undefined;
1954
- name?: string | undefined;
1955
- profile?: string | undefined;
1956
- title?: string | undefined;
1957
- hreflang?: string | undefined;
1958
- seen?: string | undefined;
1959
- };
1960
- };
1961
- } | undefined;
1962
- } | undefined;
1963
- links: {
1964
- "rel:sampleEvent"?: {
1965
- href: string;
1966
- templated?: boolean | undefined;
1967
- type?: string | undefined;
1968
- deprecation?: string | undefined;
1969
- name?: string | undefined;
1970
- profile?: string | undefined;
1971
- title?: string | undefined;
1972
- hreflang?: string | undefined;
1973
- seen?: string | undefined;
1974
- } | undefined;
1975
- "rel:update"?: {
1976
- href: string;
1977
- templated?: boolean | undefined;
1978
- type?: string | undefined;
1979
- deprecation?: string | undefined;
1980
- name?: string | undefined;
1981
- profile?: string | undefined;
1982
- title?: string | undefined;
1983
- hreflang?: string | undefined;
1984
- seen?: string | undefined;
1985
- } | undefined;
1986
- self: {
1987
- href: string;
1988
- templated?: boolean | undefined;
1989
- type?: string | undefined;
1990
- deprecation?: string | undefined;
1991
- name?: string | undefined;
1992
- profile?: string | undefined;
1993
- title?: string | undefined;
1994
- hreflang?: string | undefined;
1995
- seen?: string | undefined;
1996
- };
1997
- };
1998
- }[];
1999
- } | undefined;
2000
- links: {
2001
- self: {
2002
- href: string;
2003
- templated?: boolean | undefined;
2004
- type?: string | undefined;
2005
- deprecation?: string | undefined;
2006
- name?: string | undefined;
2007
- profile?: string | undefined;
2008
- title?: string | undefined;
2009
- hreflang?: string | undefined;
2010
- seen?: string | undefined;
2011
- };
2012
- "rel:eventmetadata"?: {
2013
- href: string;
2014
- templated?: boolean | undefined;
2015
- type?: string | undefined;
2016
- deprecation?: string | undefined;
2017
- name?: string | undefined;
2018
- profile?: string | undefined;
2019
- title?: string | undefined;
2020
- hreflang?: string | undefined;
2021
- seen?: string | undefined;
2022
- } | undefined;
2023
- };
2024
- }>;
2025
- }>;
393
+ subscriberFilter: string;
394
+ }[], 1, "Expected at most 1 subscriber filter">]>, undefined>;
395
+ readonly registrationId: v.StringSchema<`Expected a string value for '${string}'`>;
396
+ readonly consumerOrgId: v.StringSchema<`Expected a string value for '${string}'`>;
397
+ readonly projectId: v.StringSchema<`Expected a string value for '${string}'`>;
398
+ readonly workspaceId: v.StringSchema<`Expected a string value for '${string}'`>;
399
+ }, undefined>;
400
+ /** Schema for deleting a registration. */
401
+ declare const DeleteRegistrationParamsSchema: v.ObjectSchema<{
402
+ readonly registrationId: v.StringSchema<`Expected a string value for '${string}'`>;
403
+ readonly consumerOrgId: v.StringSchema<`Expected a string value for '${string}'`>;
404
+ readonly projectId: v.StringSchema<`Expected a string value for '${string}'`>;
405
+ readonly workspaceId: v.StringSchema<`Expected a string value for '${string}'`>;
406
+ }, undefined>;
2026
407
  /**
2027
- * Creates a customized Adobe I/O Events API client.
2028
- * @param params - The parameters to build the Adobe I/O Events HTTP client that will communicate with the Adobe I/O Events API.
2029
- * @param functions - The API functions to include in the client.
408
+ * The parameters for getting all registrations for a workspace.
409
+ * @see https://developer.adobe.com/events/docs/api#operation/getAllRegistrations
2030
410
  */
2031
- declare function createCustomAdobeIoEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeIoEventsHttpClient, any[], any>>>(params: IoEventsHttpClientParams, functions: TFunctions): _adobe_aio_commerce_lib_api1.ApiClientRecord<AdobeIoEventsHttpClient, TFunctions>;
2032
- //#endregion
2033
- //#region source/io-events/types.d.ts
2034
- type HALLink = {
2035
- href: string;
2036
- templated?: boolean;
2037
- type?: string;
2038
- deprecation?: string;
2039
- name?: string;
2040
- profile?: string;
2041
- title?: string;
2042
- hreflang?: string;
2043
- seen?: string;
2044
- };
411
+ type GetAllRegistrationsParams = v.InferInput<typeof GetAllRegistrationsParamsSchema>;
412
+ /**
413
+ * The parameters for getting all registrations for a consumer organization.
414
+ * @see https://developer.adobe.com/events/docs/api#operation/getAllRegistrationsForOrg
415
+ */
416
+ type GetAllRegistrationsByConsumerOrgParams = v.InferInput<typeof GetAllRegistrationsByConsumerOrgParamsSchema>;
417
+ /**
418
+ * The parameters for getting a registration by ID.
419
+ * @see https://developer.adobe.com/events/docs/api#operation/getRegistration
420
+ */
421
+ type GetRegistrationByIdParams = v.InferInput<typeof GetRegistrationByIdParamsSchema>;
422
+ /**
423
+ * The parameters for creating a registration.
424
+ * @see https://developer.adobe.com/events/docs/api#operation/createRegistration
425
+ */
426
+ type CreateRegistrationParams = v.InferInput<typeof CreateRegistrationParamsSchema>;
427
+ /**
428
+ * The parameters for updating a registration.
429
+ * @see https://developer.adobe.com/events/docs/api#operation/updateRegistration
430
+ */
431
+ type UpdateRegistrationParams = v.InferInput<typeof UpdateRegistrationParamsSchema>;
432
+ /**
433
+ * The parameters for deleting a registration.
434
+ * @see https://developer.adobe.com/events/docs/api#operation/deleteRegistration
435
+ */
436
+ type DeleteRegistrationParams = v.InferInput<typeof DeleteRegistrationParamsSchema>;
437
+ /**
438
+ * The subscriber-defined filter for a registration.
439
+ */
440
+ type SubscriberFilter = v.InferInput<typeof SubscriberFilterSchema>;
441
+ /**
442
+ * The delivery type for a registration.
443
+ */
444
+ type DeliveryType = v.InferOutput<typeof DeliveryTypeSchema>;
2045
445
  //#endregion
2046
- //#region source/io-events/api/event-metadata/types.d.ts
2047
- /** Defines the base fields of an event metadata entity. */
2048
- type IoEventMetadata = {
2049
- description: string;
2050
- label: string;
446
+ //#region source/io-events/api/event-registrations/types.d.ts
447
+ /** Defines the events of interest for a registration (API response format - snake_case). */
448
+ type EventsOfInterest = {
449
+ provider_id: string;
2051
450
  event_code: string;
451
+ provider_metadata_id?: string;
2052
452
  };
2053
- /** Defines the fields of a sample event entity returned by the Adobe I/O Events API. */
2054
- type SampleEventHalModel = {
2055
- format: string;
2056
- sample_payload?: string;
2057
- _links: {
2058
- self: HALLink;
2059
- };
453
+ /** Defines the destination metadata for AWS EventBridge delivery (API response format - snake_case). */
454
+ type DestinationMetadata = {
455
+ aws_region?: string;
456
+ aws_account_id?: string;
2060
457
  };
2061
- /** Defines the fields of an event metadata entity returned by the Adobe I/O Events API. */
2062
- type IoEventMetadataHalModel = IoEventMetadata & {
2063
- _embedded?: {
2064
- sample_event?: SampleEventHalModel;
2065
- };
458
+ /** Defines a subscriber-defined filter (from API response). */
459
+ type SubscriberFilterModel = {
460
+ id?: string;
461
+ name: string;
462
+ description?: string;
463
+ subscriber_filter: string;
464
+ };
465
+ /** Defines the base fields of an I/O event registration entity. */
466
+ type IoEventRegistration = {
467
+ id: string;
468
+ name: string;
469
+ description?: string;
470
+ client_id: string;
471
+ parent_client_id?: string;
472
+ webhook_url?: string;
473
+ status: string;
474
+ type: string;
475
+ integration_status: string;
476
+ events_of_interest: EventsOfInterest[];
477
+ registration_id: string;
478
+ delivery_type: DeliveryType;
479
+ events_url?: string;
480
+ runtime_action?: string;
481
+ enabled?: boolean;
482
+ created_date?: string;
483
+ updated_date?: string;
484
+ destination_metadata?: DestinationMetadata;
485
+ subscriber_filters?: SubscriberFilterModel[];
486
+ };
487
+ /** Defines the fields of an I/O event registration entity returned by the Adobe I/O Events API. */
488
+ type IoEventRegistrationHalModel = IoEventRegistration & {
2066
489
  _links: {
2067
- "rel:sample_event"?: HALLink;
2068
- "rel:update"?: HALLink;
2069
490
  self: HALLink;
491
+ "rel:events"?: HALLink;
492
+ "rel:update"?: HALLink;
493
+ "rel:delete"?: HALLink;
2070
494
  };
2071
495
  };
2072
- /** Defines the fields of an event metadata entity returned by the Adobe I/O Events API. */
2073
- type IoEventMetadataOneResponse = CamelCasedPropertiesDeep<IoEventMetadataHalModel>;
2074
- /** Defines the fields of many event metadata entities returned by the Adobe I/O Events API. */
2075
- type IoEventMetadataManyResponse = CamelCasedPropertiesDeep<{
2076
- _embedded: IoEventMetadataHalModel[];
2077
- }>;
2078
- //#endregion
2079
- //#region source/io-events/api/event-providers/types.d.ts
2080
- /** Defines the base fields of an I/O event provider entity. */
2081
- type IoEventProvider = {
2082
- id: string;
2083
- instance_id?: string;
2084
- label: string;
2085
- source: string;
2086
- publisher: string;
2087
- provider_metadata: string;
2088
- event_delivery_format: string;
2089
- description?: string;
2090
- docs_url?: string;
496
+ /** Defines the fields of an I/O event registration entity returned by the Adobe I/O Events API. */
497
+ type IoEventRegistrationOneResponse = IoEventRegistrationHalModel;
498
+ /** Defines the pagination metadata for paginated responses. */
499
+ type PageMetadata = {
500
+ size: number;
501
+ number: number;
502
+ numberOfElements: number;
503
+ totalElements: number;
504
+ totalPages: number;
2091
505
  };
2092
- /** Defines the fields of an I/O event provider entity returned by the Adobe I/O Events API. */
2093
- type IoEventProviderHalModel = IoEventProvider & {
2094
- _embedded?: {
2095
- eventmetadata: IoEventMetadataHalModel[];
506
+ /** Defines the fields of many I/O event registration entities returned by the Adobe I/O Events API (workspace-specific). */
507
+ type IoEventRegistrationManyResponse = {
508
+ _embedded: {
509
+ registrations: IoEventRegistrationHalModel[];
2096
510
  };
2097
511
  _links: {
2098
512
  self: HALLink;
2099
- "rel:eventmetadata"?: HALLink;
2100
513
  };
2101
514
  };
2102
- /** Defines the fields of an I/O event provider entity returned by the Adobe I/O Events API. */
2103
- type IoEventProviderOneResponse = CamelCasedPropertiesDeep<IoEventProviderHalModel>;
2104
- /** Defines the fields of many I/O event provider entities returned by the Adobe I/O Events API. */
2105
- type IoEventProviderManyResponse = CamelCasedPropertiesDeep<{
515
+ /** Defines the fields of paginated I/O event registration entities returned by the Adobe I/O Events API (consumer org-level). */
516
+ type IoEventRegistrationPaginatedResponse = {
517
+ page: PageMetadata;
2106
518
  _embedded: {
2107
- providers: IoEventProviderHalModel[];
519
+ registrations: IoEventRegistrationHalModel[];
2108
520
  };
2109
521
  _links: {
522
+ first?: HALLink;
523
+ last?: HALLink;
524
+ next?: HALLink;
525
+ prev?: HALLink;
2110
526
  self: HALLink;
2111
527
  };
528
+ };
529
+ //#endregion
530
+ //#region source/io-events/api/event-registrations/endpoints.d.ts
531
+ /**
532
+ * Gets all event registrations for a consumer organization (paginated).
533
+ * @see https://developer.adobe.com/events/docs/api#operation/getAllRegistrationsForOrg
534
+ *
535
+ * @param httpClient - The {@link AdobeIoEventsHttpClient} to use to make the request.
536
+ * @param params - The parameters to get the registrations with.
537
+ * @param fetchOptions - The {@link Options} to use to make the request.
538
+ *
539
+ * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
540
+ * @throws An {@link HTTPError} If the status code is not 2XX.
541
+ */
542
+ declare function getAllRegistrationsByConsumerOrg(httpClient: AdobeIoEventsHttpClient, params: GetAllRegistrationsByConsumerOrgParams, fetchOptions?: Options): Promise<IoEventRegistrationPaginatedResponse>;
543
+ /**
544
+ * Gets all event registrations for a workspace.
545
+ * @see https://developer.adobe.com/events/docs/api#operation/getAllRegistrations
546
+ *
547
+ * @param httpClient - The {@link AdobeIoEventsHttpClient} to use to make the request.
548
+ * @param params - The parameters to get the registrations with.
549
+ * @param fetchOptions - The {@link Options} to use to make the request.
550
+ *
551
+ * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
552
+ * @throws An {@link HTTPError} If the status code is not 2XX.
553
+ */
554
+ declare function getAllRegistrations(httpClient: AdobeIoEventsHttpClient, params: GetAllRegistrationsParams, fetchOptions?: Options): Promise<IoEventRegistrationManyResponse>;
555
+ /**
556
+ * Gets an event registration by ID.
557
+ * @see https://developer.adobe.com/events/docs/api#operation/getRegistration
558
+ *
559
+ * @param httpClient - The {@link AdobeIoEventsHttpClient} to use to make the request.
560
+ * @param params - The parameters to get the registration with.
561
+ * @param fetchOptions - The {@link Options} to use to make the request.
562
+ *
563
+ * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
564
+ * @throws An {@link HTTPError} If the status code is not 2XX.
565
+ */
566
+ declare function getRegistrationById(httpClient: AdobeIoEventsHttpClient, params: GetRegistrationByIdParams, fetchOptions?: Options): Promise<IoEventRegistrationHalModel>;
567
+ /**
568
+ * Creates an event registration.
569
+ * @see https://developer.adobe.com/events/docs/api#operation/createRegistration
570
+ *
571
+ * @param httpClient - The {@link AdobeIoEventsHttpClient} to use to make the request.
572
+ * @param params - The parameters to create the registration with.
573
+ * @param fetchOptions - The {@link Options} to use to make the request.
574
+ *
575
+ * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
576
+ * @throws An {@link HTTPError} If the status code is not 2XX.
577
+ */
578
+ declare function createRegistration(httpClient: AdobeIoEventsHttpClient, params: CreateRegistrationParams, fetchOptions?: Options): Promise<IoEventRegistrationHalModel>;
579
+ /**
580
+ * Updates an event registration.
581
+ * @see https://developer.adobe.com/events/docs/api#operation/updateRegistration
582
+ *
583
+ * @param httpClient - The {@link AdobeIoEventsHttpClient} to use to make the request.
584
+ * @param params - The parameters to update the registration with.
585
+ * @param fetchOptions - The {@link Options} to use to make the request.
586
+ *
587
+ * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
588
+ * @throws An {@link HTTPError} If the status code is not 2XX.
589
+ */
590
+ declare function updateRegistration(httpClient: AdobeIoEventsHttpClient, params: UpdateRegistrationParams, fetchOptions?: Options): Promise<IoEventRegistrationHalModel>;
591
+ /**
592
+ * Deletes an event registration.
593
+ * @see https://developer.adobe.com/events/docs/api#operation/deleteRegistration
594
+ *
595
+ * @param httpClient - The {@link AdobeIoEventsHttpClient} to use to make the request.
596
+ * @param params - The parameters to delete the registration with.
597
+ * @param fetchOptions - The {@link Options} to use to make the request.
598
+ *
599
+ * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
600
+ * @throws An {@link HTTPError} If the status code is not 2XX.
601
+ */
602
+ declare function deleteRegistration(httpClient: AdobeIoEventsHttpClient, params: DeleteRegistrationParams, fetchOptions?: Options): Promise<void>;
603
+ //#endregion
604
+ //#region source/io-events/lib/api-client.d.ts
605
+ /**
606
+ * Creates a new API client for the Adobe I/O Events API client.
607
+ * @param params - The parameters to build the Adobe I/O Events HTTP client that will communicate with the Adobe I/O Events API.
608
+ */
609
+ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams): _adobe_aio_commerce_lib_api1.ApiClientRecord<AdobeIoEventsHttpClient, {
610
+ getAllRegistrationsByConsumerOrg(httpClient: AdobeIoEventsHttpClient, params: GetAllRegistrationsByConsumerOrgParams, fetchOptions?: ky4.Options): Promise<IoEventRegistrationPaginatedResponse>;
611
+ getAllRegistrations(httpClient: AdobeIoEventsHttpClient, params: GetAllRegistrationsParams, fetchOptions?: ky4.Options): Promise<IoEventRegistrationManyResponse>;
612
+ getRegistrationById(httpClient: AdobeIoEventsHttpClient, params: GetRegistrationByIdParams, fetchOptions?: ky4.Options): Promise<IoEventRegistrationHalModel>;
613
+ createRegistration(httpClient: AdobeIoEventsHttpClient, params: CreateRegistrationParams, fetchOptions?: ky4.Options): Promise<IoEventRegistrationHalModel>;
614
+ updateRegistration(httpClient: AdobeIoEventsHttpClient, params: UpdateRegistrationParams, fetchOptions?: ky4.Options): Promise<IoEventRegistrationHalModel>;
615
+ deleteRegistration(httpClient: AdobeIoEventsHttpClient, params: DeleteRegistrationParams, fetchOptions?: ky4.Options): Promise<void>;
616
+ getAllCommerceEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: ky4.Options): Promise<IoEventProviderManyResponse>;
617
+ getAll3rdPartyCustomEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: ky4.Options): Promise<IoEventProviderManyResponse>;
618
+ createCommerceEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: ky4.Options): Promise<IoEventProviderHalModel>;
619
+ create3rdPartyCustomEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: ky4.Options): Promise<IoEventProviderHalModel>;
620
+ getAllEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: GetAllEventMetadataForProviderParams, fetchOptions?: ky4.Options): Promise<IoEventMetadataManyResponse>;
621
+ getEventMetadataForEventAndProvider(httpClient: AdobeIoEventsHttpClient, params: GetEventMetadataForEventAndProviderParams, fetchOptions?: ky4.Options): Promise<IoEventMetadataHalModel>;
622
+ createEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: CreateEventMetadataForProviderParams, fetchOptions?: ky4.Options): Promise<IoEventMetadataHalModel>;
623
+ getAllEventProviders(httpClient: AdobeIoEventsHttpClient, params: EventProviderListAllParams, fetchOptions?: ky4.Options): Promise<IoEventProviderManyResponse>;
624
+ getEventProviderById(httpClient: AdobeIoEventsHttpClient, params: EventProviderGetByIdParams, fetchOptions?: ky4.Options): Promise<IoEventProviderHalModel>;
625
+ createEventProvider(httpClient: AdobeIoEventsHttpClient, params: EventProviderCreateParams, fetchOptions?: ky4.Options): Promise<IoEventProviderHalModel>;
2112
626
  }>;
627
+ /**
628
+ * An API Client for the Adobe I/O Events API.
629
+ * @see {@link createAdobeIoEventsApiClient}
630
+ */
631
+ type AdobeIoEventsApiClient = ReturnType<typeof createAdobeIoEventsApiClient>;
632
+ /**
633
+ * Creates a customized Adobe I/O Events API client.
634
+ * @param params - The parameters to build the Adobe I/O Events HTTP client that will communicate with the Adobe I/O Events API.
635
+ * @param functions - The API functions to include in the client.
636
+ */
637
+ declare function createCustomAdobeIoEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeIoEventsHttpClient, any[], any>>>(params: IoEventsHttpClientParams, functions: TFunctions): _adobe_aio_commerce_lib_api1.ApiClientRecord<AdobeIoEventsHttpClient, TFunctions>;
2113
638
  //#endregion
2114
- export { CreateEventMetadataForProviderParams, CreateEventMetadataForProviderSchema, EventProviderCreateParams, EventProviderCreateParamsSchema, EventProviderGetByIdParams, EventProviderGetByIdParamsSchema, EventProviderListAllParams, EventProviderListAllParamsSchema, GetAllEventMetadataForProviderParams, GetAllEventMetadataForProviderSchema, GetEventMetadataForEventAndProviderParams, GetEventMetadataForEventAndProviderSchema, type IoEventMetadata, type IoEventMetadataManyResponse, type IoEventMetadataOneResponse, type IoEventProvider, type IoEventProviderManyResponse, type IoEventProviderOneResponse, create3rdPartyCustomEventProvider, createAdobeIoEventsApiClient, createCommerceEventProvider, createCustomAdobeIoEventsApiClient, createEventMetadataForProvider, createEventProvider, getAll3rdPartyCustomEventProviders, getAllCommerceEventProviders, getAllEventMetadataForProvider, getAllEventProviders, getEventMetadataForEventAndProvider, getEventProviderById };
639
+ export { AdobeIoEventsApiClient, CreateEventMetadataForProviderParams, CreateEventMetadataForProviderSchema, CreateRegistrationParams, CreateRegistrationParamsSchema, DeleteRegistrationParams, DeleteRegistrationParamsSchema, DeliveryType, DeliveryTypeSchema, DestinationMetadataSchema, EventProviderCreateParams, EventProviderCreateParamsSchema, EventProviderGetByIdParams, EventProviderGetByIdParamsSchema, EventProviderListAllParams, EventProviderListAllParamsSchema, EventsOfInterestSchema, GetAllEventMetadataForProviderParams, GetAllEventMetadataForProviderSchema, GetAllRegistrationsByConsumerOrgParams, GetAllRegistrationsByConsumerOrgParamsSchema, GetAllRegistrationsParams, GetAllRegistrationsParamsSchema, GetEventMetadataForEventAndProviderParams, GetEventMetadataForEventAndProviderSchema, GetRegistrationByIdParams, GetRegistrationByIdParamsSchema, type IoEventMetadata, type IoEventMetadataManyResponse, type IoEventMetadataOneResponse, type IoEventProvider, type IoEventProviderManyResponse, type IoEventProviderOneResponse, type IoEventRegistration, type IoEventRegistrationManyResponse, type IoEventRegistrationOneResponse, type IoEventRegistrationPaginatedResponse, type PageMetadata, SubscriberFilter, type SubscriberFilterModel, SubscriberFilterSchema, UpdateRegistrationParams, UpdateRegistrationParamsSchema, create3rdPartyCustomEventProvider, createAdobeIoEventsApiClient, createCommerceEventProvider, createCustomAdobeIoEventsApiClient, createEventMetadataForProvider, createEventProvider, createRegistration, deleteRegistration, getAll3rdPartyCustomEventProviders, getAllCommerceEventProviders, getAllEventMetadataForProvider, getAllEventProviders, getAllRegistrations, getAllRegistrationsByConsumerOrg, getEventMetadataForEventAndProvider, getEventProviderById, getRegistrationById, updateRegistration };