feat(client-pinpoint): Adds support for Advance Quiet Time in Journeys. Adds RefreshOnSegmentUpdate and WaitForQuietTime to JourneyResponse.

Author: awstools

clients/client-pinpoint/src/commands/GetChannelsCommand.ts

@@ -17,7 +17,7 @@ import {
   GetChannelsRequestFilterSensitiveLog,
   GetChannelsResponse,
   GetChannelsResponseFilterSensitiveLog,
-} from "../models/models_0";
+} from "../models/models_1";
 import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
 import {
   deserializeAws_restJson1GetChannelsCommand,

clients/client-pinpoint/src/commands/GetEmailChannelCommand.ts

@@ -17,7 +17,7 @@ import {
   GetEmailChannelRequestFilterSensitiveLog,
   GetEmailChannelResponse,
   GetEmailChannelResponseFilterSensitiveLog,
-} from "../models/models_0";
+} from "../models/models_1";
 import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
 import {
   deserializeAws_restJson1GetEmailChannelCommand,

clients/client-pinpoint/src/commands/GetEmailTemplateCommand.ts

@@ -12,8 +12,12 @@ import {
   SerdeContext as __SerdeContext,
 } from "@aws-sdk/types";
 
-import { GetEmailTemplateRequest, GetEmailTemplateRequestFilterSensitiveLog } from "../models/models_0";
-import { GetEmailTemplateResponse, GetEmailTemplateResponseFilterSensitiveLog } from "../models/models_1";
+import {
+  GetEmailTemplateRequest,
+  GetEmailTemplateRequestFilterSensitiveLog,
+  GetEmailTemplateResponse,
+  GetEmailTemplateResponseFilterSensitiveLog,
+} from "../models/models_1";
 import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
 import {
   deserializeAws_restJson1GetEmailTemplateCommand,

clients/client-pinpoint/src/models/models_0.ts

@@ -2869,6 +2869,56 @@ export interface ChannelsResponse {
   Channels: Record<string, ChannelResponse> | undefined;
 }
 
+/**
+ * <p>Closed Days Rule. Part of Journey sending schedule.</p>
+ */
+export interface ClosedDaysRule {
+  /**
+   * <p>Name of the rule.</p>
+   */
+  Name?: string;
+
+  /**
+   * <p>Start Datetime in ISO 8601 format.</p>
+   */
+  StartDateTime?: string;
+
+  /**
+   * <p>End Datetime in ISO 8601 format.</p>
+   */
+  EndDateTime?: string;
+}
+
+/**
+ * <p>The time when journey will stop sending messages.</p>
+ */
+export interface ClosedDays {
+  /**
+   * <p>Rules for Email Channel.</p>
+   */
+  EMAIL?: ClosedDaysRule[];
+
+  /**
+   * <p>Rules for SMS Channel.</p>
+   */
+  SMS?: ClosedDaysRule[];
+
+  /**
+   * <p>Rules for Push Channel.</p>
+   */
+  PUSH?: ClosedDaysRule[];
+
+  /**
+   * <p>Rules for Voice Channel.</p>
+   */
+  VOICE?: ClosedDaysRule[];
+
+  /**
+   * <p>Rules for Custom Channel.</p>
+   */
+  CUSTOM?: ClosedDaysRule[];
+}
+
 /**
  * <p>Provides information about an API request or response.</p>
  */
@@ -3780,6 +3830,61 @@ export interface JourneyLimits {
   EndpointReentryInterval?: string;
 }
 
+export enum DayOfWeek {
+  FRIDAY = "FRIDAY",
+  MONDAY = "MONDAY",
+  SATURDAY = "SATURDAY",
+  SUNDAY = "SUNDAY",
+  THURSDAY = "THURSDAY",
+  TUESDAY = "TUESDAY",
+  WEDNESDAY = "WEDNESDAY",
+}
+
+/**
+ * <p>List of OpenHours Rules.</p>
+ */
+export interface OpenHoursRule {
+  /**
+   * <p>Local start time in ISO 8601 format.</p>
+   */
+  StartTime?: string;
+
+  /**
+   * <p>Local start time in ISO 8601 format.</p>
+   */
+  EndTime?: string;
+}
+
+/**
+ * <p>The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
+ */
+export interface OpenHours {
+  /**
+   * <p>Rules for Email Channel.</p>
+   */
+  EMAIL?: Record<string, OpenHoursRule[]>;
+
+  /**
+   * <p>Rules for SMS Channel.</p>
+   */
+  SMS?: Record<string, OpenHoursRule[]>;
+
+  /**
+   * <p>Rules for Push Channel.</p>
+   */
+  PUSH?: Record<string, OpenHoursRule[]>;
+
+  /**
+   * <p>Rules for Voice Channel.</p>
+   */
+  VOICE?: Record<string, OpenHoursRule[]>;
+
+  /**
+   * <p>Rules for Custom Channel.</p>
+   */
+  CUSTOM?: Record<string, OpenHoursRule[]>;
+}
+
 /**
  * <p>Specifies the schedule settings for a journey.</p>
  */
@@ -3939,6 +4044,21 @@ export interface WriteJourneyRequest {
    * <p>The channel-specific configurations for the journey.</p>
    */
   JourneyChannelSettings?: JourneyChannelSettings;
+
+  /**
+   * <p>Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)</p>
+   */
+  SendingSchedule?: boolean;
+
+  /**
+   * <p>The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
+   */
+  OpenHours?: OpenHours;
+
+  /**
+   * <p>The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
+   */
+  ClosedDays?: ClosedDays;
 }
 
 export interface CreateJourneyRequest {
@@ -4046,6 +4166,21 @@ export interface JourneyResponse {
    * <p>The channel-specific configurations for the journey.</p>
    */
   JourneyChannelSettings?: JourneyChannelSettings;
+
+  /**
+   * <p>Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)</p>
+   */
+  SendingSchedule?: boolean;
+
+  /**
+   * <p>The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
+   */
+  OpenHours?: OpenHours;
+
+  /**
+   * <p>The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.</p>
+   */
+  ClosedDays?: ClosedDays;
 }
 
 export interface CreateJourneyResponse {
@@ -6754,46 +6889,6 @@ export interface GetCampaignVersionsResponse {
   CampaignsResponse: CampaignsResponse | undefined;
 }
 
-export interface GetChannelsRequest {
-  /**
-   * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
-   */
-  ApplicationId: string | undefined;
-}
-
-export interface GetChannelsResponse {
-  /**
-   * <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>
-   */
-  ChannelsResponse: ChannelsResponse | undefined;
-}
-
-export interface GetEmailChannelRequest {
-  /**
-   * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
-   */
-  ApplicationId: string | undefined;
-}
-
-export interface GetEmailChannelResponse {
-  /**
-   * <p>Provides information about the status and settings of the email channel for an application.</p>
-   */
-  EmailChannelResponse: EmailChannelResponse | undefined;
-}
-
-export interface GetEmailTemplateRequest {
-  /**
-   * <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>
-   */
-  TemplateName: string | undefined;
-
-  /**
-   * <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>
-   */
-  Version?: string;
-}
-
 /**
  * @internal
  */
@@ -7410,6 +7505,20 @@ export const ChannelsResponseFilterSensitiveLog = (obj: ChannelsResponse): any =
   ...obj,
 });
 
+/**
+ * @internal
+ */
+export const ClosedDaysRuleFilterSensitiveLog = (obj: ClosedDaysRule): any => ({
+  ...obj,
+});
+
+/**
+ * @internal
+ */
+export const ClosedDaysFilterSensitiveLog = (obj: ClosedDays): any => ({
+  ...obj,
+});
+
 /**
  * @internal
  */
@@ -7599,6 +7708,20 @@ export const JourneyLimitsFilterSensitiveLog = (obj: JourneyLimits): any => ({
   ...obj,
 });
 
+/**
+ * @internal
+ */
+export const OpenHoursRuleFilterSensitiveLog = (obj: OpenHoursRule): any => ({
+  ...obj,
+});
+
+/**
+ * @internal
+ */
+export const OpenHoursFilterSensitiveLog = (obj: OpenHours): any => ({
+  ...obj,
+});
+
 /**
  * @internal
  */
@@ -8641,38 +8764,3 @@ export const GetCampaignVersionsRequestFilterSensitiveLog = (obj: GetCampaignVer
 export const GetCampaignVersionsResponseFilterSensitiveLog = (obj: GetCampaignVersionsResponse): any => ({
   ...obj,
 });
-
-/**
- * @internal
- */
-export const GetChannelsRequestFilterSensitiveLog = (obj: GetChannelsRequest): any => ({
-  ...obj,
-});
-
-/**
- * @internal
- */
-export const GetChannelsResponseFilterSensitiveLog = (obj: GetChannelsResponse): any => ({
-  ...obj,
-});
-
-/**
- * @internal
- */
-export const GetEmailChannelRequestFilterSensitiveLog = (obj: GetEmailChannelRequest): any => ({
-  ...obj,
-});
-
-/**
- * @internal
- */
-export const GetEmailChannelResponseFilterSensitiveLog = (obj: GetEmailChannelResponse): any => ({
-  ...obj,
-});
-
-/**
- * @internal
- */
-export const GetEmailTemplateRequestFilterSensitiveLog = (obj: GetEmailTemplateRequest): any => ({
-  ...obj,
-});