@opens/gateways 1.16.20 → 1.16.21

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.
@@ -394,8 +394,8 @@ interface AnnouncementAppearance {
394
394
  */
395
395
  position?: 'top' | 'bottom';
396
396
  }
397
- /** Payload rendered by the announcement widget. */
398
- interface AnnouncementPayload {
397
+ /** Payload rendered by a banner announcement. */
398
+ interface BannerAnnouncementPayload {
399
399
  /** Main announcement message. */
400
400
  message: string;
401
401
  /** Visual style applied to the announcement. */
@@ -405,6 +405,170 @@ interface AnnouncementPayload {
405
405
  /** Optional appearance configuration for DOM anchoring. */
406
406
  appearance?: AnnouncementAppearance;
407
407
  }
408
+ /** A selectable option in a survey question. */
409
+ interface SurveyQuestionOption {
410
+ /** Stable identifier for the option. */
411
+ id: string;
412
+ /** Label displayed to the respondent. */
413
+ label: string;
414
+ /** Value stored in the survey response. */
415
+ value: string;
416
+ }
417
+ /** Configuration for a numeric rating question. */
418
+ interface SurveyRatingQuestionConfig {
419
+ /** Lowest selectable value. */
420
+ min: number;
421
+ /** Highest selectable value. */
422
+ max: number;
423
+ /** Increment between selectable values. */
424
+ step: number;
425
+ /** Optional label displayed near the lowest value. */
426
+ lowLabel?: string;
427
+ /** Optional label displayed near the highest value. */
428
+ highLabel?: string;
429
+ }
430
+ /** Configuration for an emoji reaction question. */
431
+ interface SurveyReactionQuestionConfig {
432
+ /** Five optional symbols displayed in response order from 1 to 5. */
433
+ emojis?: [string, string, string, string, string];
434
+ /** Optional label displayed near the negative reaction. */
435
+ lowLabel?: string;
436
+ /** Optional label displayed near the positive reaction. */
437
+ highLabel?: string;
438
+ }
439
+ /** Configuration for a free-text question. */
440
+ interface SurveyTextQuestionConfig {
441
+ /** Whether the input is rendered as a multiline field. */
442
+ multiline: boolean;
443
+ /** Optional input placeholder. */
444
+ placeholder?: string;
445
+ /** Optional minimum response length. */
446
+ minLength?: number;
447
+ /** Maximum response length. */
448
+ maxLength: number;
449
+ }
450
+ /** Configuration for a single-choice question. */
451
+ interface SurveySingleChoiceQuestionConfig {
452
+ /** Options presented to the respondent. */
453
+ options: SurveyQuestionOption[];
454
+ }
455
+ /** Configuration for a multiple-choice question. */
456
+ interface SurveyMultipleChoiceQuestionConfig {
457
+ /** Minimum number of options that can be selected. */
458
+ minSelections: number;
459
+ /** Maximum number of options that can be selected. */
460
+ maxSelections: number;
461
+ /** Options presented to the respondent. */
462
+ options: SurveyQuestionOption[];
463
+ }
464
+ /** A numeric rating question. */
465
+ interface SurveyRatingQuestion {
466
+ /** Stable identifier for the question. */
467
+ id: string;
468
+ /** Text displayed to the respondent. */
469
+ text: string;
470
+ /** Optional supporting text. */
471
+ description?: string;
472
+ /** Whether an answer is required. */
473
+ required: boolean;
474
+ /** Question input type. */
475
+ type: 'rating';
476
+ /** Input configuration. */
477
+ config: SurveyRatingQuestionConfig;
478
+ }
479
+ /** An emoji reaction question. */
480
+ interface SurveyReactionQuestion {
481
+ /** Stable identifier for the question. */
482
+ id: string;
483
+ /** Text displayed to the respondent. */
484
+ text: string;
485
+ /** Optional supporting text. */
486
+ description?: string;
487
+ /** Whether an answer is required. */
488
+ required: boolean;
489
+ /** Question input type. */
490
+ type: 'reaction';
491
+ /** Input configuration. */
492
+ config: SurveyReactionQuestionConfig;
493
+ }
494
+ /** A free-text question. */
495
+ interface SurveyTextQuestion {
496
+ /** Stable identifier for the question. */
497
+ id: string;
498
+ /** Text displayed to the respondent. */
499
+ text: string;
500
+ /** Optional supporting text. */
501
+ description?: string;
502
+ /** Whether an answer is required. */
503
+ required: boolean;
504
+ /** Question input type. */
505
+ type: 'text';
506
+ /** Input configuration. */
507
+ config: SurveyTextQuestionConfig;
508
+ }
509
+ /** A question that accepts one option. */
510
+ interface SurveySingleChoiceQuestion {
511
+ /** Stable identifier for the question. */
512
+ id: string;
513
+ /** Text displayed to the respondent. */
514
+ text: string;
515
+ /** Optional supporting text. */
516
+ description?: string;
517
+ /** Whether an answer is required. */
518
+ required: boolean;
519
+ /** Question input type. */
520
+ type: 'single_choice';
521
+ /** Input configuration. */
522
+ config: SurveySingleChoiceQuestionConfig;
523
+ }
524
+ /** A question that accepts multiple options. */
525
+ interface SurveyMultipleChoiceQuestion {
526
+ /** Stable identifier for the question. */
527
+ id: string;
528
+ /** Text displayed to the respondent. */
529
+ text: string;
530
+ /** Optional supporting text. */
531
+ description?: string;
532
+ /** Whether an answer is required. */
533
+ required: boolean;
534
+ /** Question input type. */
535
+ type: 'multiple_choice';
536
+ /** Input configuration. */
537
+ config: SurveyMultipleChoiceQuestionConfig;
538
+ }
539
+ /** A question supported by the generic survey payload. */
540
+ type SurveyQuestion = SurveyRatingQuestion | SurveyReactionQuestion | SurveyTextQuestion | SurveySingleChoiceQuestion | SurveyMultipleChoiceQuestion;
541
+ /** Completion content displayed after submitting a survey. */
542
+ interface SurveyCompletion {
543
+ /** Optional message shown after submission. */
544
+ message?: string;
545
+ }
546
+ /** Supported viewport placements for a survey. */
547
+ type SurveyPlacement = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
548
+ /** Rendering options for a survey. */
549
+ interface SurveyAppearance {
550
+ /** Display mode supported by the widget. */
551
+ mode: 'popover';
552
+ /** Viewport corner where the survey is displayed. */
553
+ placement?: SurveyPlacement;
554
+ }
555
+ /** Payload rendered by a survey announcement. */
556
+ interface SurveyAnnouncementPayload {
557
+ /** Schema version used to validate the survey. */
558
+ formatVersion: 1;
559
+ /** Survey title. */
560
+ title: string;
561
+ /** Optional supporting description. */
562
+ description?: string;
563
+ /** Ordered questions displayed to the respondent. */
564
+ questions: SurveyQuestion[];
565
+ /** Optional completion content. */
566
+ completion?: SurveyCompletion;
567
+ /** Survey rendering options. */
568
+ appearance: SurveyAppearance;
569
+ }
570
+ /** Payload rendered by the announcement widget. */
571
+ type AnnouncementPayload = BannerAnnouncementPayload | SurveyAnnouncementPayload;
408
572
  /** URL targeting rule for an announcement. */
409
573
  interface AnnouncementTargetingRuleUrl {
410
574
  /** Matching strategy. */
@@ -418,6 +582,8 @@ interface AnnouncementTargetingRules {
418
582
  allProfiles?: boolean;
419
583
  /** Profile slugs that should see the announcement. */
420
584
  profiles?: string[];
585
+ /** Stable subject UUIDs allowed to see the announcement, limited to 500 by the API. */
586
+ subjectIds?: string[];
421
587
  /** URL-based targeting rule. */
422
588
  url?: AnnouncementTargetingRuleUrl;
423
589
  }
@@ -455,6 +621,8 @@ interface Announcement {
455
621
  payload: AnnouncementPayload;
456
622
  /** Optional expiration ISO date. */
457
623
  expiresAt?: string | null;
624
+ /** Optional ISO date when the announcement becomes active. */
625
+ startsAt?: string | null;
458
626
  /** Creation ISO date. */
459
627
  createdAt: string;
460
628
  /** Last update ISO date. */
@@ -504,6 +672,8 @@ interface CreateAnnouncementRequest {
504
672
  allCompanies: boolean;
505
673
  /** Optional expiration ISO date. */
506
674
  expiresAt?: string | null;
675
+ /** Optional ISO date when the announcement becomes active. */
676
+ startsAt?: string | null;
507
677
  /** Renderable payload. */
508
678
  payload: AnnouncementPayload;
509
679
  /** Company UUIDs allowed to see the announcement when allCompanies is false. */
@@ -523,6 +693,8 @@ interface UpdateAnnouncementRequest {
523
693
  allCompanies: boolean;
524
694
  /** Optional expiration ISO date. */
525
695
  expiresAt?: string | null;
696
+ /** Optional ISO date when the announcement becomes active. */
697
+ startsAt?: string | null;
526
698
  /** Renderable payload. */
527
699
  payload: AnnouncementPayload;
528
700
  /** Company UUIDs allowed to see the announcement when allCompanies is false. */
@@ -537,19 +709,146 @@ interface UpdateAnnouncementStatusRequest {
537
709
  }
538
710
  /** Query parameters for the active announcements widget endpoint. */
539
711
  interface ActiveAnnouncementQuery {
712
+ /** Stable subject UUID used to return only unanswered surveys. */
713
+ id?: string;
714
+ /** Optional subject name received from identify. */
715
+ name?: string;
716
+ /** Optional subject email received from identify. */
717
+ email?: string;
718
+ /** Optional subject phone received from identify. */
719
+ phone?: string;
540
720
  /** Current page URL used for URL targeting rules. */
541
721
  url?: string;
542
722
  /** User profile slug used for profile targeting rules. */
543
723
  profile?: string;
544
724
  }
545
- /** Slim announcement payload returned by the active endpoint (widget). */
546
- interface ActiveAnnouncement {
725
+ /** Active banner returned by the widget endpoint. */
726
+ interface ActiveBannerAnnouncement {
547
727
  /** Unique identifier. */
548
728
  id: string;
549
- /** Announcement type slug. */
550
- type?: string;
551
- /** Renderable payload. */
552
- payload: AnnouncementPayload;
729
+ /** Banner announcement discriminator. */
730
+ type: 'banner';
731
+ /** Banner payload rendered by the widget. */
732
+ payload: BannerAnnouncementPayload;
733
+ }
734
+ /** Active survey returned by the widget endpoint. */
735
+ interface ActiveSurveyAnnouncement {
736
+ /** Unique identifier. */
737
+ id: string;
738
+ /** Survey announcement discriminator. */
739
+ type: 'survey';
740
+ /** Survey payload rendered by the widget. */
741
+ payload: SurveyAnnouncementPayload;
742
+ }
743
+ /** Announcement returned by the active widget endpoint. */
744
+ type ActiveAnnouncement = ActiveBannerAnnouncement | ActiveSurveyAnnouncement;
745
+
746
+ /** A value submitted for a survey question. */
747
+ type SurveyAnswerValue = number | string | string[];
748
+ /** An answer submitted for one survey question. */
749
+ interface SurveyAnswer {
750
+ /** Identifier of the answered question. */
751
+ questionId: string;
752
+ /** Value submitted for the question. */
753
+ value: SurveyAnswerValue;
754
+ }
755
+ /** Request payload for submitting a survey response. */
756
+ interface CreateSurveyResponseRequest {
757
+ /** Stable identifier of the subject answering the survey. */
758
+ subjectId: string;
759
+ /** Optional subject name captured at submission time. */
760
+ subjectName?: string;
761
+ /** Optional subject profile captured at submission time. */
762
+ subjectProfile?: string;
763
+ /** Answers submitted by the subject. */
764
+ answers: SurveyAnswer[];
765
+ }
766
+ /** A selected choice persisted for a survey response answer. */
767
+ interface SurveyResponseAnswerOption {
768
+ /** Unique selected-option record identifier. */
769
+ id: string;
770
+ /** Identifier of the owning answer record. */
771
+ answerId: string;
772
+ /** Stable identifier of the option from the survey payload. */
773
+ optionId: string;
774
+ /** Machine-readable option value captured at submission time. */
775
+ optionValue: string;
776
+ /** Display label captured at submission time. */
777
+ optionLabel: string;
778
+ /** One-based option position in the survey payload. */
779
+ optionPosition: number;
780
+ /** ISO date when the selected option was created. */
781
+ createdAt: string;
782
+ /** ISO date when the selected option was last updated. */
783
+ updatedAt: string;
784
+ }
785
+ /** Normalized answer persisted for one survey question. */
786
+ interface SurveyResponseAnswer {
787
+ /** Unique answer record identifier. */
788
+ id: string;
789
+ /** Identifier of the owning survey response. */
790
+ responseId: string;
791
+ /** Stable identifier of the question from the survey payload. */
792
+ questionId: string;
793
+ /** Question type captured at submission time. */
794
+ questionType: SurveyQuestion['type'];
795
+ /** One-based question position in the survey payload. */
796
+ questionPosition: number;
797
+ /** Question text captured at submission time. */
798
+ questionText: string;
799
+ /** Whether the question was required at submission time. */
800
+ questionRequired: boolean;
801
+ /** Whether the subject supplied a meaningful answer. */
802
+ answered: boolean;
803
+ /** Original answer value, or null when the question was skipped. */
804
+ rawValue: SurveyAnswerValue | null;
805
+ /** Numeric projection used by rating and reaction reports. */
806
+ numericValue: number | null;
807
+ /** Text projection used by free-text reports. */
808
+ textValue: string | null;
809
+ /** Options selected for single-choice or multiple-choice questions. */
810
+ selectedOptions: SurveyResponseAnswerOption[];
811
+ /** ISO date when the normalized answer was created. */
812
+ createdAt: string;
813
+ /** ISO date when the normalized answer was last updated. */
814
+ updatedAt: string;
815
+ }
816
+ /** A persisted response to a survey announcement. */
817
+ interface SurveyResponse {
818
+ /** Unique response identifier. */
819
+ id: string;
820
+ /** Identifier of the answered survey announcement. */
821
+ announcementId: string;
822
+ /** Identifier of the authenticated company. */
823
+ companyId: string;
824
+ /** Stable identifier of the responding subject. */
825
+ subjectId: string;
826
+ /** Subject name captured at submission time. */
827
+ subjectName: string | null;
828
+ /** Subject profile captured at submission time. */
829
+ subjectProfile: string | null;
830
+ /** Normalized records for every survey question. */
831
+ answers: SurveyResponseAnswer[];
832
+ /** ISO date when the response was submitted. */
833
+ submittedAt: string;
834
+ /** ISO date when the response was created. */
835
+ createdAt: string;
836
+ /** ISO date when the response was last updated. */
837
+ updatedAt: string;
838
+ }
839
+ /** Query parameters for the administrative survey-response list. */
840
+ interface SurveyResponseListFilters {
841
+ /** One-based page number. */
842
+ page?: number;
843
+ /** Maximum number of responses per page. */
844
+ limit?: number;
845
+ }
846
+ /** Paginated responses returned for a survey announcement. */
847
+ interface SurveyResponseListResponse {
848
+ /** Total matching responses. */
849
+ count: number;
850
+ /** Responses for the requested page. */
851
+ rows: SurveyResponse[];
553
852
  }
554
853
 
555
854
  /** Request payload for generating a two-factor OTP secret URL. */
@@ -570,4 +869,4 @@ interface ValidateTwoFactorOtpResponse {
570
869
  validate: boolean;
571
870
  }
572
871
 
573
- 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 };
872
+ 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 };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/customer-service/contracts/index.ts"],"sourcesContent":["export * from './work-group';\nexport * from './company';\nexport * from './company-config';\nexport * from './company-queue';\nexport * from './user';\nexport * from './announcement';\nexport * from './authenticate';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../../../src/customer-service/contracts/index.ts"],"sourcesContent":["export * from './work-group';\nexport * from './company';\nexport * from './company-config';\nexport * from './company-queue';\nexport * from './user';\nexport * from './announcement';\nexport * from './survey-response';\nexport * from './authenticate';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/dist/index.d.mts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { AxiosInstance } from 'axios';
2
- import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, UpdateCompanyJsonConfigRequest, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, ListUsersRequest, ListUsersResponse, WorkGroupListResponse, WorkGroupResponse, UserProfile, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.mjs';
3
- export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ListUsersInclude, ListUsersProfile, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, UserBond, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
2
+ import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, UpdateCompanyJsonConfigRequest, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, ListUsersRequest, ListUsersResponse, WorkGroupListResponse, WorkGroupResponse, UserProfile, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement, CreateSurveyResponseRequest, SurveyResponse, SurveyResponseListFilters, SurveyResponseListResponse } from './customer-service/contracts/index.mjs';
3
+ export { ActiveBannerAnnouncement, ActiveSurveyAnnouncement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, BannerAnnouncementPayload, CompanyData, ListUsersInclude, ListUsersProfile, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, SurveyAnnouncementPayload, SurveyAnswer, SurveyAnswerValue, SurveyAppearance, SurveyCompletion, SurveyMultipleChoiceQuestion, SurveyMultipleChoiceQuestionConfig, SurveyPlacement, SurveyQuestion, SurveyQuestionOption, SurveyRatingQuestion, SurveyRatingQuestionConfig, SurveyReactionQuestion, SurveyReactionQuestionConfig, SurveyResponseAnswer, SurveyResponseAnswerOption, SurveySingleChoiceQuestion, SurveySingleChoiceQuestionConfig, SurveyTextQuestion, SurveyTextQuestionConfig, UserBond, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
4
4
  import { ProviderListResponse, Config, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRuleByIdRequest, RuleResponse, GetRootRulesRequest, RootRulesResponse, GetRulesRequest, RulesResponse, GetRulesCountRequest, RulesCountResponse } from './chat-config/contracts/index.mjs';
5
5
  export { ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, RuleCallOnQueue, RuleFlowSettings, RuleFlowTextResponse, RuleHttpMethod, RuleInteractiveType, RuleQuestionnaire, RuleQuestionnaireBodyField, RuleQuestionnaireHeader, RuleQuestionnaireInteractiveOption, RuleQuestionnaireQuestion, RuleQuestionnaireQuestionType, RuleQuestionnaireValidationAction, RuleQuestionnaireValidationRegexType, RuleSettings, RuleWebhook, RuleWebhookHeader, RuleWebhookResponseMapping, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.mjs';
6
6
  import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.mjs';
@@ -227,6 +227,20 @@ declare class CustomerServiceGateway {
227
227
  * @returns The active announcements for the widget.
228
228
  */
229
229
  findActiveAnnouncements(query: ActiveAnnouncementQuery): Promise<ActiveAnnouncement[]>;
230
+ /**
231
+ * Submits one response to a survey announcement.
232
+ * @param announcementId - The unique identifier of the survey announcement.
233
+ * @param payload - The subject identifier and validated survey answers.
234
+ * @returns The persisted survey response.
235
+ */
236
+ submitSurveyResponse(announcementId: string, payload: CreateSurveyResponseRequest): Promise<SurveyResponse>;
237
+ /**
238
+ * Retrieves paginated responses for a survey announcement.
239
+ * @param announcementId - The unique identifier of the survey announcement.
240
+ * @param query - Pagination options for the administrative list.
241
+ * @returns Paginated survey responses.
242
+ */
243
+ findSurveyResponses(announcementId: string, query?: SurveyResponseListFilters): Promise<SurveyResponseListResponse>;
230
244
  }
231
245
 
232
246
  /**
@@ -1023,4 +1037,4 @@ declare const configure: (params: GatewayClientParams) => void;
1023
1037
  */
1024
1038
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
1025
1039
 
1026
- export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseStatus, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCaseStatusRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, RuleResponse, RulesCountResponse, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
1040
+ export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseStatus, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCaseStatusRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateSurveyResponseRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, RuleResponse, RulesCountResponse, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, SurveyResponse, SurveyResponseListFilters, SurveyResponseListResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { AxiosInstance } from 'axios';
2
- import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, UpdateCompanyJsonConfigRequest, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, ListUsersRequest, ListUsersResponse, WorkGroupListResponse, WorkGroupResponse, UserProfile, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.js';
3
- export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ListUsersInclude, ListUsersProfile, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, UserBond, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
2
+ import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, UpdateCompanyJsonConfigRequest, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, ListUsersRequest, ListUsersResponse, WorkGroupListResponse, WorkGroupResponse, UserProfile, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement, CreateSurveyResponseRequest, SurveyResponse, SurveyResponseListFilters, SurveyResponseListResponse } from './customer-service/contracts/index.js';
3
+ export { ActiveBannerAnnouncement, ActiveSurveyAnnouncement, AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, BannerAnnouncementPayload, CompanyData, ListUsersInclude, ListUsersProfile, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, SurveyAnnouncementPayload, SurveyAnswer, SurveyAnswerValue, SurveyAppearance, SurveyCompletion, SurveyMultipleChoiceQuestion, SurveyMultipleChoiceQuestionConfig, SurveyPlacement, SurveyQuestion, SurveyQuestionOption, SurveyRatingQuestion, SurveyRatingQuestionConfig, SurveyReactionQuestion, SurveyReactionQuestionConfig, SurveyResponseAnswer, SurveyResponseAnswerOption, SurveySingleChoiceQuestion, SurveySingleChoiceQuestionConfig, SurveyTextQuestion, SurveyTextQuestionConfig, UserBond, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
4
4
  import { ProviderListResponse, Config, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRuleByIdRequest, RuleResponse, GetRootRulesRequest, RootRulesResponse, GetRulesRequest, RulesResponse, GetRulesCountRequest, RulesCountResponse } from './chat-config/contracts/index.js';
5
5
  export { ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, RuleCallOnQueue, RuleFlowSettings, RuleFlowTextResponse, RuleHttpMethod, RuleInteractiveType, RuleQuestionnaire, RuleQuestionnaireBodyField, RuleQuestionnaireHeader, RuleQuestionnaireInteractiveOption, RuleQuestionnaireQuestion, RuleQuestionnaireQuestionType, RuleQuestionnaireValidationAction, RuleQuestionnaireValidationRegexType, RuleSettings, RuleWebhook, RuleWebhookHeader, RuleWebhookResponseMapping, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.js';
6
6
  import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.js';
@@ -227,6 +227,20 @@ declare class CustomerServiceGateway {
227
227
  * @returns The active announcements for the widget.
228
228
  */
229
229
  findActiveAnnouncements(query: ActiveAnnouncementQuery): Promise<ActiveAnnouncement[]>;
230
+ /**
231
+ * Submits one response to a survey announcement.
232
+ * @param announcementId - The unique identifier of the survey announcement.
233
+ * @param payload - The subject identifier and validated survey answers.
234
+ * @returns The persisted survey response.
235
+ */
236
+ submitSurveyResponse(announcementId: string, payload: CreateSurveyResponseRequest): Promise<SurveyResponse>;
237
+ /**
238
+ * Retrieves paginated responses for a survey announcement.
239
+ * @param announcementId - The unique identifier of the survey announcement.
240
+ * @param query - Pagination options for the administrative list.
241
+ * @returns Paginated survey responses.
242
+ */
243
+ findSurveyResponses(announcementId: string, query?: SurveyResponseListFilters): Promise<SurveyResponseListResponse>;
230
244
  }
231
245
 
232
246
  /**
@@ -1023,4 +1037,4 @@ declare const configure: (params: GatewayClientParams) => void;
1023
1037
  */
1024
1038
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
1025
1039
 
1026
- export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseStatus, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCaseStatusRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, RuleResponse, RulesCountResponse, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
1040
+ export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseStatus, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCaseStatusRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateSurveyResponseRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, RuleResponse, RulesCountResponse, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, SurveyResponse, SurveyResponseListFilters, SurveyResponseListResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
package/dist/index.js CHANGED
@@ -388,6 +388,32 @@ var CustomerServiceGateway = class {
388
388
  });
389
389
  return data;
390
390
  }
391
+ /**
392
+ * Submits one response to a survey announcement.
393
+ * @param announcementId - The unique identifier of the survey announcement.
394
+ * @param payload - The subject identifier and validated survey answers.
395
+ * @returns The persisted survey response.
396
+ */
397
+ async submitSurveyResponse(announcementId, payload) {
398
+ const { data } = await this.httpClient.post(
399
+ `${this.baseUrl}/announcements/${announcementId}/responses`,
400
+ payload
401
+ );
402
+ return data;
403
+ }
404
+ /**
405
+ * Retrieves paginated responses for a survey announcement.
406
+ * @param announcementId - The unique identifier of the survey announcement.
407
+ * @param query - Pagination options for the administrative list.
408
+ * @returns Paginated survey responses.
409
+ */
410
+ async findSurveyResponses(announcementId, query) {
411
+ const { data } = await this.httpClient.get(
412
+ `${this.baseUrl}/announcements/admin/${announcementId}/responses`,
413
+ { params: query }
414
+ );
415
+ return data;
416
+ }
391
417
  };
392
418
 
393
419
  // src/chat-config/index.ts