@parra/parra-js-sdk 0.3.240 → 0.3.242

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.
@@ -601,32 +601,25 @@ export interface TenantPlansResponse {
601
601
  export interface BillingPortalSession {
602
602
  url: string;
603
603
  }
604
- export interface CreateSubscriberRequestBody {
604
+ export interface CreateEmailSubscriberRequestBody {
605
605
  email: string;
606
606
  }
607
- export interface SubmitFeedbackFormResponseBody {
608
- }
609
- export interface FeedbackFormSubmission {
607
+ export interface AppFaq {
610
608
  id: string;
611
609
  created_at: string;
612
610
  updated_at: string;
613
611
  deleted_at?: string | null;
614
- feedback_form_id: string;
615
- user_id: string;
616
- data: SubmitFeedbackFormResponseBody;
617
- }
618
- export interface CollectionResponse {
619
- page: number;
620
- page_count: number;
621
- page_size: number;
622
- total_count: number;
612
+ title: string;
613
+ body: string;
623
614
  }
624
- export interface FeedbackFormSubmissionCollectionResponse {
625
- page: number;
626
- page_count: number;
627
- page_size: number;
628
- total_count: number;
629
- data: Array<FeedbackFormSubmission>;
615
+ export interface AppFaqSection {
616
+ id: string;
617
+ created_at: string;
618
+ updated_at: string;
619
+ deleted_at?: string | null;
620
+ title?: string | null;
621
+ description?: string | null;
622
+ items: Array<AppFaq>;
630
623
  }
631
624
  export declare enum FeedbackFormFieldType {
632
625
  text = "text",
@@ -674,6 +667,179 @@ export interface FeedbackFormDataStub {
674
667
  deleted_at?: string | null;
675
668
  data: FeedbackFormData;
676
669
  }
670
+ export interface AppFaqView {
671
+ id: string;
672
+ created_at: string;
673
+ updated_at: string;
674
+ deleted_at?: string | null;
675
+ tenant_id: string;
676
+ title?: string | null;
677
+ description?: string | null;
678
+ app_area_id?: string | null;
679
+ feedback_form_id?: string | null;
680
+ sections: Array<AppFaqSection>;
681
+ feedback_form?: FeedbackFormDataStub | null;
682
+ }
683
+ export interface UpdateFaqViewRequestBody {
684
+ title: string;
685
+ display_title?: string | null;
686
+ slug: string;
687
+ description?: string | null;
688
+ display_description?: string | null;
689
+ app_area_id?: string | null;
690
+ feedback_form_id?: string | null;
691
+ }
692
+ export interface CreateFaqViewRequestBody {
693
+ title: string;
694
+ display_title?: string | null;
695
+ slug: string;
696
+ description?: string | null;
697
+ display_description?: string | null;
698
+ app_area_id?: string | null;
699
+ feedback_form_id?: string | null;
700
+ }
701
+ export interface FaqSection {
702
+ id: string;
703
+ created_at: string;
704
+ updated_at: string;
705
+ deleted_at?: string | null;
706
+ tenant_id: string;
707
+ title: string;
708
+ display_title?: string | null;
709
+ description?: string | null;
710
+ display_description?: string | null;
711
+ }
712
+ export interface FaqView {
713
+ id: string;
714
+ created_at: string;
715
+ updated_at: string;
716
+ deleted_at?: string | null;
717
+ title: string;
718
+ display_title?: string | null;
719
+ slug: string;
720
+ description?: string | null;
721
+ display_description?: string | null;
722
+ app_area_id?: string | null;
723
+ feedback_form_id?: string | null;
724
+ tenant_id: string;
725
+ sections: Array<FaqSection>;
726
+ }
727
+ export interface UpdateFaqRequestBody {
728
+ title: string;
729
+ body: string;
730
+ }
731
+ export interface CreateFaqRequestBody {
732
+ title: string;
733
+ body: string;
734
+ faq_section_id?: string | null;
735
+ }
736
+ export interface Faq {
737
+ id: string;
738
+ created_at: string;
739
+ updated_at: string;
740
+ deleted_at?: string | null;
741
+ tenant_id: string;
742
+ title: string;
743
+ body: string;
744
+ }
745
+ export interface CollectionResponse {
746
+ page: number;
747
+ page_count: number;
748
+ page_size: number;
749
+ total_count: number;
750
+ }
751
+ export interface FaqCollectionResponse {
752
+ page: number;
753
+ page_count: number;
754
+ page_size: number;
755
+ total_count: number;
756
+ data: Array<Faq>;
757
+ }
758
+ export interface UpdateFaqSectionRequestBody {
759
+ title: string;
760
+ display_title?: string | null;
761
+ description?: string | null;
762
+ display_description?: string | null;
763
+ }
764
+ export interface CreateFaqSectionRequestBody {
765
+ title: string;
766
+ display_title?: string | null;
767
+ description?: string | null;
768
+ display_description?: string | null;
769
+ }
770
+ export declare enum FeedItemType {
771
+ youtubeVideo = "youtube_video",
772
+ contentCard = "content_card"
773
+ }
774
+ export interface YoutubeThumbnail {
775
+ url: string;
776
+ width: number;
777
+ height: number;
778
+ }
779
+ export interface YoutubeThumbnails {
780
+ default: YoutubeThumbnail;
781
+ medium: YoutubeThumbnail;
782
+ high: YoutubeThumbnail;
783
+ standard: YoutubeThumbnail;
784
+ maxres: YoutubeThumbnail;
785
+ }
786
+ export interface FeedItemYoutubeVideoData {
787
+ video_id: string;
788
+ title: string;
789
+ channel_title: string;
790
+ channel_id: string;
791
+ description?: string;
792
+ thumbnails: YoutubeThumbnails;
793
+ published_at: string;
794
+ live_broadcast_content: string;
795
+ }
796
+ export interface ContentCardAction {
797
+ url: string;
798
+ }
799
+ export interface ContentCard {
800
+ id: string;
801
+ created_at: string;
802
+ updated_at: string;
803
+ deleted_at?: string | null;
804
+ background_image: ImageAssetStub;
805
+ title?: string | null;
806
+ description?: string | null;
807
+ action?: ContentCardAction | null;
808
+ }
809
+ export type FeedItemData = FeedItemYoutubeVideoData | ContentCard;
810
+ export interface FeedItem {
811
+ id: string;
812
+ created_at: string;
813
+ updated_at: string;
814
+ deleted_at?: string | null;
815
+ type: FeedItemType;
816
+ data: FeedItemData;
817
+ }
818
+ export interface FeedItemCollectionResponse {
819
+ page: number;
820
+ page_count: number;
821
+ page_size: number;
822
+ total_count: number;
823
+ data: Array<FeedItem>;
824
+ }
825
+ export interface SubmitFeedbackFormResponseBody {
826
+ }
827
+ export interface FeedbackFormSubmission {
828
+ id: string;
829
+ created_at: string;
830
+ updated_at: string;
831
+ deleted_at?: string | null;
832
+ feedback_form_id: string;
833
+ user_id: string;
834
+ data: SubmitFeedbackFormResponseBody;
835
+ }
836
+ export interface FeedbackFormSubmissionCollectionResponse {
837
+ page: number;
838
+ page_count: number;
839
+ page_size: number;
840
+ total_count: number;
841
+ data: Array<FeedbackFormSubmission>;
842
+ }
677
843
  export declare enum QuestionType {
678
844
  choice = "choice",
679
845
  checkbox = "checkbox",
@@ -2955,7 +3121,29 @@ declare class ParraAPI {
2955
3121
  createCheckoutSession: (body: CreateCheckoutSessionRequestBody, options?: Options) => Promise<CheckoutSession>;
2956
3122
  getPlansForTenantById: (tenant_id: string, options?: Options) => Promise<TenantPlansResponse>;
2957
3123
  createBillingPortalSession: (tenant_id: string, options?: Options) => Promise<BillingPortalSession>;
2958
- createSubscriberForAudienceById: (audience_id: string, body: CreateSubscriberRequestBody, options?: Options) => Promise<Response>;
3124
+ createSubscriberForEmailAudienceById: (email_audience_id: string, body: CreateEmailSubscriberRequestBody, options?: Options) => Promise<Response>;
3125
+ listAppFaqs: (tenant_id: string, application_id: string, query?: {
3126
+ app_area_id?: string;
3127
+ }, options?: Options) => Promise<AppFaqView>;
3128
+ createFaqView: (tenant_id: string, body?: CreateFaqViewRequestBody, options?: Options) => Promise<FaqView>;
3129
+ listFaqViews: (tenant_id: string, options?: Options) => Promise<Array<FaqView>>;
3130
+ getFaqViewById: (tenant_id: string, faq_view_id: string, options?: Options) => Promise<FaqView>;
3131
+ updateFaqViewById: (tenant_id: string, faq_view_id: string, body: UpdateFaqViewRequestBody, options?: Options) => Promise<FaqView>;
3132
+ deleteFaqViewById: (tenant_id: string, faq_view_id: string, options?: Options) => Promise<Response>;
3133
+ createFaq: (tenant_id: string, body?: CreateFaqRequestBody, options?: Options) => Promise<Faq>;
3134
+ listFaqs: (tenant_id: string, options?: Options) => Promise<FaqCollectionResponse>;
3135
+ getFaqById: (tenant_id: string, faq_id: string, options?: Options) => Promise<Faq>;
3136
+ updateFaqById: (tenant_id: string, faq_id: string, body: UpdateFaqRequestBody, options?: Options) => Promise<Faq>;
3137
+ deleteFaqById: (tenant_id: string, faq_id: string, options?: Options) => Promise<Response>;
3138
+ createFaqSection: (tenant_id: string, faq_view_id: string, body?: CreateFaqSectionRequestBody, options?: Options) => Promise<FaqSection>;
3139
+ listFaqSections: (tenant_id: string, faq_view_id: string, options?: Options) => Promise<Array<FaqSection>>;
3140
+ getFaqSectionById: (tenant_id: string, faq_view_id: string, faq_section_id: string, options?: Options) => Promise<FaqSection>;
3141
+ updateFaqSectionById: (tenant_id: string, faq_view_id: string, faq_section_id: string, body: UpdateFaqSectionRequestBody, options?: Options) => Promise<FaqSection>;
3142
+ deleteFaqSectionById: (tenant_id: string, faq_view_id: string, faq_section_id: string, options?: Options) => Promise<Response>;
3143
+ getItemsForAppFeed: (tenant_id: string, application_id: string, feed_id_or_slug: string, query?: {
3144
+ limit?: number;
3145
+ offset?: number;
3146
+ }, options?: Options) => Promise<FeedItemCollectionResponse>;
2959
3147
  paginateFeedbackFormResponsesForTenantUser: (tenant_id: string, user_id: string, query?: {
2960
3148
  $select?: string;
2961
3149
  $top?: number;
package/dist/ParraAPI.js CHANGED
@@ -11,7 +11,7 @@ var __assign = (this && this.__assign) || function () {
11
11
  return __assign.apply(this, arguments);
12
12
  };
13
13
  Object.defineProperty(exports, "__esModule", { value: true });
14
- exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.PasswordlessStrategy = exports.ApnsPushType = exports.ApnsEnvironment = exports.ChannelType = exports.AppVersionStatus = exports.TicketDisplayStatus = exports.UserNoteStatus = exports.TemplateType = exports.CampaignStatus = exports.CampaignActionDisplayType = exports.CampaignActionType = exports.CardItemDisplayType = exports.CardItemType = exports.QuestionKind = exports.QuestionType = exports.FeedbackFormFieldType = exports.SubscriptionStatus = exports.Interval = exports.Currency = exports.IdentityType = exports.PolicyDocumentType = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
14
+ exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.PasswordlessStrategy = exports.ApnsPushType = exports.ApnsEnvironment = exports.ChannelType = exports.AppVersionStatus = exports.TicketDisplayStatus = exports.UserNoteStatus = exports.TemplateType = exports.CampaignStatus = exports.CampaignActionDisplayType = exports.CampaignActionType = exports.CardItemDisplayType = exports.CardItemType = exports.QuestionKind = exports.QuestionType = exports.FeedItemType = exports.FeedbackFormFieldType = exports.SubscriptionStatus = exports.Interval = exports.Currency = exports.IdentityType = exports.PolicyDocumentType = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
15
15
  var TicketType;
16
16
  (function (TicketType) {
17
17
  TicketType["bug"] = "bug";
@@ -118,6 +118,11 @@ var FeedbackFormFieldType;
118
118
  FeedbackFormFieldType["input"] = "input";
119
119
  FeedbackFormFieldType["select"] = "select";
120
120
  })(FeedbackFormFieldType || (exports.FeedbackFormFieldType = FeedbackFormFieldType = {}));
121
+ var FeedItemType;
122
+ (function (FeedItemType) {
123
+ FeedItemType["youtubeVideo"] = "youtube_video";
124
+ FeedItemType["contentCard"] = "content_card";
125
+ })(FeedItemType || (exports.FeedItemType = FeedItemType = {}));
121
126
  var QuestionType;
122
127
  (function (QuestionType) {
123
128
  QuestionType["choice"] = "choice";
@@ -438,12 +443,92 @@ var ParraAPI = /** @class */ (function () {
438
443
  if (options === void 0) { options = {}; }
439
444
  return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/billing-portal/sessions"), __assign({ method: "post" }, options));
440
445
  };
441
- this.createSubscriberForAudienceById = function (audience_id, body, options) {
446
+ this.createSubscriberForEmailAudienceById = function (email_audience_id, body, options) {
442
447
  if (options === void 0) { options = {}; }
443
- return _this.http.execute("".concat(_this.options.baseUrl, "/v1/email/audiences/").concat(audience_id, "/subscribers"), __assign({ method: "post", body: JSON.stringify(body), headers: {
448
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/email/audiences/").concat(email_audience_id, "/subscribers"), __assign({ method: "post", body: JSON.stringify(body), headers: {
444
449
  "content-type": "application/json",
445
450
  }, raw: true }, options));
446
451
  };
452
+ this.listAppFaqs = function (tenant_id, application_id, query, options) {
453
+ if (options === void 0) { options = {}; }
454
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/applications/").concat(application_id, "/faqs"), __assign({ method: "get", query: query }, options));
455
+ };
456
+ this.createFaqView = function (tenant_id, body, options) {
457
+ if (options === void 0) { options = {}; }
458
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views"), __assign({ method: "post", body: JSON.stringify(body), headers: {
459
+ "content-type": "application/json",
460
+ } }, options));
461
+ };
462
+ this.listFaqViews = function (tenant_id, options) {
463
+ if (options === void 0) { options = {}; }
464
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views"), __assign({ method: "get" }, options));
465
+ };
466
+ this.getFaqViewById = function (tenant_id, faq_view_id, options) {
467
+ if (options === void 0) { options = {}; }
468
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views/").concat(faq_view_id), __assign({ method: "get" }, options));
469
+ };
470
+ this.updateFaqViewById = function (tenant_id, faq_view_id, body, options) {
471
+ if (options === void 0) { options = {}; }
472
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views/").concat(faq_view_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
473
+ "content-type": "application/json",
474
+ } }, options));
475
+ };
476
+ this.deleteFaqViewById = function (tenant_id, faq_view_id, options) {
477
+ if (options === void 0) { options = {}; }
478
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views/").concat(faq_view_id), __assign({ method: "delete" }, options));
479
+ };
480
+ this.createFaq = function (tenant_id, body, options) {
481
+ if (options === void 0) { options = {}; }
482
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs"), __assign({ method: "post", body: JSON.stringify(body), headers: {
483
+ "content-type": "application/json",
484
+ } }, options));
485
+ };
486
+ this.listFaqs = function (tenant_id, options) {
487
+ if (options === void 0) { options = {}; }
488
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs"), __assign({ method: "get" }, options));
489
+ };
490
+ this.getFaqById = function (tenant_id, faq_id, options) {
491
+ if (options === void 0) { options = {}; }
492
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/").concat(faq_id), __assign({ method: "get" }, options));
493
+ };
494
+ this.updateFaqById = function (tenant_id, faq_id, body, options) {
495
+ if (options === void 0) { options = {}; }
496
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/").concat(faq_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
497
+ "content-type": "application/json",
498
+ } }, options));
499
+ };
500
+ this.deleteFaqById = function (tenant_id, faq_id, options) {
501
+ if (options === void 0) { options = {}; }
502
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/").concat(faq_id), __assign({ method: "delete" }, options));
503
+ };
504
+ this.createFaqSection = function (tenant_id, faq_view_id, body, options) {
505
+ if (options === void 0) { options = {}; }
506
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views/").concat(faq_view_id, "/sections"), __assign({ method: "post", body: JSON.stringify(body), headers: {
507
+ "content-type": "application/json",
508
+ } }, options));
509
+ };
510
+ this.listFaqSections = function (tenant_id, faq_view_id, options) {
511
+ if (options === void 0) { options = {}; }
512
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views/").concat(faq_view_id, "/sections"), __assign({ method: "get" }, options));
513
+ };
514
+ this.getFaqSectionById = function (tenant_id, faq_view_id, faq_section_id, options) {
515
+ if (options === void 0) { options = {}; }
516
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views/").concat(faq_view_id, "/sections/").concat(faq_section_id), __assign({ method: "get" }, options));
517
+ };
518
+ this.updateFaqSectionById = function (tenant_id, faq_view_id, faq_section_id, body, options) {
519
+ if (options === void 0) { options = {}; }
520
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views/").concat(faq_view_id, "/sections/").concat(faq_section_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
521
+ "content-type": "application/json",
522
+ } }, options));
523
+ };
524
+ this.deleteFaqSectionById = function (tenant_id, faq_view_id, faq_section_id, options) {
525
+ if (options === void 0) { options = {}; }
526
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views/").concat(faq_view_id, "/sections/").concat(faq_section_id), __assign({ method: "delete" }, options));
527
+ };
528
+ this.getItemsForAppFeed = function (tenant_id, application_id, feed_id_or_slug, query, options) {
529
+ if (options === void 0) { options = {}; }
530
+ return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/applications/").concat(application_id, "/feeds/").concat(feed_id_or_slug, "/items"), __assign({ method: "get", query: query }, options));
531
+ };
447
532
  this.paginateFeedbackFormResponsesForTenantUser = function (tenant_id, user_id, query, options) {
448
533
  if (options === void 0) { options = {}; }
449
534
  return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/users/").concat(user_id, "/feedback/form/responses"), __assign({ method: "get", query: query }, options));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@parra/parra-js-sdk",
3
- "version": "0.3.240",
3
+ "version": "0.3.242",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",