@aws-sdk/client-pinpoint 3.934.0 → 3.936.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 (51) hide show
  1. package/dist-cjs/index.js +188 -188
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +187 -0
  4. package/dist-es/models/errors.js +129 -0
  5. package/dist-es/models/models_0.js +1 -310
  6. package/dist-es/models/models_1.js +1 -6
  7. package/dist-es/schemas/schemas_0.js +1 -1
  8. package/dist-types/commands/GetCampaignVersionCommand.d.ts +1 -1
  9. package/dist-types/commands/GetCampaignVersionsCommand.d.ts +1 -1
  10. package/dist-types/commands/GetChannelsCommand.d.ts +1 -1
  11. package/dist-types/commands/GetEmailChannelCommand.d.ts +1 -1
  12. package/dist-types/commands/GetEmailTemplateCommand.d.ts +1 -1
  13. package/dist-types/commands/GetEndpointCommand.d.ts +1 -1
  14. package/dist-types/commands/GetEventStreamCommand.d.ts +1 -1
  15. package/dist-types/commands/GetExportJobCommand.d.ts +1 -1
  16. package/dist-types/commands/GetExportJobsCommand.d.ts +1 -1
  17. package/dist-types/commands/GetGcmChannelCommand.d.ts +1 -1
  18. package/dist-types/commands/GetImportJobCommand.d.ts +1 -1
  19. package/dist-types/commands/GetImportJobsCommand.d.ts +1 -1
  20. package/dist-types/commands/GetInAppMessagesCommand.d.ts +1 -1
  21. package/dist-types/commands/GetInAppTemplateCommand.d.ts +1 -1
  22. package/dist-types/commands/GetJourneyCommand.d.ts +2 -1
  23. package/dist-types/index.d.ts +4 -1
  24. package/dist-types/models/enums.d.ts +411 -0
  25. package/dist-types/models/errors.d.ts +178 -0
  26. package/dist-types/models/models_0.d.ts +547 -575
  27. package/dist-types/models/models_1.d.ts +2 -561
  28. package/dist-types/ts3.4/commands/GetCampaignVersionCommand.d.ts +1 -1
  29. package/dist-types/ts3.4/commands/GetCampaignVersionsCommand.d.ts +1 -1
  30. package/dist-types/ts3.4/commands/GetChannelsCommand.d.ts +1 -1
  31. package/dist-types/ts3.4/commands/GetEmailChannelCommand.d.ts +1 -1
  32. package/dist-types/ts3.4/commands/GetEmailTemplateCommand.d.ts +1 -1
  33. package/dist-types/ts3.4/commands/GetEndpointCommand.d.ts +1 -1
  34. package/dist-types/ts3.4/commands/GetEventStreamCommand.d.ts +1 -1
  35. package/dist-types/ts3.4/commands/GetExportJobCommand.d.ts +1 -1
  36. package/dist-types/ts3.4/commands/GetExportJobsCommand.d.ts +1 -1
  37. package/dist-types/ts3.4/commands/GetGcmChannelCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/GetImportJobsCommand.d.ts +1 -1
  40. package/dist-types/ts3.4/commands/GetInAppMessagesCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/GetInAppTemplateCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/GetJourneyCommand.d.ts +2 -1
  43. package/dist-types/ts3.4/index.d.ts +4 -1
  44. package/dist-types/ts3.4/models/enums.d.ts +220 -0
  45. package/dist-types/ts3.4/models/errors.d.ts +68 -0
  46. package/dist-types/ts3.4/models/models_0.d.ts +172 -280
  47. package/dist-types/ts3.4/models/models_1.d.ts +2 -163
  48. package/package.json +19 -19
  49. package/dist-es/models/index.js +0 -2
  50. package/dist-types/models/index.d.ts +0 -2
  51. package/dist-types/ts3.4/models/index.d.ts +0 -2
@@ -1,53 +1,4 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
- import { PinpointServiceException as __BaseException } from "./PinpointServiceException";
3
- /**
4
- * @public
5
- * @enum
6
- */
7
- export declare const __EndpointTypesElement: {
8
- readonly ADM: "ADM";
9
- readonly APNS: "APNS";
10
- readonly APNS_SANDBOX: "APNS_SANDBOX";
11
- readonly APNS_VOIP: "APNS_VOIP";
12
- readonly APNS_VOIP_SANDBOX: "APNS_VOIP_SANDBOX";
13
- readonly BAIDU: "BAIDU";
14
- readonly CUSTOM: "CUSTOM";
15
- readonly EMAIL: "EMAIL";
16
- readonly GCM: "GCM";
17
- readonly IN_APP: "IN_APP";
18
- readonly PUSH: "PUSH";
19
- readonly SMS: "SMS";
20
- readonly VOICE: "VOICE";
21
- };
22
- /**
23
- * @public
24
- */
25
- export type __EndpointTypesElement = (typeof __EndpointTypesElement)[keyof typeof __EndpointTypesElement];
26
- /**
27
- * @public
28
- * @enum
29
- */
30
- export declare const __TimezoneEstimationMethodsElement: {
31
- readonly PHONE_NUMBER: "PHONE_NUMBER";
32
- readonly POSTAL_CODE: "POSTAL_CODE";
33
- };
34
- /**
35
- * @public
36
- */
37
- export type __TimezoneEstimationMethodsElement = (typeof __TimezoneEstimationMethodsElement)[keyof typeof __TimezoneEstimationMethodsElement];
38
- /**
39
- * @public
40
- * @enum
41
- */
42
- export declare const Action: {
43
- readonly DEEP_LINK: "DEEP_LINK";
44
- readonly OPEN_APP: "OPEN_APP";
45
- readonly URL: "URL";
46
- };
47
- /**
48
- * @public
49
- */
50
- export type Action = (typeof Action)[keyof typeof Action];
1
+ import { __EndpointTypesElement, __TimezoneEstimationMethodsElement, Action, Alignment, AttributeType, ButtonAction, CampaignStatus, ChannelType, DayOfWeek, DeliveryStatus, DimensionType, Duration, FilterType, Format, Frequency, Include, JobStatus, Layout, MessageType, Mode, Operator, RecencyType, SegmentType, SourceType, State, TemplateType, Type } from "./enums";
51
2
  /**
52
3
  * <p>Provides information about an activity that was performed by a campaign.</p>
53
4
  * @public
@@ -140,23 +91,6 @@ export interface ActivitiesResponse {
140
91
  */
141
92
  NextToken?: string | undefined;
142
93
  }
143
- /**
144
- * @public
145
- * @enum
146
- */
147
- export declare const AttributeType: {
148
- readonly AFTER: "AFTER";
149
- readonly BEFORE: "BEFORE";
150
- readonly BETWEEN: "BETWEEN";
151
- readonly CONTAINS: "CONTAINS";
152
- readonly EXCLUSIVE: "EXCLUSIVE";
153
- readonly INCLUSIVE: "INCLUSIVE";
154
- readonly ON: "ON";
155
- };
156
- /**
157
- * @public
158
- */
159
- export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
160
94
  /**
161
95
  * <p>Specifies attribute-based criteria for including or excluding endpoints from a segment.</p>
162
96
  * @public
@@ -173,18 +107,6 @@ export interface AttributeDimension {
173
107
  */
174
108
  Values: string[] | undefined;
175
109
  }
176
- /**
177
- * @public
178
- * @enum
179
- */
180
- export declare const DimensionType: {
181
- readonly EXCLUSIVE: "EXCLUSIVE";
182
- readonly INCLUSIVE: "INCLUSIVE";
183
- };
184
- /**
185
- * @public
186
- */
187
- export type DimensionType = (typeof DimensionType)[keyof typeof DimensionType];
188
110
  /**
189
111
  * <p>Specifies the dimension type and values for a segment dimension.</p>
190
112
  * @public
@@ -265,32 +187,6 @@ export interface SegmentCondition {
265
187
  */
266
188
  SegmentId: string | undefined;
267
189
  }
268
- /**
269
- * @public
270
- * @enum
271
- */
272
- export declare const Duration: {
273
- readonly DAY_14: "DAY_14";
274
- readonly DAY_30: "DAY_30";
275
- readonly DAY_7: "DAY_7";
276
- readonly HR_24: "HR_24";
277
- };
278
- /**
279
- * @public
280
- */
281
- export type Duration = (typeof Duration)[keyof typeof Duration];
282
- /**
283
- * @public
284
- * @enum
285
- */
286
- export declare const RecencyType: {
287
- readonly ACTIVE: "ACTIVE";
288
- readonly INACTIVE: "INACTIVE";
289
- };
290
- /**
291
- * @public
292
- */
293
- export type RecencyType = (typeof RecencyType)[keyof typeof RecencyType];
294
190
  /**
295
191
  * <p>Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.</p>
296
192
  * @public
@@ -459,18 +355,6 @@ export interface SimpleCondition {
459
355
  */
460
356
  SegmentDimensions?: SegmentDimensions | undefined;
461
357
  }
462
- /**
463
- * @public
464
- * @enum
465
- */
466
- export declare const Operator: {
467
- readonly ALL: "ALL";
468
- readonly ANY: "ANY";
469
- };
470
- /**
471
- * @public
472
- */
473
- export type Operator = (typeof Operator)[keyof typeof Operator];
474
358
  /**
475
359
  * <p>Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.</p>
476
360
  * @public
@@ -740,18 +624,6 @@ export interface RandomSplitActivity {
740
624
  */
741
625
  Branches?: RandomSplitEntry[] | undefined;
742
626
  }
743
- /**
744
- * @public
745
- * @enum
746
- */
747
- export declare const MessageType: {
748
- readonly PROMOTIONAL: "PROMOTIONAL";
749
- readonly TRANSACTIONAL: "TRANSACTIONAL";
750
- };
751
- /**
752
- * @public
753
- */
754
- export type MessageType = (typeof MessageType)[keyof typeof MessageType];
755
627
  /**
756
628
  * <p>Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.</p>
757
629
  * @public
@@ -886,29 +758,6 @@ export interface Activity {
886
758
  */
887
759
  ContactCenter?: ContactCenterActivity | undefined;
888
760
  }
889
- /**
890
- * @public
891
- * @enum
892
- */
893
- export declare const ChannelType: {
894
- readonly ADM: "ADM";
895
- readonly APNS: "APNS";
896
- readonly APNS_SANDBOX: "APNS_SANDBOX";
897
- readonly APNS_VOIP: "APNS_VOIP";
898
- readonly APNS_VOIP_SANDBOX: "APNS_VOIP_SANDBOX";
899
- readonly BAIDU: "BAIDU";
900
- readonly CUSTOM: "CUSTOM";
901
- readonly EMAIL: "EMAIL";
902
- readonly GCM: "GCM";
903
- readonly IN_APP: "IN_APP";
904
- readonly PUSH: "PUSH";
905
- readonly SMS: "SMS";
906
- readonly VOICE: "VOICE";
907
- };
908
- /**
909
- * @public
910
- */
911
- export type ChannelType = (typeof ChannelType)[keyof typeof ChannelType];
912
761
  /**
913
762
  * <p>Specifies address-based configuration settings for a message that's sent directly to an endpoint.</p>
914
763
  * @public
@@ -1108,19 +957,6 @@ export interface ADMMessage {
1108
957
  */
1109
958
  Url?: string | undefined;
1110
959
  }
1111
- /**
1112
- * @public
1113
- * @enum
1114
- */
1115
- export declare const Alignment: {
1116
- readonly CENTER: "CENTER";
1117
- readonly LEFT: "LEFT";
1118
- readonly RIGHT: "RIGHT";
1119
- };
1120
- /**
1121
- * @public
1122
- */
1123
- export type Alignment = (typeof Alignment)[keyof typeof Alignment];
1124
960
  /**
1125
961
  * <p>Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.</p>
1126
962
  * @public
@@ -1909,18 +1745,6 @@ export interface ApplicationSettingsJourneyLimits {
1909
1745
  */
1910
1746
  TotalCap?: number | undefined;
1911
1747
  }
1912
- /**
1913
- * @public
1914
- * @enum
1915
- */
1916
- export declare const Mode: {
1917
- readonly DELIVERY: "DELIVERY";
1918
- readonly FILTER: "FILTER";
1919
- };
1920
- /**
1921
- * @public
1922
- */
1923
- export type Mode = (typeof Mode)[keyof typeof Mode];
1924
1748
  /**
1925
1749
  * <p>Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.</p>
1926
1750
  * @public
@@ -2062,28 +1886,6 @@ export interface AttributesResource {
2062
1886
  */
2063
1887
  Attributes?: string[] | undefined;
2064
1888
  }
2065
- /**
2066
- * <p>Provides information about an API request or response.</p>
2067
- * @public
2068
- */
2069
- export declare class BadRequestException extends __BaseException {
2070
- readonly name: "BadRequestException";
2071
- readonly $fault: "client";
2072
- /**
2073
- * <p>The message that's returned from the API.</p>
2074
- * @public
2075
- */
2076
- Message?: string | undefined;
2077
- /**
2078
- * <p>The unique identifier for the request or response.</p>
2079
- * @public
2080
- */
2081
- RequestID?: string | undefined;
2082
- /**
2083
- * @internal
2084
- */
2085
- constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
2086
- }
2087
1889
  /**
2088
1890
  * <p>Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.</p>
2089
1891
  * @public
@@ -2242,19 +2044,6 @@ export interface BaiduMessage {
2242
2044
  */
2243
2045
  Url?: string | undefined;
2244
2046
  }
2245
- /**
2246
- * @public
2247
- * @enum
2248
- */
2249
- export declare const ButtonAction: {
2250
- readonly CLOSE: "CLOSE";
2251
- readonly DEEP_LINK: "DEEP_LINK";
2252
- readonly LINK: "LINK";
2253
- };
2254
- /**
2255
- * @public
2256
- */
2257
- export type ButtonAction = (typeof ButtonAction)[keyof typeof ButtonAction];
2258
2047
  /**
2259
2048
  * <p>Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.</p>
2260
2049
  * @public
@@ -2354,18 +2143,6 @@ export interface CampaignEmailMessage {
2354
2143
  */
2355
2144
  Title?: string | undefined;
2356
2145
  }
2357
- /**
2358
- * @public
2359
- * @enum
2360
- */
2361
- export declare const FilterType: {
2362
- readonly ENDPOINT: "ENDPOINT";
2363
- readonly SYSTEM: "SYSTEM";
2364
- };
2365
- /**
2366
- * @public
2367
- */
2368
- export type FilterType = (typeof FilterType)[keyof typeof FilterType];
2369
2146
  /**
2370
2147
  * <p>Specifies the settings for events that cause a campaign to be sent.</p>
2371
2148
  * @public
@@ -2538,22 +2315,6 @@ export interface InAppMessageContent {
2538
2315
  */
2539
2316
  SecondaryBtn?: InAppMessageButton | undefined;
2540
2317
  }
2541
- /**
2542
- * @public
2543
- * @enum
2544
- */
2545
- export declare const Layout: {
2546
- readonly BOTTOM_BANNER: "BOTTOM_BANNER";
2547
- readonly CAROUSEL: "CAROUSEL";
2548
- readonly MIDDLE_BANNER: "MIDDLE_BANNER";
2549
- readonly MOBILE_FEED: "MOBILE_FEED";
2550
- readonly OVERLAYS: "OVERLAYS";
2551
- readonly TOP_BANNER: "TOP_BANNER";
2552
- };
2553
- /**
2554
- * @public
2555
- */
2556
- export type Layout = (typeof Layout)[keyof typeof Layout];
2557
2318
  /**
2558
2319
  * <p>In-app message configuration.</p>
2559
2320
  * @public
@@ -2749,23 +2510,6 @@ export interface MessageConfiguration {
2749
2510
  */
2750
2511
  InAppMessage?: CampaignInAppMessage | undefined;
2751
2512
  }
2752
- /**
2753
- * @public
2754
- * @enum
2755
- */
2756
- export declare const Frequency: {
2757
- readonly DAILY: "DAILY";
2758
- readonly EVENT: "EVENT";
2759
- readonly HOURLY: "HOURLY";
2760
- readonly IN_APP_EVENT: "IN_APP_EVENT";
2761
- readonly MONTHLY: "MONTHLY";
2762
- readonly ONCE: "ONCE";
2763
- readonly WEEKLY: "WEEKLY";
2764
- };
2765
- /**
2766
- * @public
2767
- */
2768
- export type Frequency = (typeof Frequency)[keyof typeof Frequency];
2769
2513
  /**
2770
2514
  * <p>Specifies the schedule settings for a campaign.</p>
2771
2515
  * @public
@@ -2810,23 +2554,6 @@ export interface Schedule {
2810
2554
  */
2811
2555
  Timezone?: string | undefined;
2812
2556
  }
2813
- /**
2814
- * @public
2815
- * @enum
2816
- */
2817
- export declare const CampaignStatus: {
2818
- readonly COMPLETED: "COMPLETED";
2819
- readonly DELETED: "DELETED";
2820
- readonly EXECUTING: "EXECUTING";
2821
- readonly INVALID: "INVALID";
2822
- readonly PAUSED: "PAUSED";
2823
- readonly PENDING_NEXT_RUN: "PENDING_NEXT_RUN";
2824
- readonly SCHEDULED: "SCHEDULED";
2825
- };
2826
- /**
2827
- * @public
2828
- */
2829
- export type CampaignStatus = (typeof CampaignStatus)[keyof typeof CampaignStatus];
2830
2557
  /**
2831
2558
  * <p>Provides information about the status of a campaign.</p>
2832
2559
  * @public
@@ -3197,28 +2924,6 @@ export interface ClosedDays {
3197
2924
  */
3198
2925
  CUSTOM?: ClosedDaysRule[] | undefined;
3199
2926
  }
3200
- /**
3201
- * <p>Provides information about an API request or response.</p>
3202
- * @public
3203
- */
3204
- export declare class ConflictException extends __BaseException {
3205
- readonly name: "ConflictException";
3206
- readonly $fault: "client";
3207
- /**
3208
- * <p>The message that's returned from the API.</p>
3209
- * @public
3210
- */
3211
- Message?: string | undefined;
3212
- /**
3213
- * <p>The unique identifier for the request or response.</p>
3214
- * @public
3215
- */
3216
- RequestID?: string | undefined;
3217
- /**
3218
- * @internal
3219
- */
3220
- constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
3221
- }
3222
2927
  /**
3223
2928
  * <p>Specifies the display name of an application and the tags to associate with the application.</p>
3224
2929
  * @public
@@ -3255,138 +2960,6 @@ export interface CreateAppResponse {
3255
2960
  */
3256
2961
  ApplicationResponse: ApplicationResponse | undefined;
3257
2962
  }
3258
- /**
3259
- * <p>Provides information about an API request or response.</p>
3260
- * @public
3261
- */
3262
- export declare class ForbiddenException extends __BaseException {
3263
- readonly name: "ForbiddenException";
3264
- readonly $fault: "client";
3265
- /**
3266
- * <p>The message that's returned from the API.</p>
3267
- * @public
3268
- */
3269
- Message?: string | undefined;
3270
- /**
3271
- * <p>The unique identifier for the request or response.</p>
3272
- * @public
3273
- */
3274
- RequestID?: string | undefined;
3275
- /**
3276
- * @internal
3277
- */
3278
- constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
3279
- }
3280
- /**
3281
- * <p>Provides information about an API request or response.</p>
3282
- * @public
3283
- */
3284
- export declare class InternalServerErrorException extends __BaseException {
3285
- readonly name: "InternalServerErrorException";
3286
- readonly $fault: "server";
3287
- /**
3288
- * <p>The message that's returned from the API.</p>
3289
- * @public
3290
- */
3291
- Message?: string | undefined;
3292
- /**
3293
- * <p>The unique identifier for the request or response.</p>
3294
- * @public
3295
- */
3296
- RequestID?: string | undefined;
3297
- /**
3298
- * @internal
3299
- */
3300
- constructor(opts: __ExceptionOptionType<InternalServerErrorException, __BaseException>);
3301
- }
3302
- /**
3303
- * <p>Provides information about an API request or response.</p>
3304
- * @public
3305
- */
3306
- export declare class MethodNotAllowedException extends __BaseException {
3307
- readonly name: "MethodNotAllowedException";
3308
- readonly $fault: "client";
3309
- /**
3310
- * <p>The message that's returned from the API.</p>
3311
- * @public
3312
- */
3313
- Message?: string | undefined;
3314
- /**
3315
- * <p>The unique identifier for the request or response.</p>
3316
- * @public
3317
- */
3318
- RequestID?: string | undefined;
3319
- /**
3320
- * @internal
3321
- */
3322
- constructor(opts: __ExceptionOptionType<MethodNotAllowedException, __BaseException>);
3323
- }
3324
- /**
3325
- * <p>Provides information about an API request or response.</p>
3326
- * @public
3327
- */
3328
- export declare class NotFoundException extends __BaseException {
3329
- readonly name: "NotFoundException";
3330
- readonly $fault: "client";
3331
- /**
3332
- * <p>The message that's returned from the API.</p>
3333
- * @public
3334
- */
3335
- Message?: string | undefined;
3336
- /**
3337
- * <p>The unique identifier for the request or response.</p>
3338
- * @public
3339
- */
3340
- RequestID?: string | undefined;
3341
- /**
3342
- * @internal
3343
- */
3344
- constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
3345
- }
3346
- /**
3347
- * <p>Provides information about an API request or response.</p>
3348
- * @public
3349
- */
3350
- export declare class PayloadTooLargeException extends __BaseException {
3351
- readonly name: "PayloadTooLargeException";
3352
- readonly $fault: "client";
3353
- /**
3354
- * <p>The message that's returned from the API.</p>
3355
- * @public
3356
- */
3357
- Message?: string | undefined;
3358
- /**
3359
- * <p>The unique identifier for the request or response.</p>
3360
- * @public
3361
- */
3362
- RequestID?: string | undefined;
3363
- /**
3364
- * @internal
3365
- */
3366
- constructor(opts: __ExceptionOptionType<PayloadTooLargeException, __BaseException>);
3367
- }
3368
- /**
3369
- * <p>Provides information about an API request or response.</p>
3370
- * @public
3371
- */
3372
- export declare class TooManyRequestsException extends __BaseException {
3373
- readonly name: "TooManyRequestsException";
3374
- readonly $fault: "client";
3375
- /**
3376
- * <p>The message that's returned from the API.</p>
3377
- * @public
3378
- */
3379
- Message?: string | undefined;
3380
- /**
3381
- * <p>The unique identifier for the request or response.</p>
3382
- * @public
3383
- */
3384
- RequestID?: string | undefined;
3385
- /**
3386
- * @internal
3387
- */
3388
- constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
3389
- }
3390
2963
  /**
3391
2964
  * <p>Specifies the settings for a campaign treatment. A <i>treatment</i> is a variation of a campaign that's used for A/B testing of a campaign.</p>
3392
2965
  * @public
@@ -3703,25 +3276,6 @@ export interface ExportJobResource {
3703
3276
  */
3704
3277
  SegmentVersion?: number | undefined;
3705
3278
  }
3706
- /**
3707
- * @public
3708
- * @enum
3709
- */
3710
- export declare const JobStatus: {
3711
- readonly COMPLETED: "COMPLETED";
3712
- readonly COMPLETING: "COMPLETING";
3713
- readonly CREATED: "CREATED";
3714
- readonly FAILED: "FAILED";
3715
- readonly FAILING: "FAILING";
3716
- readonly INITIALIZING: "INITIALIZING";
3717
- readonly PENDING_JOB: "PENDING_JOB";
3718
- readonly PREPARING_FOR_INITIALIZATION: "PREPARING_FOR_INITIALIZATION";
3719
- readonly PROCESSING: "PROCESSING";
3720
- };
3721
- /**
3722
- * @public
3723
- */
3724
- export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
3725
3279
  /**
3726
3280
  * <p>Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.</p>
3727
3281
  * @public
@@ -3803,18 +3357,6 @@ export interface CreateExportJobResponse {
3803
3357
  */
3804
3358
  ExportJobResponse: ExportJobResponse | undefined;
3805
3359
  }
3806
- /**
3807
- * @public
3808
- * @enum
3809
- */
3810
- export declare const Format: {
3811
- readonly CSV: "CSV";
3812
- readonly JSON: "JSON";
3813
- };
3814
- /**
3815
- * @public
3816
- */
3817
- export type Format = (typeof Format)[keyof typeof Format];
3818
3360
  /**
3819
3361
  * <p>Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.</p>
3820
3362
  * @public
@@ -4132,23 +3674,6 @@ export interface JourneyLimits {
4132
3674
  */
4133
3675
  TotalCap?: number | undefined;
4134
3676
  }
4135
- /**
4136
- * @public
4137
- * @enum
4138
- */
4139
- export declare const DayOfWeek: {
4140
- readonly FRIDAY: "FRIDAY";
4141
- readonly MONDAY: "MONDAY";
4142
- readonly SATURDAY: "SATURDAY";
4143
- readonly SUNDAY: "SUNDAY";
4144
- readonly THURSDAY: "THURSDAY";
4145
- readonly TUESDAY: "TUESDAY";
4146
- readonly WEDNESDAY: "WEDNESDAY";
4147
- };
4148
- /**
4149
- * @public
4150
- */
4151
- export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek];
4152
3677
  /**
4153
3678
  * <p>Specifies the start and end time for OpenHours.</p>
4154
3679
  * @public
@@ -4271,22 +3796,6 @@ export interface StartCondition {
4271
3796
  */
4272
3797
  SegmentStartCondition?: SegmentCondition | undefined;
4273
3798
  }
4274
- /**
4275
- * @public
4276
- * @enum
4277
- */
4278
- export declare const State: {
4279
- readonly ACTIVE: "ACTIVE";
4280
- readonly CANCELLED: "CANCELLED";
4281
- readonly CLOSED: "CLOSED";
4282
- readonly COMPLETED: "COMPLETED";
4283
- readonly DRAFT: "DRAFT";
4284
- readonly PAUSED: "PAUSED";
4285
- };
4286
- /**
4287
- * @public
4288
- */
4289
- export type State = (typeof State)[keyof typeof State];
4290
3799
  /**
4291
3800
  * <p>Specifies the configuration and other settings for a journey.</p>
4292
3801
  * @public
@@ -4789,32 +4298,6 @@ export interface SegmentReference {
4789
4298
  */
4790
4299
  Version?: number | undefined;
4791
4300
  }
4792
- /**
4793
- * @public
4794
- * @enum
4795
- */
4796
- export declare const SourceType: {
4797
- readonly ALL: "ALL";
4798
- readonly ANY: "ANY";
4799
- readonly NONE: "NONE";
4800
- };
4801
- /**
4802
- * @public
4803
- */
4804
- export type SourceType = (typeof SourceType)[keyof typeof SourceType];
4805
- /**
4806
- * @public
4807
- * @enum
4808
- */
4809
- export declare const Type: {
4810
- readonly ALL: "ALL";
4811
- readonly ANY: "ANY";
4812
- readonly NONE: "NONE";
4813
- };
4814
- /**
4815
- * @public
4816
- */
4817
- export type Type = (typeof Type)[keyof typeof Type];
4818
4301
  /**
4819
4302
  * <p>Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.</p>
4820
4303
  * @public
@@ -4841,19 +4324,6 @@ export interface SegmentGroup {
4841
4324
  */
4842
4325
  Type?: Type | undefined;
4843
4326
  }
4844
- /**
4845
- * @public
4846
- * @enum
4847
- */
4848
- export declare const Include: {
4849
- readonly ALL: "ALL";
4850
- readonly ANY: "ANY";
4851
- readonly NONE: "NONE";
4852
- };
4853
- /**
4854
- * @public
4855
- */
4856
- export type Include = (typeof Include)[keyof typeof Include];
4857
4327
  /**
4858
4328
  * <p>Specifies the settings that define the relationships between segment groups for a segment.</p>
4859
4329
  * @public
@@ -4947,18 +4417,6 @@ export interface SegmentImportResource {
4947
4417
  */
4948
4418
  Size: number | undefined;
4949
4419
  }
4950
- /**
4951
- * @public
4952
- * @enum
4953
- */
4954
- export declare const SegmentType: {
4955
- readonly DIMENSIONAL: "DIMENSIONAL";
4956
- readonly IMPORT: "IMPORT";
4957
- };
4958
- /**
4959
- * @public
4960
- */
4961
- export type SegmentType = (typeof SegmentType)[keyof typeof SegmentType];
4962
4420
  /**
4963
4421
  * <p>Provides information about the configuration, dimension, and other settings for a segment.</p>
4964
4422
  * @public
@@ -6252,23 +5710,6 @@ export interface DeleteVoiceTemplateResponse {
6252
5710
  */
6253
5711
  MessageBody: MessageBody | undefined;
6254
5712
  }
6255
- /**
6256
- * @public
6257
- * @enum
6258
- */
6259
- export declare const DeliveryStatus: {
6260
- readonly DUPLICATE: "DUPLICATE";
6261
- readonly OPT_OUT: "OPT_OUT";
6262
- readonly PERMANENT_FAILURE: "PERMANENT_FAILURE";
6263
- readonly SUCCESSFUL: "SUCCESSFUL";
6264
- readonly TEMPORARY_FAILURE: "TEMPORARY_FAILURE";
6265
- readonly THROTTLED: "THROTTLED";
6266
- readonly UNKNOWN_FAILURE: "UNKNOWN_FAILURE";
6267
- };
6268
- /**
6269
- * @public
6270
- */
6271
- export type DeliveryStatus = (typeof DeliveryStatus)[keyof typeof DeliveryStatus];
6272
5713
  /**
6273
5714
  * <p>Specifies the contents of an email message, represented as a raw MIME message.</p>
6274
5715
  * @public
@@ -6628,21 +6069,6 @@ export interface EmailChannelRequest {
6628
6069
  */
6629
6070
  OrchestrationSendingRoleArn?: string | undefined;
6630
6071
  }
6631
- /**
6632
- * @public
6633
- * @enum
6634
- */
6635
- export declare const TemplateType: {
6636
- readonly EMAIL: "EMAIL";
6637
- readonly INAPP: "INAPP";
6638
- readonly PUSH: "PUSH";
6639
- readonly SMS: "SMS";
6640
- readonly VOICE: "VOICE";
6641
- };
6642
- /**
6643
- * @public
6644
- */
6645
- export type TemplateType = (typeof TemplateType)[keyof typeof TemplateType];
6646
6072
  /**
6647
6073
  * <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.</p>
6648
6074
  * @public
@@ -7565,3 +6991,549 @@ export interface GetCampaignsResponse {
7565
6991
  */
7566
6992
  CampaignsResponse: CampaignsResponse | undefined;
7567
6993
  }
6994
+ /**
6995
+ * @public
6996
+ */
6997
+ export interface GetCampaignVersionRequest {
6998
+ /**
6999
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7000
+ * @public
7001
+ */
7002
+ ApplicationId: string | undefined;
7003
+ /**
7004
+ * <p>The unique identifier for the campaign.</p>
7005
+ * @public
7006
+ */
7007
+ CampaignId: string | undefined;
7008
+ /**
7009
+ * <p>The unique version number (Version property) for the campaign version.</p>
7010
+ * @public
7011
+ */
7012
+ Version: string | undefined;
7013
+ }
7014
+ /**
7015
+ * @public
7016
+ */
7017
+ export interface GetCampaignVersionResponse {
7018
+ /**
7019
+ * <p>Provides information about the status, configuration, and other settings for a campaign.</p>
7020
+ * @public
7021
+ */
7022
+ CampaignResponse: CampaignResponse | undefined;
7023
+ }
7024
+ /**
7025
+ * @public
7026
+ */
7027
+ export interface GetCampaignVersionsRequest {
7028
+ /**
7029
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7030
+ * @public
7031
+ */
7032
+ ApplicationId: string | undefined;
7033
+ /**
7034
+ * <p>The unique identifier for the campaign.</p>
7035
+ * @public
7036
+ */
7037
+ CampaignId: string | undefined;
7038
+ /**
7039
+ * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
7040
+ * @public
7041
+ */
7042
+ PageSize?: string | undefined;
7043
+ /**
7044
+ * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
7045
+ * @public
7046
+ */
7047
+ Token?: string | undefined;
7048
+ }
7049
+ /**
7050
+ * @public
7051
+ */
7052
+ export interface GetCampaignVersionsResponse {
7053
+ /**
7054
+ * <p>Provides information about the configuration and other settings for all the campaigns that are associated with an application.</p>
7055
+ * @public
7056
+ */
7057
+ CampaignsResponse: CampaignsResponse | undefined;
7058
+ }
7059
+ /**
7060
+ * @public
7061
+ */
7062
+ export interface GetChannelsRequest {
7063
+ /**
7064
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7065
+ * @public
7066
+ */
7067
+ ApplicationId: string | undefined;
7068
+ }
7069
+ /**
7070
+ * @public
7071
+ */
7072
+ export interface GetChannelsResponse {
7073
+ /**
7074
+ * <p>Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.</p>
7075
+ * @public
7076
+ */
7077
+ ChannelsResponse: ChannelsResponse | undefined;
7078
+ }
7079
+ /**
7080
+ * @public
7081
+ */
7082
+ export interface GetEmailChannelRequest {
7083
+ /**
7084
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7085
+ * @public
7086
+ */
7087
+ ApplicationId: string | undefined;
7088
+ }
7089
+ /**
7090
+ * @public
7091
+ */
7092
+ export interface GetEmailChannelResponse {
7093
+ /**
7094
+ * <p>Provides information about the status and settings of the email channel for an application.</p>
7095
+ * @public
7096
+ */
7097
+ EmailChannelResponse: EmailChannelResponse | undefined;
7098
+ }
7099
+ /**
7100
+ * @public
7101
+ */
7102
+ export interface GetEmailTemplateRequest {
7103
+ /**
7104
+ * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
7105
+ * @public
7106
+ */
7107
+ TemplateName: string | undefined;
7108
+ /**
7109
+ * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
7110
+ * @public
7111
+ */
7112
+ Version?: string | undefined;
7113
+ }
7114
+ /**
7115
+ * @public
7116
+ */
7117
+ export interface GetEmailTemplateResponse {
7118
+ /**
7119
+ * <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.</p>
7120
+ * @public
7121
+ */
7122
+ EmailTemplateResponse: EmailTemplateResponse | undefined;
7123
+ }
7124
+ /**
7125
+ * @public
7126
+ */
7127
+ export interface GetEndpointRequest {
7128
+ /**
7129
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7130
+ * @public
7131
+ */
7132
+ ApplicationId: string | undefined;
7133
+ /**
7134
+ * <p>The case insensitive unique identifier for the endpoint. The identifier can't contain <code>$</code>, <code>\{</code> or <code>\}</code>.</p>
7135
+ * @public
7136
+ */
7137
+ EndpointId: string | undefined;
7138
+ }
7139
+ /**
7140
+ * @public
7141
+ */
7142
+ export interface GetEndpointResponse {
7143
+ /**
7144
+ * <p>Provides information about the channel type and other settings for an endpoint.</p>
7145
+ * @public
7146
+ */
7147
+ EndpointResponse: EndpointResponse | undefined;
7148
+ }
7149
+ /**
7150
+ * @public
7151
+ */
7152
+ export interface GetEventStreamRequest {
7153
+ /**
7154
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7155
+ * @public
7156
+ */
7157
+ ApplicationId: string | undefined;
7158
+ }
7159
+ /**
7160
+ * @public
7161
+ */
7162
+ export interface GetEventStreamResponse {
7163
+ /**
7164
+ * <p>Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.</p>
7165
+ * @public
7166
+ */
7167
+ EventStream: EventStream | undefined;
7168
+ }
7169
+ /**
7170
+ * @public
7171
+ */
7172
+ export interface GetExportJobRequest {
7173
+ /**
7174
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7175
+ * @public
7176
+ */
7177
+ ApplicationId: string | undefined;
7178
+ /**
7179
+ * <p>The unique identifier for the job.</p>
7180
+ * @public
7181
+ */
7182
+ JobId: string | undefined;
7183
+ }
7184
+ /**
7185
+ * @public
7186
+ */
7187
+ export interface GetExportJobResponse {
7188
+ /**
7189
+ * <p>Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.</p>
7190
+ * @public
7191
+ */
7192
+ ExportJobResponse: ExportJobResponse | undefined;
7193
+ }
7194
+ /**
7195
+ * @public
7196
+ */
7197
+ export interface GetExportJobsRequest {
7198
+ /**
7199
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7200
+ * @public
7201
+ */
7202
+ ApplicationId: string | undefined;
7203
+ /**
7204
+ * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
7205
+ * @public
7206
+ */
7207
+ PageSize?: string | undefined;
7208
+ /**
7209
+ * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
7210
+ * @public
7211
+ */
7212
+ Token?: string | undefined;
7213
+ }
7214
+ /**
7215
+ * @public
7216
+ */
7217
+ export interface GetExportJobsResponse {
7218
+ /**
7219
+ * <p>Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.</p>
7220
+ * @public
7221
+ */
7222
+ ExportJobsResponse: ExportJobsResponse | undefined;
7223
+ }
7224
+ /**
7225
+ * @public
7226
+ */
7227
+ export interface GetGcmChannelRequest {
7228
+ /**
7229
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7230
+ * @public
7231
+ */
7232
+ ApplicationId: string | undefined;
7233
+ }
7234
+ /**
7235
+ * @public
7236
+ */
7237
+ export interface GetGcmChannelResponse {
7238
+ /**
7239
+ * <p>Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
7240
+ * @public
7241
+ */
7242
+ GCMChannelResponse: GCMChannelResponse | undefined;
7243
+ }
7244
+ /**
7245
+ * @public
7246
+ */
7247
+ export interface GetImportJobRequest {
7248
+ /**
7249
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7250
+ * @public
7251
+ */
7252
+ ApplicationId: string | undefined;
7253
+ /**
7254
+ * <p>The unique identifier for the job.</p>
7255
+ * @public
7256
+ */
7257
+ JobId: string | undefined;
7258
+ }
7259
+ /**
7260
+ * @public
7261
+ */
7262
+ export interface GetImportJobResponse {
7263
+ /**
7264
+ * <p>Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.</p>
7265
+ * @public
7266
+ */
7267
+ ImportJobResponse: ImportJobResponse | undefined;
7268
+ }
7269
+ /**
7270
+ * @public
7271
+ */
7272
+ export interface GetImportJobsRequest {
7273
+ /**
7274
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7275
+ * @public
7276
+ */
7277
+ ApplicationId: string | undefined;
7278
+ /**
7279
+ * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
7280
+ * @public
7281
+ */
7282
+ PageSize?: string | undefined;
7283
+ /**
7284
+ * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
7285
+ * @public
7286
+ */
7287
+ Token?: string | undefined;
7288
+ }
7289
+ /**
7290
+ * <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
7291
+ * @public
7292
+ */
7293
+ export interface ImportJobsResponse {
7294
+ /**
7295
+ * <p>An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).</p>
7296
+ * @public
7297
+ */
7298
+ Item: ImportJobResponse[] | undefined;
7299
+ /**
7300
+ * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
7301
+ * @public
7302
+ */
7303
+ NextToken?: string | undefined;
7304
+ }
7305
+ /**
7306
+ * @public
7307
+ */
7308
+ export interface GetImportJobsResponse {
7309
+ /**
7310
+ * <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
7311
+ * @public
7312
+ */
7313
+ ImportJobsResponse: ImportJobsResponse | undefined;
7314
+ }
7315
+ /**
7316
+ * @public
7317
+ */
7318
+ export interface GetInAppMessagesRequest {
7319
+ /**
7320
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7321
+ * @public
7322
+ */
7323
+ ApplicationId: string | undefined;
7324
+ /**
7325
+ * <p>The unique identifier for the endpoint.</p>
7326
+ * @public
7327
+ */
7328
+ EndpointId: string | undefined;
7329
+ }
7330
+ /**
7331
+ * <p>Provides all fields required for building an in-app message.</p>
7332
+ * @public
7333
+ */
7334
+ export interface InAppMessage {
7335
+ /**
7336
+ * <p>In-app message content.</p>
7337
+ * @public
7338
+ */
7339
+ Content?: InAppMessageContent[] | undefined;
7340
+ /**
7341
+ * <p>Custom config to be sent to SDK.</p>
7342
+ * @public
7343
+ */
7344
+ CustomConfig?: Record<string, string> | undefined;
7345
+ /**
7346
+ * <p>The layout of the message.</p>
7347
+ * @public
7348
+ */
7349
+ Layout?: Layout | undefined;
7350
+ }
7351
+ /**
7352
+ * <p>Schedule of the campaign.</p>
7353
+ * @public
7354
+ */
7355
+ export interface InAppCampaignSchedule {
7356
+ /**
7357
+ * <p>The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.</p>
7358
+ * @public
7359
+ */
7360
+ EndDate?: string | undefined;
7361
+ /**
7362
+ * <p>The event filter the SDK has to use to show the in-app message in the application.</p>
7363
+ * @public
7364
+ */
7365
+ EventFilter?: CampaignEventFilter | undefined;
7366
+ /**
7367
+ * <p>Time during which the in-app message should not be shown to the user.</p>
7368
+ * @public
7369
+ */
7370
+ QuietTime?: QuietTime | undefined;
7371
+ }
7372
+ /**
7373
+ * <p>Targeted in-app message campaign.</p>
7374
+ * @public
7375
+ */
7376
+ export interface InAppMessageCampaign {
7377
+ /**
7378
+ * <p>Campaign id of the corresponding campaign.</p>
7379
+ * @public
7380
+ */
7381
+ CampaignId?: string | undefined;
7382
+ /**
7383
+ * <p>Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.</p>
7384
+ * @public
7385
+ */
7386
+ DailyCap?: number | undefined;
7387
+ /**
7388
+ * <p>In-app message content with all fields required for rendering an in-app message.</p>
7389
+ * @public
7390
+ */
7391
+ InAppMessage?: InAppMessage | undefined;
7392
+ /**
7393
+ * <p>Priority of the in-app message.</p>
7394
+ * @public
7395
+ */
7396
+ Priority?: number | undefined;
7397
+ /**
7398
+ * <p>Schedule of the campaign.</p>
7399
+ * @public
7400
+ */
7401
+ Schedule?: InAppCampaignSchedule | undefined;
7402
+ /**
7403
+ * <p>Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.</p>
7404
+ * @public
7405
+ */
7406
+ SessionCap?: number | undefined;
7407
+ /**
7408
+ * <p>Total cap which controls the number of times an in-app message can be shown to the endpoint.</p>
7409
+ * @public
7410
+ */
7411
+ TotalCap?: number | undefined;
7412
+ /**
7413
+ * <p>Treatment id of the campaign.</p>
7414
+ * @public
7415
+ */
7416
+ TreatmentId?: string | undefined;
7417
+ }
7418
+ /**
7419
+ * <p>Get in-app messages response object.</p>
7420
+ * @public
7421
+ */
7422
+ export interface InAppMessagesResponse {
7423
+ /**
7424
+ * <p>List of targeted in-app message campaigns.</p>
7425
+ * @public
7426
+ */
7427
+ InAppMessageCampaigns?: InAppMessageCampaign[] | undefined;
7428
+ }
7429
+ /**
7430
+ * @public
7431
+ */
7432
+ export interface GetInAppMessagesResponse {
7433
+ /**
7434
+ * <p>Get in-app messages response object.</p>
7435
+ * @public
7436
+ */
7437
+ InAppMessagesResponse: InAppMessagesResponse | undefined;
7438
+ }
7439
+ /**
7440
+ * @public
7441
+ */
7442
+ export interface GetInAppTemplateRequest {
7443
+ /**
7444
+ * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
7445
+ * @public
7446
+ */
7447
+ TemplateName: string | undefined;
7448
+ /**
7449
+ * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
7450
+ * @public
7451
+ */
7452
+ Version?: string | undefined;
7453
+ }
7454
+ /**
7455
+ * <p>In-App Template Response.</p>
7456
+ * @public
7457
+ */
7458
+ export interface InAppTemplateResponse {
7459
+ /**
7460
+ * <p>The resource arn of the template.</p>
7461
+ * @public
7462
+ */
7463
+ Arn?: string | undefined;
7464
+ /**
7465
+ * <p>The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.</p>
7466
+ * @public
7467
+ */
7468
+ Content?: InAppMessageContent[] | undefined;
7469
+ /**
7470
+ * <p>The creation date of the template.</p>
7471
+ * @public
7472
+ */
7473
+ CreationDate: string | undefined;
7474
+ /**
7475
+ * <p>Custom config to be sent to client.</p>
7476
+ * @public
7477
+ */
7478
+ CustomConfig?: Record<string, string> | undefined;
7479
+ /**
7480
+ * <p>The last modified date of the template.</p>
7481
+ * @public
7482
+ */
7483
+ LastModifiedDate: string | undefined;
7484
+ /**
7485
+ * <p>The layout of the message.</p>
7486
+ * @public
7487
+ */
7488
+ Layout?: Layout | undefined;
7489
+ /**
7490
+ * <p>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
7491
+ * @public
7492
+ */
7493
+ tags?: Record<string, string> | undefined;
7494
+ /**
7495
+ * <p>The description of the template.</p>
7496
+ * @public
7497
+ */
7498
+ TemplateDescription?: string | undefined;
7499
+ /**
7500
+ * <p>The name of the template.</p>
7501
+ * @public
7502
+ */
7503
+ TemplateName: string | undefined;
7504
+ /**
7505
+ * <p>The type of the template.</p>
7506
+ * @public
7507
+ */
7508
+ TemplateType: TemplateType | undefined;
7509
+ /**
7510
+ * <p>The version id of the template.</p>
7511
+ * @public
7512
+ */
7513
+ Version?: string | undefined;
7514
+ }
7515
+ /**
7516
+ * @public
7517
+ */
7518
+ export interface GetInAppTemplateResponse {
7519
+ /**
7520
+ * <p>In-App Template Response.</p>
7521
+ * @public
7522
+ */
7523
+ InAppTemplateResponse: InAppTemplateResponse | undefined;
7524
+ }
7525
+ /**
7526
+ * @public
7527
+ */
7528
+ export interface GetJourneyRequest {
7529
+ /**
7530
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
7531
+ * @public
7532
+ */
7533
+ ApplicationId: string | undefined;
7534
+ /**
7535
+ * <p>The unique identifier for the journey.</p>
7536
+ * @public
7537
+ */
7538
+ JourneyId: string | undefined;
7539
+ }