@channel.io/app-sdk-core 0.13.0 → 0.14.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 (62) hide show
  1. package/dist/extensions/datasource.d.ts +522 -0
  2. package/dist/extensions/datasource.d.ts.map +1 -0
  3. package/dist/extensions/datasource.js +193 -0
  4. package/dist/extensions/datasource.js.map +1 -0
  5. package/dist/extensions/index.d.ts +2 -0
  6. package/dist/extensions/index.d.ts.map +1 -1
  7. package/dist/extensions/index.js +4 -0
  8. package/dist/extensions/index.js.map +1 -1
  9. package/dist/extensions/interfaces/datasource.d.ts +29 -0
  10. package/dist/extensions/interfaces/datasource.d.ts.map +1 -0
  11. package/dist/extensions/interfaces/datasource.js +6 -0
  12. package/dist/extensions/interfaces/datasource.js.map +1 -0
  13. package/dist/extensions/interfaces/index.d.ts +2 -0
  14. package/dist/extensions/interfaces/index.d.ts.map +1 -1
  15. package/dist/extensions/interfaces/index.js +2 -0
  16. package/dist/extensions/interfaces/index.js.map +1 -1
  17. package/dist/extensions/interfaces/polling.d.ts +67 -0
  18. package/dist/extensions/interfaces/polling.d.ts.map +1 -0
  19. package/dist/extensions/interfaces/polling.js +8 -0
  20. package/dist/extensions/interfaces/polling.js.map +1 -0
  21. package/dist/extensions/messaging.d.ts +59 -55
  22. package/dist/extensions/messaging.d.ts.map +1 -1
  23. package/dist/extensions/messaging.js.map +1 -1
  24. package/dist/extensions/polling.d.ts +147 -0
  25. package/dist/extensions/polling.d.ts.map +1 -0
  26. package/dist/extensions/polling.js +70 -0
  27. package/dist/extensions/polling.js.map +1 -0
  28. package/dist/gen/channel/app/sdk/v1/common.d.ts +586 -0
  29. package/dist/gen/channel/app/sdk/v1/common.d.ts.map +1 -0
  30. package/dist/gen/channel/app/sdk/v1/common.js +201 -0
  31. package/dist/gen/channel/app/sdk/v1/common.js.map +1 -0
  32. package/dist/gen/channel/app/sdk/v1/context.d.ts +52 -0
  33. package/dist/gen/channel/app/sdk/v1/context.d.ts.map +1 -0
  34. package/dist/gen/channel/app/sdk/v1/context.js +8 -0
  35. package/dist/gen/channel/app/sdk/v1/context.js.map +1 -0
  36. package/dist/gen/channel/app/sdk/v1/error.d.ts +8 -0
  37. package/dist/gen/channel/app/sdk/v1/error.d.ts.map +1 -0
  38. package/dist/gen/channel/app/sdk/v1/error.js +8 -0
  39. package/dist/gen/channel/app/sdk/v1/error.js.map +1 -0
  40. package/dist/gen/channel/app/sdk/v1/extension.d.ts +1098 -0
  41. package/dist/gen/channel/app/sdk/v1/extension.d.ts.map +1 -0
  42. package/dist/gen/channel/app/sdk/v1/extension.js +7 -0
  43. package/dist/gen/channel/app/sdk/v1/extension.js.map +1 -0
  44. package/dist/gen/channel/app/sdk/v1/function.d.ts +29 -0
  45. package/dist/gen/channel/app/sdk/v1/function.d.ts.map +1 -0
  46. package/dist/gen/channel/app/sdk/v1/function.js +7 -0
  47. package/dist/gen/channel/app/sdk/v1/function.js.map +1 -0
  48. package/dist/gen/channel/app/sdk/v1/native.d.ts +51 -0
  49. package/dist/gen/channel/app/sdk/v1/native.d.ts.map +1 -0
  50. package/dist/gen/channel/app/sdk/v1/native.js +7 -0
  51. package/dist/gen/channel/app/sdk/v1/native.js.map +1 -0
  52. package/dist/gen/google/protobuf/struct.d.ts +71 -0
  53. package/dist/gen/google/protobuf/struct.d.ts.map +1 -0
  54. package/dist/gen/google/protobuf/struct.js +19 -0
  55. package/dist/gen/google/protobuf/struct.js.map +1 -0
  56. package/dist/gen/io/channel/datasource/v1/datasource.d.ts +143 -0
  57. package/dist/gen/io/channel/datasource/v1/datasource.d.ts.map +1 -0
  58. package/dist/gen/io/channel/datasource/v1/datasource.js +36 -0
  59. package/dist/gen/io/channel/datasource/v1/datasource.js.map +1 -0
  60. package/dist/types/extension.d.ts +1 -1
  61. package/dist/types/extension.d.ts.map +1 -1
  62. package/package.json +3 -3
@@ -0,0 +1,1098 @@
1
+ import type { ChannelMessage, ChannelUser, ChannelUserChat, MediumProfile, PrebuiltMessage, UnavailableReason, WritingTypeMap } from "./common.js";
2
+ export declare const protobufPackage = "channel.app.sdk.v1";
3
+ export interface ExtensionEmptyInput {
4
+ }
5
+ export interface ExtensionChat {
6
+ type?: string | undefined;
7
+ id?: string | undefined;
8
+ }
9
+ export interface ExtensionActionResult {
10
+ type?: string | undefined;
11
+ attributes?: {
12
+ [key: string]: any;
13
+ } | undefined;
14
+ }
15
+ export interface ApiKeyField {
16
+ name?: string | undefined;
17
+ displayName?: string | undefined;
18
+ description?: string | undefined;
19
+ required?: boolean | undefined;
20
+ sensitive?: boolean | undefined;
21
+ maskType?: string | undefined;
22
+ placeholder?: string | undefined;
23
+ validationRegex?: string | undefined;
24
+ }
25
+ export interface ApiKeyGetAuthConfigInput {
26
+ }
27
+ export interface ApiKeyGetAuthConfigOutput {
28
+ authType?: string | undefined;
29
+ authScope?: string | undefined;
30
+ fields?: ApiKeyField[] | undefined;
31
+ providerName?: string | undefined;
32
+ }
33
+ export interface ApiKeyValidateCredentialsInput {
34
+ }
35
+ export interface ApiKeyUserInfo {
36
+ email?: string | undefined;
37
+ name?: string | undefined;
38
+ user_id?: string | undefined;
39
+ }
40
+ export interface ApiKeyValidateCredentialsOutput {
41
+ valid?: boolean | undefined;
42
+ error_message?: string | undefined;
43
+ user_info?: ApiKeyUserInfo | undefined;
44
+ }
45
+ export interface ConfigCondition {
46
+ fieldKey?: string | undefined;
47
+ operator?: string | undefined;
48
+ value?: any | undefined;
49
+ }
50
+ export interface ConfigChoice {
51
+ label?: string | undefined;
52
+ value?: any | undefined;
53
+ description?: string | undefined;
54
+ imageUrl?: string | undefined;
55
+ }
56
+ export interface ConfigInlineLink {
57
+ key?: string | undefined;
58
+ label?: string | undefined;
59
+ url?: string | undefined;
60
+ }
61
+ export interface ConfigValidationNotice {
62
+ tone?: string | undefined;
63
+ title?: string | undefined;
64
+ message?: string | undefined;
65
+ placement?: string | undefined;
66
+ blockId?: string | undefined;
67
+ }
68
+ export interface ConfigHooks {
69
+ draftResolverFunctionName?: string | undefined;
70
+ validateFunctionName?: string | undefined;
71
+ }
72
+ export interface ConfigOAuthAdditionalParam {
73
+ name?: string | undefined;
74
+ fieldKey?: string | undefined;
75
+ }
76
+ export interface ConfigOAuth {
77
+ additionalParams?: ConfigOAuthAdditionalParam[] | undefined;
78
+ }
79
+ export interface ConfigChoicesSource {
80
+ type?: string | undefined;
81
+ functionName?: string | undefined;
82
+ params?: {
83
+ [key: string]: any;
84
+ } | undefined;
85
+ triggerOnLoad?: boolean | undefined;
86
+ triggerFieldKeys?: string[] | undefined;
87
+ appId?: string | undefined;
88
+ }
89
+ export interface ConfigDraftResolutionParams {
90
+ scope?: string | undefined;
91
+ channelId?: string | undefined;
92
+ managerId?: string | undefined;
93
+ changedFieldKey?: string | undefined;
94
+ changedValue?: any | undefined;
95
+ values?: {
96
+ [key: string]: any;
97
+ } | undefined;
98
+ }
99
+ export interface ConfigMediaOptions {
100
+ visibility?: string | undefined;
101
+ }
102
+ export interface ConfigResolvedValueTarget {
103
+ key?: string | undefined;
104
+ storageClass?: string | undefined;
105
+ sensitive?: boolean | undefined;
106
+ maskType?: string | undefined;
107
+ }
108
+ export interface ConfigPhoneFieldLabels {
109
+ countryCode?: string | undefined;
110
+ number?: string | undefined;
111
+ }
112
+ export interface ConfigAddressFieldLabels {
113
+ recipient?: string | undefined;
114
+ countryCode?: string | undefined;
115
+ phone?: string | undefined;
116
+ postcode?: string | undefined;
117
+ address1?: string | undefined;
118
+ address2?: string | undefined;
119
+ }
120
+ export interface ConfigField {
121
+ type?: string | undefined;
122
+ key?: string | undefined;
123
+ label?: string | undefined;
124
+ description?: string | undefined;
125
+ helperText?: string | undefined;
126
+ helperLinks?: ConfigInlineLink[] | undefined;
127
+ required?: boolean | undefined;
128
+ placeholder?: string | undefined;
129
+ validationRegex?: string | undefined;
130
+ storageClass?: string | undefined;
131
+ media?: ConfigMediaOptions | undefined;
132
+ resolvesTo?: ConfigResolvedValueTarget | undefined;
133
+ visibleWhen?: ConfigCondition[] | undefined;
134
+ enabledWhen?: ConfigCondition[] | undefined;
135
+ defaultValue?: any | undefined;
136
+ choicesSource?: ConfigChoicesSource | undefined;
137
+ rows?: number | undefined;
138
+ maskType?: string | undefined;
139
+ min?: number | undefined;
140
+ max?: number | undefined;
141
+ step?: number | undefined;
142
+ choices?: ConfigChoice[] | undefined;
143
+ minSelections?: number | undefined;
144
+ maxSelections?: number | undefined;
145
+ format?: string | undefined;
146
+ countryCodeChoices?: ConfigChoice[] | undefined;
147
+ phoneFieldLabels?: ConfigPhoneFieldLabels | undefined;
148
+ addressFieldLabels?: ConfigAddressFieldLabels | undefined;
149
+ countryCodePlaceholder?: string | undefined;
150
+ numberPlaceholder?: string | undefined;
151
+ searchEnabled?: boolean | undefined;
152
+ postcodeLookupUrl?: string | undefined;
153
+ recipientPlaceholder?: string | undefined;
154
+ phonePlaceholder?: string | undefined;
155
+ postcodePlaceholder?: string | undefined;
156
+ address1Placeholder?: string | undefined;
157
+ address2Placeholder?: string | undefined;
158
+ accept?: string[] | undefined;
159
+ maxFileSizeMb?: number | undefined;
160
+ multiple?: boolean | undefined;
161
+ }
162
+ export interface ConfigBlock {
163
+ type?: string | undefined;
164
+ id?: string | undefined;
165
+ title?: string | undefined;
166
+ description?: string | undefined;
167
+ visibleWhen?: ConfigCondition[] | undefined;
168
+ text?: string | undefined;
169
+ helperLinks?: ConfigInlineLink[] | undefined;
170
+ tone?: string | undefined;
171
+ layout?: string | undefined;
172
+ fields?: ConfigField[] | undefined;
173
+ renderer?: string | undefined;
174
+ props?: {
175
+ [key: string]: any;
176
+ } | undefined;
177
+ field?: ConfigField | undefined;
178
+ }
179
+ export interface ConfigGetConfigSchemaInput {
180
+ }
181
+ export interface ConfigGetConfigSchemaOutput {
182
+ schemaVersion?: string | undefined;
183
+ configScope?: string | undefined;
184
+ providerName?: string | undefined;
185
+ title?: string | undefined;
186
+ description?: string | undefined;
187
+ legacyCredentialFallback?: string | undefined;
188
+ oauth?: ConfigOAuth | undefined;
189
+ hooks?: ConfigHooks | undefined;
190
+ blocks?: ConfigBlock[] | undefined;
191
+ }
192
+ export interface ConfigValidationError {
193
+ fieldKey?: string | undefined;
194
+ reasonCode?: string | undefined;
195
+ message?: string | undefined;
196
+ }
197
+ export interface ConfigValidateStoredConfigInput {
198
+ }
199
+ export interface ConfigValidateStoredConfigOutput {
200
+ valid?: boolean | undefined;
201
+ reasonCode?: string | undefined;
202
+ message?: string | undefined;
203
+ missingFields?: string[] | undefined;
204
+ errors?: ConfigValidationError[] | undefined;
205
+ notices?: ConfigValidationNotice[] | undefined;
206
+ }
207
+ export interface ConfigChoiceList {
208
+ choices?: ConfigChoice[] | undefined;
209
+ }
210
+ export interface ConfigDraftResolutionOutput {
211
+ valuesPatch?: {
212
+ [key: string]: any;
213
+ } | undefined;
214
+ choicesPatch?: {
215
+ [key: string]: ConfigChoiceList;
216
+ } | undefined;
217
+ }
218
+ export interface ConfigDraftResolutionOutput_ChoicesPatchEntry {
219
+ key: string;
220
+ value?: ConfigChoiceList | undefined;
221
+ }
222
+ export interface OAuthProvider {
223
+ provider?: string | undefined;
224
+ authorizationUrl?: string | undefined;
225
+ tokenUrl?: string | undefined;
226
+ refreshTokenUrl?: string | undefined;
227
+ scopes?: string[] | undefined;
228
+ providerName?: string | undefined;
229
+ providerDescription?: string | undefined;
230
+ providerIconUrl?: string | undefined;
231
+ pkceRequired?: boolean | undefined;
232
+ additionalParams?: {
233
+ [key: string]: string;
234
+ } | undefined;
235
+ parameterCase?: string | undefined;
236
+ tokenRequestContentType?: string | undefined;
237
+ }
238
+ export interface OAuthProvider_AdditionalParamsEntry {
239
+ key: string;
240
+ value: string;
241
+ }
242
+ export interface OAuthGetAuthConfigInput {
243
+ }
244
+ export interface OAuthConfig {
245
+ authType?: string | undefined;
246
+ authScope?: string | undefined;
247
+ oauthProvider?: OAuthProvider | undefined;
248
+ }
249
+ export interface OAuthCredentialValidationInput {
250
+ accessToken?: string | undefined;
251
+ }
252
+ export interface OAuthCredentialValidationResult {
253
+ valid?: boolean | undefined;
254
+ expiresAt?: string | undefined;
255
+ error?: string | undefined;
256
+ }
257
+ export interface Calendar {
258
+ id?: string | undefined;
259
+ name?: string | undefined;
260
+ description?: string | undefined;
261
+ timezone?: string | undefined;
262
+ isPrimary?: boolean | undefined;
263
+ }
264
+ export interface CalendarEventType {
265
+ id?: string | undefined;
266
+ name?: string | undefined;
267
+ duration?: number | undefined;
268
+ description?: string | undefined;
269
+ color?: string | undefined;
270
+ }
271
+ export interface CalendarTimeSlot {
272
+ startTime?: string | undefined;
273
+ endTime?: string | undefined;
274
+ }
275
+ export interface CalendarAttendee {
276
+ name?: string | undefined;
277
+ email?: string | undefined;
278
+ phone?: string | undefined;
279
+ }
280
+ export interface CalendarBooking {
281
+ id?: string | undefined;
282
+ eventTypeId?: string | undefined;
283
+ startTime?: string | undefined;
284
+ endTime?: string | undefined;
285
+ attendee?: CalendarAttendee | undefined;
286
+ status?: string | undefined;
287
+ notes?: string | undefined;
288
+ meetingUrl?: string | undefined;
289
+ calendarEventId?: string | undefined;
290
+ }
291
+ export interface CalendarListCalendarsInput {
292
+ pageToken?: string | undefined;
293
+ }
294
+ export interface CalendarListCalendarsOutput {
295
+ calendars?: Calendar[] | undefined;
296
+ nextPageToken?: string | undefined;
297
+ }
298
+ export interface CalendarListEventTypesInput {
299
+ calendarId?: string | undefined;
300
+ }
301
+ export interface CalendarListEventTypesOutput {
302
+ eventTypes?: CalendarEventType[] | undefined;
303
+ }
304
+ export interface CalendarGetAvailabilityInput {
305
+ eventTypeId?: string | undefined;
306
+ startDate?: string | undefined;
307
+ endDate?: string | undefined;
308
+ timezone?: string | undefined;
309
+ }
310
+ export interface CalendarGetAvailabilityOutput {
311
+ slots?: CalendarTimeSlot[] | undefined;
312
+ }
313
+ export interface CalendarCreateBookingInput {
314
+ eventTypeId?: string | undefined;
315
+ startTime?: string | undefined;
316
+ attendee?: CalendarAttendee | undefined;
317
+ notes?: string | undefined;
318
+ timezone?: string | undefined;
319
+ }
320
+ export interface CalendarCancelBookingInput {
321
+ bookingId?: string | undefined;
322
+ reason?: string | undefined;
323
+ }
324
+ export interface CalendarCancelBookingOutput {
325
+ success?: boolean | undefined;
326
+ booking?: CalendarBooking | undefined;
327
+ }
328
+ export interface CalendarGetBookingInput {
329
+ bookingId?: string | undefined;
330
+ }
331
+ export interface CommandNameI18n {
332
+ name?: string | undefined;
333
+ }
334
+ export interface CommandNameDescI18n {
335
+ name?: string | undefined;
336
+ description?: string | undefined;
337
+ }
338
+ export interface CommandParamDefI18n {
339
+ name?: string | undefined;
340
+ description?: string | undefined;
341
+ }
342
+ export interface CommandChoice {
343
+ name?: string | undefined;
344
+ value?: any | undefined;
345
+ nameDescI18nMap?: {
346
+ [key: string]: CommandNameDescI18n;
347
+ } | undefined;
348
+ }
349
+ export interface CommandChoice_NameDescI18nMapEntry {
350
+ key: string;
351
+ value?: CommandNameDescI18n | undefined;
352
+ }
353
+ export interface CommandParamDefinition {
354
+ name?: string | undefined;
355
+ type?: string | undefined;
356
+ required?: boolean | undefined;
357
+ description?: string | undefined;
358
+ choices?: CommandChoice[] | undefined;
359
+ nameDescI18nMap?: {
360
+ [key: string]: CommandParamDefI18n;
361
+ } | undefined;
362
+ autoComplete?: boolean | undefined;
363
+ alfDescription?: string | undefined;
364
+ }
365
+ export interface CommandParamDefinition_NameDescI18nMapEntry {
366
+ key: string;
367
+ value?: CommandParamDefI18n | undefined;
368
+ }
369
+ export interface CommandConfig {
370
+ name?: string | undefined;
371
+ scope?: string | undefined;
372
+ buttonName?: string | undefined;
373
+ buttonNameI18nMap?: {
374
+ [key: string]: CommandNameI18n;
375
+ } | undefined;
376
+ description?: string | undefined;
377
+ nameDescI18nMap?: {
378
+ [key: string]: CommandNameDescI18n;
379
+ } | undefined;
380
+ actionFunctionName?: string | undefined;
381
+ autoCompleteFunctionName?: string | undefined;
382
+ systemVersion?: string | undefined;
383
+ alfMode?: string | undefined;
384
+ alfDescription?: string | undefined;
385
+ paramDefinitions?: CommandParamDefinition[] | undefined;
386
+ enabledByDefault?: boolean | undefined;
387
+ }
388
+ export interface CommandConfig_ButtonNameI18nMapEntry {
389
+ key: string;
390
+ value?: CommandNameI18n | undefined;
391
+ }
392
+ export interface CommandConfig_NameDescI18nMapEntry {
393
+ key: string;
394
+ value?: CommandNameDescI18n | undefined;
395
+ }
396
+ export interface CommandGetCommandsInput {
397
+ }
398
+ export interface CommandGetCommandsOutput {
399
+ commands?: CommandConfig[] | undefined;
400
+ }
401
+ export interface CommandTrigger {
402
+ type?: string | undefined;
403
+ attributes?: {
404
+ [key: string]: string;
405
+ } | undefined;
406
+ }
407
+ export interface CommandTrigger_AttributesEntry {
408
+ key: string;
409
+ value: string;
410
+ }
411
+ export interface CommandAutoCompleteArgument {
412
+ focused?: boolean | undefined;
413
+ name?: string | undefined;
414
+ value?: any | undefined;
415
+ }
416
+ export interface CommandGetSuggestionsInput {
417
+ chat?: ExtensionChat | undefined;
418
+ input?: CommandAutoCompleteArgument[] | undefined;
419
+ language?: string | undefined;
420
+ }
421
+ export interface CommandGetSuggestionsOutput {
422
+ choices?: CommandChoice[] | undefined;
423
+ }
424
+ export interface CommandExecuteInput {
425
+ chat?: ExtensionChat | undefined;
426
+ trigger?: CommandTrigger | undefined;
427
+ input?: {
428
+ [key: string]: any;
429
+ } | undefined;
430
+ language?: string | undefined;
431
+ }
432
+ export interface CommandResult {
433
+ type?: string | undefined;
434
+ attributes?: {
435
+ [key: string]: any;
436
+ } | undefined;
437
+ }
438
+ export interface WidgetNameDescI18n {
439
+ name?: string | undefined;
440
+ description?: string | undefined;
441
+ }
442
+ export interface WidgetConfig {
443
+ name?: string | undefined;
444
+ actionFunctionName?: string | undefined;
445
+ systemVersion?: string | undefined;
446
+ defaultName?: string | undefined;
447
+ defaultDescription?: string | undefined;
448
+ defaultNameDescI18nMap?: {
449
+ [key: string]: WidgetNameDescI18n;
450
+ } | undefined;
451
+ scope?: string | undefined;
452
+ widgetType?: string | undefined;
453
+ }
454
+ export interface WidgetConfig_DefaultNameDescI18nMapEntry {
455
+ key: string;
456
+ value?: WidgetNameDescI18n | undefined;
457
+ }
458
+ export interface WidgetGetWidgetsInput {
459
+ }
460
+ export interface WidgetGetWidgetsOutput {
461
+ widgets?: WidgetConfig[] | undefined;
462
+ }
463
+ export interface WidgetActionInput {
464
+ chat?: ExtensionChat | undefined;
465
+ language?: string | undefined;
466
+ }
467
+ export interface WidgetActionResult {
468
+ type?: string | undefined;
469
+ attributes?: {
470
+ [key: string]: any;
471
+ } | undefined;
472
+ }
473
+ export interface CustomTabNameI18n {
474
+ name?: string | undefined;
475
+ }
476
+ export interface CustomTabConfig {
477
+ name?: string | undefined;
478
+ actionFunctionName?: string | undefined;
479
+ systemVersion?: string | undefined;
480
+ nameI18nMap?: {
481
+ [key: string]: CustomTabNameI18n;
482
+ } | undefined;
483
+ }
484
+ export interface CustomTabConfig_NameI18nMapEntry {
485
+ key: string;
486
+ value?: CustomTabNameI18n | undefined;
487
+ }
488
+ export interface CustomTabGetCustomTabsInput {
489
+ }
490
+ export interface CustomTabGetCustomTabsOutput {
491
+ customTabs?: CustomTabConfig[] | undefined;
492
+ }
493
+ export interface CustomTabActionInput {
494
+ language?: string | undefined;
495
+ wamArgs?: any | undefined;
496
+ }
497
+ export interface CustomTabActionResult {
498
+ type?: string | undefined;
499
+ attributes?: {
500
+ [key: string]: any;
501
+ } | undefined;
502
+ }
503
+ export interface HookConfig {
504
+ type?: string | undefined;
505
+ actionFunctionName?: string | undefined;
506
+ systemVersion?: string | undefined;
507
+ targetId?: string | undefined;
508
+ }
509
+ export interface HookGetHooksInput {
510
+ }
511
+ export interface HookGetHooksOutput {
512
+ hooks?: HookConfig[] | undefined;
513
+ }
514
+ export interface PollingPoller {
515
+ functionName?: string | undefined;
516
+ intervalSeconds?: number | undefined;
517
+ timeoutSeconds?: number | undefined;
518
+ maxConcurrency?: number | undefined;
519
+ rps?: number | undefined;
520
+ }
521
+ export interface PollingGetPollersInput {
522
+ }
523
+ export interface PollingGetPollersOutput {
524
+ pollers?: PollingPoller[] | undefined;
525
+ }
526
+ export interface PollingGetTargetChannelsInput {
527
+ functionName?: string | undefined;
528
+ cursor?: string | undefined;
529
+ limit?: number | undefined;
530
+ }
531
+ export interface PollingGetTargetChannelsOutput {
532
+ channelIds?: string[] | undefined;
533
+ nextCursor?: string | undefined;
534
+ hasNextPage?: boolean | undefined;
535
+ }
536
+ export interface StoreMedia {
537
+ type?: string | undefined;
538
+ url?: string | undefined;
539
+ thumbnailUrl?: string | undefined;
540
+ alt?: string | undefined;
541
+ }
542
+ export interface StoreTargetUser {
543
+ key?: string | undefined;
544
+ label?: string | undefined;
545
+ description?: string | undefined;
546
+ }
547
+ export interface StoreUseCase {
548
+ id?: string | undefined;
549
+ title?: string | undefined;
550
+ description?: string | undefined;
551
+ surfaceKeys?: string[] | undefined;
552
+ requiredAppIds?: string[] | undefined;
553
+ }
554
+ export interface StoreCapability {
555
+ key?: string | undefined;
556
+ label?: string | undefined;
557
+ description?: string | undefined;
558
+ }
559
+ export interface StoreSurface {
560
+ key?: string | undefined;
561
+ label?: string | undefined;
562
+ description?: string | undefined;
563
+ }
564
+ export interface StoreRelationship {
565
+ type?: string | undefined;
566
+ appId?: string | undefined;
567
+ label?: string | undefined;
568
+ description?: string | undefined;
569
+ }
570
+ export interface StoreSetupStep {
571
+ id?: string | undefined;
572
+ title?: string | undefined;
573
+ description?: string | undefined;
574
+ externalUrl?: string | undefined;
575
+ }
576
+ export interface StoreSetupField {
577
+ key?: string | undefined;
578
+ label?: string | undefined;
579
+ description?: string | undefined;
580
+ example?: string | undefined;
581
+ helpUrl?: string | undefined;
582
+ }
583
+ export interface StoreSetupOverview {
584
+ steps?: StoreSetupStep[] | undefined;
585
+ fields?: StoreSetupField[] | undefined;
586
+ estimatedTimeText?: string | undefined;
587
+ }
588
+ export interface StoreGuideSection {
589
+ id?: string | undefined;
590
+ title?: string | undefined;
591
+ blocks?: {
592
+ [key: string]: any;
593
+ }[] | undefined;
594
+ }
595
+ export interface StoreFaq {
596
+ question?: string | undefined;
597
+ answer?: string | undefined;
598
+ }
599
+ export interface StoreCaseStudy {
600
+ title?: string | undefined;
601
+ summary?: string | undefined;
602
+ url?: string | undefined;
603
+ metrics?: string[] | undefined;
604
+ }
605
+ export interface StoreProfileI18n {
606
+ headline?: string | undefined;
607
+ summary?: string | undefined;
608
+ targetUsers?: StoreTargetUser[] | undefined;
609
+ primaryUseCases?: StoreUseCase[] | undefined;
610
+ guideSections?: StoreGuideSection[] | undefined;
611
+ faqs?: StoreFaq[] | undefined;
612
+ caseStudy?: StoreCaseStudy | undefined;
613
+ pricingNote?: string | undefined;
614
+ }
615
+ export interface StoreProfile {
616
+ providerName?: string | undefined;
617
+ categories?: string[] | undefined;
618
+ headline?: string | undefined;
619
+ summary?: string | undefined;
620
+ primaryScreenshotUrl?: string | undefined;
621
+ targetUsers?: StoreTargetUser[] | undefined;
622
+ primaryUseCases?: StoreUseCase[] | undefined;
623
+ media?: StoreMedia[] | undefined;
624
+ capabilities?: StoreCapability[] | undefined;
625
+ surfaces?: StoreSurface[] | undefined;
626
+ relationships?: StoreRelationship[] | undefined;
627
+ setupOverview?: StoreSetupOverview | undefined;
628
+ guideSections?: StoreGuideSection[] | undefined;
629
+ faqs?: StoreFaq[] | undefined;
630
+ externalGuideUrl?: string | undefined;
631
+ caseStudy?: StoreCaseStudy | undefined;
632
+ pricingNote?: string | undefined;
633
+ i18nMap?: {
634
+ [key: string]: StoreProfileI18n;
635
+ } | undefined;
636
+ }
637
+ export interface StoreProfile_I18nMapEntry {
638
+ key: string;
639
+ value?: StoreProfileI18n | undefined;
640
+ }
641
+ export interface StoreGetProfileInput {
642
+ }
643
+ export interface StoreGetProfileOutput {
644
+ profile?: StoreProfile | undefined;
645
+ }
646
+ export interface DataSourceCatalog {
647
+ alias?: string | undefined;
648
+ displayName?: string | undefined;
649
+ dialect?: string | undefined;
650
+ active?: boolean | undefined;
651
+ }
652
+ export interface DataSourceTable {
653
+ name?: string | undefined;
654
+ localCatalogAlias?: string | undefined;
655
+ description?: string | undefined;
656
+ estimatedRowCount?: number | undefined;
657
+ updatedAt?: number | undefined;
658
+ tableType?: string | undefined;
659
+ }
660
+ export interface DataSourceColumn {
661
+ name?: string | undefined;
662
+ type?: string | undefined;
663
+ nullable?: boolean | undefined;
664
+ description?: string | undefined;
665
+ partitionKey?: boolean | undefined;
666
+ precision?: number | undefined;
667
+ scale?: number | undefined;
668
+ }
669
+ export interface DataSourceTableDefinition {
670
+ table?: DataSourceTable | undefined;
671
+ columns?: DataSourceColumn[] | undefined;
672
+ primaryKey?: string[] | undefined;
673
+ }
674
+ export interface DataSourceTableListing {
675
+ table?: DataSourceTable | undefined;
676
+ searchText?: string | undefined;
677
+ tags?: string[] | undefined;
678
+ }
679
+ export interface DataSourceListCatalogsInput {
680
+ }
681
+ export interface DataSourceListCatalogsOutput {
682
+ catalogs?: DataSourceCatalog[] | undefined;
683
+ }
684
+ export interface DataSourceListTablesInput {
685
+ localCatalogAlias?: string | undefined;
686
+ updatedAfter?: string | undefined;
687
+ limit?: number | undefined;
688
+ pageToken?: string | undefined;
689
+ }
690
+ export interface DataSourceListTablesOutput {
691
+ tables?: DataSourceTableListing[] | undefined;
692
+ nextPageToken?: string | undefined;
693
+ metadataVersion?: string | undefined;
694
+ }
695
+ export interface DataSourceDescribeTableInput {
696
+ localCatalogAlias?: string | undefined;
697
+ tableName?: string | undefined;
698
+ includeSample?: boolean | undefined;
699
+ }
700
+ export interface DataSourceDescribeTableOutput {
701
+ definition?: DataSourceTableDefinition | undefined;
702
+ sample?: {
703
+ [key: string]: any;
704
+ }[] | undefined;
705
+ metadataVersion?: string | undefined;
706
+ }
707
+ export interface OrderAddress {
708
+ name?: string | undefined;
709
+ phoneNumber?: string | undefined;
710
+ email?: string | undefined;
711
+ cellPhoneNumber?: string | undefined;
712
+ zipcode?: string | undefined;
713
+ address1?: string | undefined;
714
+ address2?: string | undefined;
715
+ shippingMessage?: string | undefined;
716
+ country?: string | undefined;
717
+ city?: string | undefined;
718
+ province?: string | undefined;
719
+ }
720
+ export interface OrderBankAccount {
721
+ bankName?: string | undefined;
722
+ accountNo?: string | undefined;
723
+ accountHolder?: string | undefined;
724
+ }
725
+ export interface OrderDefectInfo {
726
+ description?: string | undefined;
727
+ imageUrls?: string[] | undefined;
728
+ }
729
+ export interface OrderClaimReason {
730
+ type?: string | undefined;
731
+ description?: string | undefined;
732
+ }
733
+ export interface OrderClaimability {
734
+ cancelable?: boolean | undefined;
735
+ returnable?: boolean | undefined;
736
+ exchangeable?: boolean | undefined;
737
+ shippingAddressChangeable?: boolean | undefined;
738
+ }
739
+ export interface OrderClaim {
740
+ id?: string | undefined;
741
+ extClaimId?: string | undefined;
742
+ type?: string | undefined;
743
+ state?: string | undefined;
744
+ itemIds?: string[] | undefined;
745
+ createdAt?: number | undefined;
746
+ }
747
+ export interface OrderItem {
748
+ id?: string | undefined;
749
+ name?: string | undefined;
750
+ imageUrl?: string | undefined;
751
+ amount?: number | undefined;
752
+ quantity?: number | undefined;
753
+ option?: string | undefined;
754
+ productId?: string | undefined;
755
+ variantId?: string | undefined;
756
+ state?: string | undefined;
757
+ shippedAt?: number | undefined;
758
+ deliveredAt?: number | undefined;
759
+ estimatedShipDate?: number | undefined;
760
+ claimability?: OrderClaimability | undefined;
761
+ }
762
+ export interface OrderPayment {
763
+ state?: string | undefined;
764
+ currency?: string | undefined;
765
+ totalAmount?: number | undefined;
766
+ itemsAmount?: number | undefined;
767
+ shippingAmount?: number | undefined;
768
+ discountAmount?: number | undefined;
769
+ methods?: string[] | undefined;
770
+ requireRefundBankAccount?: boolean | undefined;
771
+ }
772
+ export interface OrderFulfillment {
773
+ id?: string | undefined;
774
+ state?: string | undefined;
775
+ itemIds?: string[] | undefined;
776
+ trackingNumber?: string | undefined;
777
+ trackingCompany?: string | undefined;
778
+ trackingUrl?: string | undefined;
779
+ estimatedDeliveryDate?: number | undefined;
780
+ }
781
+ export interface Order {
782
+ id?: string | undefined;
783
+ title?: string | undefined;
784
+ createdAt?: number | undefined;
785
+ items?: OrderItem[] | undefined;
786
+ payment?: OrderPayment | undefined;
787
+ fulfillments?: OrderFulfillment[] | undefined;
788
+ shippingAddress?: OrderAddress | undefined;
789
+ claims?: OrderClaim[] | undefined;
790
+ }
791
+ export interface OrderAllowedValue {
792
+ value?: string | undefined;
793
+ label?: string | undefined;
794
+ }
795
+ export interface OrderFieldConfig {
796
+ type?: string | undefined;
797
+ allowedValues?: OrderAllowedValue[] | undefined;
798
+ description?: string | undefined;
799
+ }
800
+ export interface OrderOperationOptions {
801
+ required?: string[] | undefined;
802
+ optional?: string[] | undefined;
803
+ fieldConfigs?: {
804
+ [key: string]: OrderFieldConfig;
805
+ } | undefined;
806
+ }
807
+ export interface OrderOperationOptions_FieldConfigsEntry {
808
+ key: string;
809
+ value?: OrderFieldConfig | undefined;
810
+ }
811
+ export interface OrderAppCapabilities {
812
+ getOrdersOptions?: OrderOperationOptions | undefined;
813
+ cancelOrderOptions?: OrderOperationOptions | undefined;
814
+ returnOrderOptions?: OrderOperationOptions | undefined;
815
+ exchangeOrderOptions?: OrderOperationOptions | undefined;
816
+ changeAddressOptions?: OrderOperationOptions | undefined;
817
+ }
818
+ export interface OrderGetOrdersInput {
819
+ identifierType?: string | undefined;
820
+ identifierValue?: string | undefined;
821
+ }
822
+ export interface OrderGetOrdersOutput {
823
+ orders?: Order[] | undefined;
824
+ }
825
+ export interface OrderGetAppConfigsInput {
826
+ }
827
+ export interface OrderGetAppConfigsOutput {
828
+ appCapabilities?: OrderAppCapabilities | undefined;
829
+ }
830
+ export interface OrderClaimItem {
831
+ id?: string | undefined;
832
+ quantity?: number | undefined;
833
+ }
834
+ export interface OrderCancelOrderInput {
835
+ orderId?: string | undefined;
836
+ cancelItems?: OrderClaimItem[] | undefined;
837
+ reason?: OrderClaimReason | undefined;
838
+ refundBankAccount?: OrderBankAccount | undefined;
839
+ }
840
+ export interface OrderReturnOrderInput {
841
+ orderId?: string | undefined;
842
+ returnItems?: OrderClaimItem[] | undefined;
843
+ reason?: OrderClaimReason | undefined;
844
+ requestPickup?: boolean | undefined;
845
+ pickupAddress?: OrderAddress | undefined;
846
+ refundBankAccount?: OrderBankAccount | undefined;
847
+ trackingNumber?: string | undefined;
848
+ trackingCompany?: string | undefined;
849
+ defectInfo?: OrderDefectInfo | undefined;
850
+ shippingFeePaymentType?: string | undefined;
851
+ }
852
+ export interface OrderExchangeItem {
853
+ productId?: string | undefined;
854
+ variantId?: string | undefined;
855
+ quantity?: number | undefined;
856
+ }
857
+ export interface OrderExchangeOrderInput {
858
+ orderId?: string | undefined;
859
+ beforeExchangeItems?: OrderClaimItem[] | undefined;
860
+ afterExchangeItems?: OrderExchangeItem[] | undefined;
861
+ reason?: OrderClaimReason | undefined;
862
+ requestPickup?: boolean | undefined;
863
+ pickupAddress?: OrderAddress | undefined;
864
+ refundBankAccount?: OrderBankAccount | undefined;
865
+ defectInfo?: OrderDefectInfo | undefined;
866
+ shippingFeePaymentType?: string | undefined;
867
+ }
868
+ export interface OrderGetExchangeableItemsInput {
869
+ orderId?: string | undefined;
870
+ items?: OrderClaimItem[] | undefined;
871
+ }
872
+ export interface OrderGetExchangeableItemsOutput {
873
+ items?: OrderItem[] | undefined;
874
+ }
875
+ export interface OrderChangeShippingAddressInput {
876
+ orderId?: string | undefined;
877
+ newAddress?: OrderAddress | undefined;
878
+ }
879
+ export interface OrderSuccessOutput {
880
+ success?: boolean | undefined;
881
+ }
882
+ export interface WmsShippingInfo {
883
+ name?: string | undefined;
884
+ firstName?: string | undefined;
885
+ lastName?: string | undefined;
886
+ mobileNumber?: string | undefined;
887
+ landlineNumber?: string | undefined;
888
+ zipcode?: string | undefined;
889
+ address1?: string | undefined;
890
+ address2?: string | undefined;
891
+ country?: string | undefined;
892
+ province?: string | undefined;
893
+ message?: string | undefined;
894
+ }
895
+ export interface WmsDelivery {
896
+ extId?: string | undefined;
897
+ itemIds?: string[] | undefined;
898
+ }
899
+ export interface WmsOrderItem {
900
+ extId?: string | undefined;
901
+ extCommerceOrderItemId?: string | undefined;
902
+ productName?: string | undefined;
903
+ quantity?: number | undefined;
904
+ state?: string | undefined;
905
+ packageId?: string | undefined;
906
+ estimatedShipDate?: string | undefined;
907
+ invoiceNumber?: string | undefined;
908
+ deliveryCompany?: string | undefined;
909
+ shippingInfo?: WmsShippingInfo | undefined;
910
+ }
911
+ export interface WmsOrder {
912
+ extId?: string | undefined;
913
+ extCommerceOrderId?: string | undefined;
914
+ items?: WmsOrderItem[] | undefined;
915
+ deliveries?: WmsDelivery[] | undefined;
916
+ }
917
+ export interface WmsGetOrdersRequest {
918
+ commerceOrderIds?: string | undefined;
919
+ orderIds?: string | undefined;
920
+ packageIds?: string | undefined;
921
+ shopId?: string | undefined;
922
+ }
923
+ export interface WmsGetOrdersResult {
924
+ orders?: WmsOrder[] | undefined;
925
+ }
926
+ export interface WmsGetOrderRequest {
927
+ commerceOrderId?: string | undefined;
928
+ orderId?: string | undefined;
929
+ packageId?: string | undefined;
930
+ shopId?: string | undefined;
931
+ }
932
+ export interface WmsGetOrderResult {
933
+ order?: WmsOrder | undefined;
934
+ }
935
+ export interface WmsGetShopIDRequest {
936
+ commerceType?: string | undefined;
937
+ commerceKey?: string | undefined;
938
+ }
939
+ export interface WmsGetShopIDResult {
940
+ shopId?: string | undefined;
941
+ message?: string | undefined;
942
+ }
943
+ export interface WmsGetSupportedCommercesRequest {
944
+ }
945
+ export interface WmsGetSupportedCommercesResult {
946
+ commerceTypes?: string[] | undefined;
947
+ }
948
+ export interface WmsOrderStateRequest {
949
+ orderId?: string | undefined;
950
+ orderIds?: string | undefined;
951
+ reason?: string | undefined;
952
+ memo?: string | undefined;
953
+ }
954
+ export interface WmsChangeShippingAddressRequest {
955
+ orderId?: string | undefined;
956
+ recipient?: string | undefined;
957
+ phone?: string | undefined;
958
+ address1?: string | undefined;
959
+ postalCode?: string | undefined;
960
+ address2?: string | undefined;
961
+ message?: string | undefined;
962
+ }
963
+ export interface WmsRestoreOrderRequest {
964
+ orderId?: string | undefined;
965
+ memo?: string | undefined;
966
+ prdSeq?: string | undefined;
967
+ restorePack?: boolean | undefined;
968
+ restockNormal?: boolean | undefined;
969
+ restockBad?: boolean | undefined;
970
+ }
971
+ export interface WmsSuccessResult {
972
+ success?: boolean | undefined;
973
+ message?: string | undefined;
974
+ }
975
+ export interface MessagingOnMediumMessageCreatedInput {
976
+ userChat?: ChannelUserChat | undefined;
977
+ message?: ChannelMessage | undefined;
978
+ }
979
+ export interface MessagingSendResult {
980
+ sendState?: string | undefined;
981
+ message?: string | undefined;
982
+ }
983
+ export interface MessagingOnMediumMessageCreatedOutput {
984
+ sendResult?: MessagingSendResult | undefined;
985
+ }
986
+ export interface MessagingInboxOnMediumUserChatClosedInput {
987
+ userChat?: ChannelUserChat | undefined;
988
+ }
989
+ export interface MessagingInboxOnMediumUserChatClosedOutput {
990
+ }
991
+ export interface MessagingInboxGetWritingTypesInput {
992
+ userChat?: ChannelUserChat | undefined;
993
+ }
994
+ export interface MessagingInboxGetWritingTypesOutput {
995
+ writingTypeMap?: WritingTypeMap | undefined;
996
+ }
997
+ export interface MessagingInboxGetCustomEditorWamInput {
998
+ user?: ChannelUser | undefined;
999
+ userChat?: ChannelUserChat | undefined;
1000
+ entityType?: string | undefined;
1001
+ mediumTopicKey?: string | undefined;
1002
+ mediumTopicLabels?: string[] | undefined;
1003
+ message?: ChannelMessage | undefined;
1004
+ }
1005
+ export interface MessagingInboxGetMediumTopicSelectorWamInput {
1006
+ user?: ChannelUser | undefined;
1007
+ }
1008
+ export interface MessagingInboxGetMediumMessageErrorReasonInput {
1009
+ userChat?: ChannelUserChat | undefined;
1010
+ message?: ChannelMessage | undefined;
1011
+ }
1012
+ export interface MessagingInboxGetMediumMessageErrorReasonOutput {
1013
+ errorMessage?: string | undefined;
1014
+ }
1015
+ export interface MessagingPrebuiltGetWritingTypesInput {
1016
+ }
1017
+ export interface MessagingPrebuiltGetWritingTypesOutput {
1018
+ writingTypeMap?: WritingTypeMap | undefined;
1019
+ }
1020
+ export interface MessagingPrebuiltValidateEntityInput {
1021
+ message?: PrebuiltMessage | undefined;
1022
+ entityType?: string | undefined;
1023
+ entityId?: string | undefined;
1024
+ mediumTopicBuildKey?: string | undefined;
1025
+ mediumTopicBuildLabels?: string[] | undefined;
1026
+ }
1027
+ export interface MessagingPrebuiltValidateEntityOutput {
1028
+ entityType?: string | undefined;
1029
+ entityId?: string | undefined;
1030
+ reasons?: UnavailableReason[] | undefined;
1031
+ }
1032
+ export interface MessagingPrebuiltGetCustomEditorWamInput {
1033
+ entityType?: string | undefined;
1034
+ entityId?: string | undefined;
1035
+ mediumTopicBuildKey?: string | undefined;
1036
+ mediumTopicBuildLabels?: string[] | undefined;
1037
+ message?: PrebuiltMessage | undefined;
1038
+ triggerEventName?: string | undefined;
1039
+ triggerEventNameI18nMap?: {
1040
+ [key: string]: any;
1041
+ } | undefined;
1042
+ }
1043
+ export interface MessagingPrebuiltGetMediumTopicBuilderSelectorWamInput {
1044
+ entityType?: string | undefined;
1045
+ }
1046
+ export interface MessagingPrebuiltBuildMediumTopicsInput {
1047
+ user?: ChannelUser | undefined;
1048
+ entityType?: string | undefined;
1049
+ mediumTopicBuilderKey?: string | undefined;
1050
+ }
1051
+ export interface MessagingPrebuiltBuildMediumTopicsOutput {
1052
+ mediumTopicKey?: string | undefined;
1053
+ mediumTopicLabels?: string[] | undefined;
1054
+ mediumProfile?: MediumProfile | undefined;
1055
+ }
1056
+ export interface MessagingPrebuiltGetDefaultOptionsInput {
1057
+ }
1058
+ export interface MessagingDefaultOptions {
1059
+ "campaign.userQuery"?: {
1060
+ [key: string]: any;
1061
+ } | undefined;
1062
+ "oneTimeMsg.userQuery"?: {
1063
+ [key: string]: any;
1064
+ } | undefined;
1065
+ "campaign.selectableAdvertising"?: boolean | undefined;
1066
+ "oneTimeMsg.selectableAdvertising"?: boolean | undefined;
1067
+ }
1068
+ export interface MessagingPrebuiltGetDefaultOptionsOutput {
1069
+ defaultOptions?: MessagingDefaultOptions | undefined;
1070
+ }
1071
+ export interface AlfTaskMemoryDefinition {
1072
+ name?: string | undefined;
1073
+ type?: string | undefined;
1074
+ description?: string | undefined;
1075
+ }
1076
+ export interface AlfTaskWorkflowNode {
1077
+ id?: string | undefined;
1078
+ type?: string | undefined;
1079
+ config?: {
1080
+ [key: string]: any;
1081
+ } | undefined;
1082
+ next?: string | undefined;
1083
+ }
1084
+ export interface AlfTaskPredefinedTask {
1085
+ version?: string | undefined;
1086
+ name?: string | undefined;
1087
+ trigger?: string | undefined;
1088
+ memorySchema?: AlfTaskMemoryDefinition[] | undefined;
1089
+ nodes?: AlfTaskWorkflowNode[] | undefined;
1090
+ startNodeId?: string | undefined;
1091
+ }
1092
+ export interface AlfTaskGetTasksInput {
1093
+ version?: string | undefined;
1094
+ }
1095
+ export interface AlfTaskGetTasksOutput {
1096
+ predefinedTasks?: AlfTaskPredefinedTask[] | undefined;
1097
+ }
1098
+ //# sourceMappingURL=extension.d.ts.map