@opens/gateways 1.16.8 → 1.16.10

package/dist/customer-service/contracts/index.d.mts

@@ -394,8 +394,8 @@ interface AnnouncementAppearance {
      */
     position?: 'top' | 'bottom';
 }
-/** Payload rendered by the announcement widget. */
-interface AnnouncementPayload {
+/** Payload rendered by a banner announcement. */
+interface BannerAnnouncementPayload {
     /** Main announcement message. */
     message: string;
     /** Visual style applied to the announcement. */
@@ -405,6 +405,168 @@ interface AnnouncementPayload {
     /** Optional appearance configuration for DOM anchoring. */
     appearance?: AnnouncementAppearance;
 }
+/** A selectable option in a survey question. */
+interface SurveyQuestionOption {
+    /** Stable identifier for the option. */
+    id: string;
+    /** Label displayed to the respondent. */
+    label: string;
+    /** Value stored in the survey response. */
+    value: string;
+}
+/** Configuration for a numeric rating question. */
+interface SurveyRatingQuestionConfig {
+    /** Lowest selectable value. */
+    min: number;
+    /** Highest selectable value. */
+    max: number;
+    /** Increment between selectable values. */
+    step: number;
+    /** Optional label displayed near the lowest value. */
+    lowLabel?: string;
+    /** Optional label displayed near the highest value. */
+    highLabel?: string;
+}
+/** Configuration for an emoji reaction question. */
+interface SurveyReactionQuestionConfig {
+    /** Optional label displayed near the negative reaction. */
+    lowLabel?: string;
+    /** Optional label displayed near the positive reaction. */
+    highLabel?: string;
+}
+/** Configuration for a free-text question. */
+interface SurveyTextQuestionConfig {
+    /** Whether the input is rendered as a multiline field. */
+    multiline: boolean;
+    /** Optional input placeholder. */
+    placeholder?: string;
+    /** Optional minimum response length. */
+    minLength?: number;
+    /** Maximum response length. */
+    maxLength: number;
+}
+/** Configuration for a single-choice question. */
+interface SurveySingleChoiceQuestionConfig {
+    /** Options presented to the respondent. */
+    options: SurveyQuestionOption[];
+}
+/** Configuration for a multiple-choice question. */
+interface SurveyMultipleChoiceQuestionConfig {
+    /** Minimum number of options that can be selected. */
+    minSelections: number;
+    /** Maximum number of options that can be selected. */
+    maxSelections: number;
+    /** Options presented to the respondent. */
+    options: SurveyQuestionOption[];
+}
+/** A numeric rating question. */
+interface SurveyRatingQuestion {
+    /** Stable identifier for the question. */
+    id: string;
+    /** Text displayed to the respondent. */
+    text: string;
+    /** Optional supporting text. */
+    description?: string;
+    /** Whether an answer is required. */
+    required: boolean;
+    /** Question input type. */
+    type: 'rating';
+    /** Input configuration. */
+    config: SurveyRatingQuestionConfig;
+}
+/** An emoji reaction question. */
+interface SurveyReactionQuestion {
+    /** Stable identifier for the question. */
+    id: string;
+    /** Text displayed to the respondent. */
+    text: string;
+    /** Optional supporting text. */
+    description?: string;
+    /** Whether an answer is required. */
+    required: boolean;
+    /** Question input type. */
+    type: 'reaction';
+    /** Input configuration. */
+    config: SurveyReactionQuestionConfig;
+}
+/** A free-text question. */
+interface SurveyTextQuestion {
+    /** Stable identifier for the question. */
+    id: string;
+    /** Text displayed to the respondent. */
+    text: string;
+    /** Optional supporting text. */
+    description?: string;
+    /** Whether an answer is required. */
+    required: boolean;
+    /** Question input type. */
+    type: 'text';
+    /** Input configuration. */
+    config: SurveyTextQuestionConfig;
+}
+/** A question that accepts one option. */
+interface SurveySingleChoiceQuestion {
+    /** Stable identifier for the question. */
+    id: string;
+    /** Text displayed to the respondent. */
+    text: string;
+    /** Optional supporting text. */
+    description?: string;
+    /** Whether an answer is required. */
+    required: boolean;
+    /** Question input type. */
+    type: 'single_choice';
+    /** Input configuration. */
+    config: SurveySingleChoiceQuestionConfig;
+}
+/** A question that accepts multiple options. */
+interface SurveyMultipleChoiceQuestion {
+    /** Stable identifier for the question. */
+    id: string;
+    /** Text displayed to the respondent. */
+    text: string;
+    /** Optional supporting text. */
+    description?: string;
+    /** Whether an answer is required. */
+    required: boolean;
+    /** Question input type. */
+    type: 'multiple_choice';
+    /** Input configuration. */
+    config: SurveyMultipleChoiceQuestionConfig;
+}
+/** A question supported by the generic survey payload. */
+type SurveyQuestion = SurveyRatingQuestion | SurveyReactionQuestion | SurveyTextQuestion | SurveySingleChoiceQuestion | SurveyMultipleChoiceQuestion;
+/** Completion content displayed after submitting a survey. */
+interface SurveyCompletion {
+    /** Optional message shown after submission. */
+    message?: string;
+}
+/** Supported viewport placements for a survey. */
+type SurveyPlacement = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+/** Rendering options for a survey. */
+interface SurveyAppearance {
+    /** Display mode supported by the widget. */
+    mode: 'popover';
+    /** Viewport corner where the survey is displayed. */
+    placement?: SurveyPlacement;
+}
+/** Payload rendered by a survey announcement. */
+interface SurveyAnnouncementPayload {
+    /** Schema version used to validate the survey. */
+    formatVersion: 1;
+    /** Survey title. */
+    title: string;
+    /** Optional supporting description. */
+    description?: string;
+    /** Ordered questions displayed to the respondent. */
+    questions: SurveyQuestion[];
+    /** Optional completion content. */
+    completion?: SurveyCompletion;
+    /** Survey rendering options. */
+    appearance: SurveyAppearance;
+}
+/** Payload rendered by the announcement widget. */
+type AnnouncementPayload = BannerAnnouncementPayload | SurveyAnnouncementPayload;
 /** URL targeting rule for an announcement. */
 interface AnnouncementTargetingRuleUrl {
     /** Matching strategy. */
@@ -455,6 +617,8 @@ interface Announcement {
     payload: AnnouncementPayload;
     /** Optional expiration ISO date. */
     expiresAt?: string | null;
+    /** Optional ISO date when the announcement becomes active. */
+    startsAt?: string | null;
     /** Creation ISO date. */
     createdAt: string;
     /** Last update ISO date. */
@@ -504,6 +668,8 @@ interface CreateAnnouncementRequest {
     allCompanies: boolean;
     /** Optional expiration ISO date. */
     expiresAt?: string | null;
+    /** Optional ISO date when the announcement becomes active. */
+    startsAt?: string | null;
     /** Renderable payload. */
     payload: AnnouncementPayload;
     /** Company UUIDs allowed to see the announcement when allCompanies is false. */
@@ -523,6 +689,8 @@ interface UpdateAnnouncementRequest {
     allCompanies: boolean;
     /** Optional expiration ISO date. */
     expiresAt?: string | null;
+    /** Optional ISO date when the announcement becomes active. */
+    startsAt?: string | null;
     /** Renderable payload. */
     payload: AnnouncementPayload;
     /** Company UUIDs allowed to see the announcement when allCompanies is false. */
@@ -537,19 +705,146 @@ interface UpdateAnnouncementStatusRequest {
 }
 /** Query parameters for the active announcements widget endpoint. */
 interface ActiveAnnouncementQuery {
+    /** Stable subject UUID used to return only unanswered surveys. */
+    id?: string;
+    /** Optional subject name received from identify. */
+    name?: string;
+    /** Optional subject email received from identify. */
+    email?: string;
+    /** Optional subject phone received from identify. */
+    phone?: string;
     /** Current page URL used for URL targeting rules. */
     url?: string;
     /** User profile slug used for profile targeting rules. */
     profile?: string;
 }
-/** Slim announcement payload returned by the active endpoint (widget). */
-interface ActiveAnnouncement {
+/** Active banner returned by the widget endpoint. */
+interface ActiveBannerAnnouncement {
     /** Unique identifier. */
     id: string;
-    /** Announcement type slug. */
-    type?: string;
-    /** Renderable payload. */
-    payload: AnnouncementPayload;
+    /** Banner announcement discriminator. */
+    type: 'banner';
+    /** Banner payload rendered by the widget. */
+    payload: BannerAnnouncementPayload;
+}
+/** Active survey returned by the widget endpoint. */
+interface ActiveSurveyAnnouncement {
+    /** Unique identifier. */
+    id: string;
+    /** Survey announcement discriminator. */
+    type: 'survey';
+    /** Survey payload rendered by the widget. */
+    payload: SurveyAnnouncementPayload;
+}
+/** Announcement returned by the active widget endpoint. */
+type ActiveAnnouncement = ActiveBannerAnnouncement | ActiveSurveyAnnouncement;
+
+/** A value submitted for a survey question. */
+type SurveyAnswerValue = number | string | string[];
+/** An answer submitted for one survey question. */
+interface SurveyAnswer {
+    /** Identifier of the answered question. */
+    questionId: string;
+    /** Value submitted for the question. */
+    value: SurveyAnswerValue;
+}
+/** Request payload for submitting a survey response. */
+interface CreateSurveyResponseRequest {
+    /** Stable identifier of the subject answering the survey. */
+    subjectId: string;
+    /** Optional subject name captured at submission time. */
+    subjectName?: string;
+    /** Optional subject profile captured at submission time. */
+    subjectProfile?: string;
+    /** Answers submitted by the subject. */
+    answers: SurveyAnswer[];
+}
+/** A selected choice persisted for a survey response answer. */
+interface SurveyResponseAnswerOption {
+    /** Unique selected-option record identifier. */
+    id: string;
+    /** Identifier of the owning answer record. */
+    answerId: string;
+    /** Stable identifier of the option from the survey payload. */
+    optionId: string;
+    /** Machine-readable option value captured at submission time. */
+    optionValue: string;
+    /** Display label captured at submission time. */
+    optionLabel: string;
+    /** One-based option position in the survey payload. */
+    optionPosition: number;
+    /** ISO date when the selected option was created. */
+    createdAt: string;
+    /** ISO date when the selected option was last updated. */
+    updatedAt: string;
+}
+/** Normalized answer persisted for one survey question. */
+interface SurveyResponseAnswer {
+    /** Unique answer record identifier. */
+    id: string;
+    /** Identifier of the owning survey response. */
+    responseId: string;
+    /** Stable identifier of the question from the survey payload. */
+    questionId: string;
+    /** Question type captured at submission time. */
+    questionType: SurveyQuestion['type'];
+    /** One-based question position in the survey payload. */
+    questionPosition: number;
+    /** Question text captured at submission time. */
+    questionText: string;
+    /** Whether the question was required at submission time. */
+    questionRequired: boolean;
+    /** Whether the subject supplied a meaningful answer. */
+    answered: boolean;
+    /** Original answer value, or null when the question was skipped. */
+    rawValue: SurveyAnswerValue | null;
+    /** Numeric projection used by rating and reaction reports. */
+    numericValue: number | null;
+    /** Text projection used by free-text reports. */
+    textValue: string | null;
+    /** Options selected for single-choice or multiple-choice questions. */
+    selectedOptions: SurveyResponseAnswerOption[];
+    /** ISO date when the normalized answer was created. */
+    createdAt: string;
+    /** ISO date when the normalized answer was last updated. */
+    updatedAt: string;
+}
+/** A persisted response to a survey announcement. */
+interface SurveyResponse {
+    /** Unique response identifier. */
+    id: string;
+    /** Identifier of the answered survey announcement. */
+    announcementId: string;
+    /** Identifier of the authenticated company. */
+    companyId: string;
+    /** Stable identifier of the responding subject. */
+    subjectId: string;
+    /** Subject name captured at submission time. */
+    subjectName: string | null;
+    /** Subject profile captured at submission time. */
+    subjectProfile: string | null;
+    /** Normalized records for every survey question. */
+    answers: SurveyResponseAnswer[];
+    /** ISO date when the response was submitted. */
+    submittedAt: string;
+    /** ISO date when the response was created. */
+    createdAt: string;
+    /** ISO date when the response was last updated. */
+    updatedAt: string;
+}
+/** Query parameters for the administrative survey-response list. */
+interface SurveyResponseListFilters {
+    /** One-based page number. */
+    page?: number;
+    /** Maximum number of responses per page. */
+    limit?: number;
+}
+/** Paginated responses returned for a survey announcement. */
+interface SurveyResponseListResponse {
+    /** Total matching responses. */
+    count: number;
+    /** Responses for the requested page. */
+    rows: SurveyResponse[];
 }
 
 /** Request payload for generating a two-factor OTP secret URL. */
@@ -570,4 +865,4 @@ interface ValidateTwoFactorOtpResponse {
     validate: boolean;
 }
 
-export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyData, CompanyJsonConfigKey, CompanyQueue, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, CreateAnnouncementRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetSupportWidgetIdResponse, GetUserByIdResponse, ListUsersInclude, ListUsersProfile, ListUsersRequest, ListUsersResponse, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, UserBond, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
+export type { ActiveAnnouncement, ActiveAnnouncementQuery, ActiveBannerAnnouncement, ActiveSurveyAnnouncement, Announcement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, BannerAnnouncementPayload, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyData, CompanyJsonConfigKey, CompanyQueue, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, CreateAnnouncementRequest, CreateSurveyResponseRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetSupportWidgetIdResponse, GetUserByIdResponse, ListUsersInclude, ListUsersProfile, ListUsersRequest, ListUsersResponse, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, StrongPasswordOptionsResponse, SurveyAnnouncementPayload, SurveyAnswer, SurveyAnswerValue, SurveyAppearance, SurveyCompletion, SurveyMultipleChoiceQuestion, SurveyMultipleChoiceQuestionConfig, SurveyPlacement, SurveyQuestion, SurveyQuestionOption, SurveyRatingQuestion, SurveyRatingQuestionConfig, SurveyReactionQuestion, SurveyReactionQuestionConfig, SurveyResponse, SurveyResponseAnswer, SurveyResponseAnswerOption, SurveyResponseListFilters, SurveyResponseListResponse, SurveySingleChoiceQuestion, SurveySingleChoiceQuestionConfig, SurveyTextQuestion, SurveyTextQuestionConfig, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateUserPasswordRequest, UpdateUserPasswordResponse, User, UserBond, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };