@parra/parra-js-sdk 0.3.621 → 0.3.623

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/ParraAPI.d.ts +43 -3
  2. package/dist/ParraAPI.js +31 -7
  3. package/package.json +1 -1
package/dist/ParraAPI.d.ts CHANGED
@@ -733,6 +733,20 @@ export interface ContentCardCollectionResponse {
733
733
  total_count: number;
734
734
  data: Array<ContentCard>;
735
735
  }
736
+ export declare enum SiteIconType {
737
+ icon = "icon",
738
+ favicon = "favicon",
739
+ appleIcon = "apple-icon"
740
+ }
741
+ export interface SiteIcon {
742
+ id: string;
743
+ created_at: string;
744
+ updated_at: string;
745
+ deleted_at?: string | null;
746
+ type: SiteIconType;
747
+ size: number;
748
+ image: ImageAssetStub;
749
+ }
736
750
  export interface FeaturedApplicationLink {
737
751
  title: string;
738
752
  href: string;
@@ -780,6 +794,25 @@ export interface Link {
780
794
  export interface CreateEmailSubscriberRequestBody {
781
795
  email: string;
782
796
  }
797
+ export interface SiteIconStub {
798
+ id: string;
799
+ type: SiteIconType;
800
+ size: number;
801
+ image: ImageAssetStub;
802
+ }
803
+ export interface SiteStub {
804
+ id: string;
805
+ tenant_id: string;
806
+ name: string;
807
+ description: string;
808
+ }
809
+ export interface Site {
810
+ id: string;
811
+ tenant_id: string;
812
+ name: string;
813
+ description: string;
814
+ icons: Array<SiteIconStub>;
815
+ }
783
816
  export declare enum TagPool {
784
817
  content = "content"
785
818
  }
@@ -1099,6 +1132,9 @@ export declare enum ContentType {
1099
1132
  rssItem = "rss_item",
1100
1133
  article = "article"
1101
1134
  }
1135
+ export declare enum VideoType {
1136
+ youtube = "youtube"
1137
+ }
1102
1138
  export interface EntitlementStub {
1103
1139
  id: string;
1104
1140
  title: string;
@@ -1160,6 +1196,7 @@ export interface AppVideoFeedStub {
1160
1196
  published_at: string;
1161
1197
  live_broadcast_content?: string | null;
1162
1198
  statistics?: YoutubeStatistics | null;
1199
+ type: VideoType;
1163
1200
  slug?: string | null;
1164
1201
  paywall?: AppPaywallConfiguration | null;
1165
1202
  tags?: Array<TagStub>;
@@ -3855,9 +3892,6 @@ export interface CreateYoutubeVideoRequestBody {
3855
3892
  youtube_video_url?: string | null;
3856
3893
  }
3857
3894
  export type CreateVideoRequestBody = CreateYoutubeVideoRequestBody;
3858
- export declare enum VideoType {
3859
- youtube = "youtube"
3860
- }
3861
3895
  export interface VideoStub {
3862
3896
  id: string;
3863
3897
  created_at: string;
@@ -3933,6 +3967,7 @@ export interface AppVideoStub {
3933
3967
  published_at: string;
3934
3968
  live_broadcast_content?: string | null;
3935
3969
  statistics?: YoutubeStatistics | null;
3970
+ type: VideoType;
3936
3971
  slug?: string | null;
3937
3972
  paywall?: AppPaywallConfiguration | null;
3938
3973
  tags?: Array<TagStub>;
@@ -3962,6 +3997,7 @@ export interface AppVideo {
3962
3997
  published_at: string;
3963
3998
  live_broadcast_content?: string | null;
3964
3999
  statistics?: YoutubeStatistics | null;
4000
+ type: VideoType;
3965
4001
  slug?: string | null;
3966
4002
  paywall?: AppPaywallConfiguration | null;
3967
4003
  tags?: Array<TagStub>;
@@ -6993,12 +7029,16 @@ declare class ParraAPI {
6993
7029
  limit?: number;
6994
7030
  offset?: number;
6995
7031
  }, options?: Options) => Promise<ContentCardCollectionResponse>;
7032
+ updateSiteIcon: (tenant_id: string, site_id: string, site_icon_type: string, site_icon_size: number, body: UploadImageRequestBody, options?: Options) => Promise<SiteIcon>;
7033
+ deleteSiteIcon: (tenant_id: string, site_id: string, site_icon_type: string, site_icon_size: number, options?: Options) => Promise<Response>;
6996
7034
  updateBackgroundImageForContentCardById: (tenant_id: string, content_card_id: string, body: UploadImageRequestBody, options?: Options) => Promise<ContentCard>;
6997
7035
  uploadAttachmentForCreatorUpdateById: (tenant_id: string, creator_update_id: string, body: UploadImageRequestBody, options?: Options) => Promise<ImageAsset>;
6998
7036
  uploadLogoForTenantById: (tenant_id: string, body: UploadImageRequestBody, options?: Options) => Promise<ImageAsset>;
6999
7037
  listFeaturedApplications: (options?: Options) => Promise<Array<FeaturedApplication>>;
7000
7038
  getLinkByDomainAndKey: (link_domain: string, link_key: string, options?: Options) => Promise<Link>;
7001
7039
  createSubscriberForEmailAudienceById: (email_audience_id: string, body: CreateEmailSubscriberRequestBody, options?: Options) => Promise<Response>;
7040
+ getSiteForTenant: (tenant_id: string, options?: Options) => Promise<Site>;
7041
+ getSiteById: (tenant_id: string, site_id: string, options?: Options) => Promise<Site>;
7002
7042
  createTag: (tenant_id: string, body: CreateTagRequestBody, options?: Options) => Promise<Tag>;
7003
7043
  paginateTags: (tenant_id: string, query?: {
7004
7044
  pool?: string;
package/dist/ParraAPI.js CHANGED
@@ -11,9 +11,9 @@ 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.QrCodeStyle = exports.QrCodeLogoPaddingStyle = exports.TextTransform = exports.BorderRadiusType = exports.BorderStyle = exports.FontFamilyType = exports.FontWeightType = exports.FontSizeType = exports.ParraTemplateType = exports.AttachmentType = exports.ChannelMemberRole = exports.ChannelMemberType = exports.ChatChannelStatus = exports.ChatChannelType = exports.BillingSourceType = exports.ApplePurchaseType = exports.ApplePurchaseEnvironment = exports.PurchaseEnvironment = exports.PurchasePlatform = exports.PurchaseStatus = exports.PurchaseType = exports.PaywallIapType = exports.AppPaywallType = exports.ShareAssetType = exports.DesignTokenType = exports.ThemeCornerRadiusStyle = exports.ContentType = exports.CtaType = exports.Interval = exports.Currency = exports.ProductType = exports.ReactionType = exports.ArticleStatus = exports.TagPool = exports.FeedbackFormFieldType = exports.ContentCardActionType = exports.IdentityType = exports.PolicyDocumentType = exports.AppleSsoScope = exports.TenantBrand = exports.TenantArchetype = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
15
- exports.TenantUserMetricType = exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.ApiKeyType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.ClientType = exports.PasswordlessStrategy = exports.SsoProvider = exports.SettingsItemType = exports.SubscriptionStatus = exports.ApnsPushType = exports.ApnsEnvironment = exports.ChannelType = exports.AppVersionStatus = exports.TicketDisplayStatus = exports.UserNoteStatus = exports.TicketLinkType = exports.BoardType = exports.TemplateType = exports.CampaignStatus = exports.CampaignActionDisplayType = exports.CampaignActionType = exports.CardItemDisplayType = exports.CardItemType = exports.QuestionKind = exports.QuestionType = exports.SubmitCommentReviewStatus = exports.CommentReviewStatus = exports.VideoType = exports.FeedChannelType = exports.FeedItemType = exports.SocialAccountType = exports.CreatorUpdateGiveawayCriteria = exports.CreatorUpdateChannelType = exports.CreatorUpdateStatus = exports.CreatorUpdateVisibilityType = exports.CreatorUpdateTopic = exports.LessonType = exports.TextAlign = exports.HeadingTag = exports.QrCodeEcLevel = void 0;
16
- exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = void 0;
14
+ exports.TextTransform = exports.BorderRadiusType = exports.BorderStyle = exports.FontFamilyType = exports.FontWeightType = exports.FontSizeType = exports.ParraTemplateType = exports.AttachmentType = exports.ChannelMemberRole = exports.ChannelMemberType = exports.ChatChannelStatus = exports.ChatChannelType = exports.BillingSourceType = exports.ApplePurchaseType = exports.ApplePurchaseEnvironment = exports.PurchaseEnvironment = exports.PurchasePlatform = exports.PurchaseStatus = exports.PurchaseType = exports.PaywallIapType = exports.AppPaywallType = exports.ShareAssetType = exports.DesignTokenType = exports.ThemeCornerRadiusStyle = exports.VideoType = exports.ContentType = exports.CtaType = exports.Interval = exports.Currency = exports.ProductType = exports.ReactionType = exports.ArticleStatus = exports.TagPool = exports.SiteIconType = exports.FeedbackFormFieldType = exports.ContentCardActionType = exports.IdentityType = exports.PolicyDocumentType = exports.AppleSsoScope = exports.TenantBrand = exports.TenantArchetype = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
15
+ exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.ApiKeyType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.ClientType = exports.PasswordlessStrategy = exports.SsoProvider = exports.SettingsItemType = exports.SubscriptionStatus = exports.ApnsPushType = exports.ApnsEnvironment = exports.ChannelType = exports.AppVersionStatus = exports.TicketDisplayStatus = exports.UserNoteStatus = exports.TicketLinkType = exports.BoardType = exports.TemplateType = exports.CampaignStatus = exports.CampaignActionDisplayType = exports.CampaignActionType = exports.CardItemDisplayType = exports.CardItemType = exports.QuestionKind = exports.QuestionType = exports.SubmitCommentReviewStatus = exports.CommentReviewStatus = exports.FeedChannelType = exports.FeedItemType = exports.SocialAccountType = exports.CreatorUpdateGiveawayCriteria = exports.CreatorUpdateChannelType = exports.CreatorUpdateStatus = exports.CreatorUpdateVisibilityType = exports.CreatorUpdateTopic = exports.LessonType = exports.TextAlign = exports.HeadingTag = exports.QrCodeEcLevel = exports.QrCodeStyle = exports.QrCodeLogoPaddingStyle = void 0;
16
+ exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.TenantUserMetricType = void 0;
17
17
  var TicketType;
18
18
  (function (TicketType) {
19
19
  TicketType["bug"] = "bug";
@@ -123,6 +123,12 @@ var FeedbackFormFieldType;
123
123
  FeedbackFormFieldType["input"] = "input";
124
124
  FeedbackFormFieldType["select"] = "select";
125
125
  })(FeedbackFormFieldType || (exports.FeedbackFormFieldType = FeedbackFormFieldType = {}));
126
+ var SiteIconType;
127
+ (function (SiteIconType) {
128
+ SiteIconType["icon"] = "icon";
129
+ SiteIconType["favicon"] = "favicon";
130
+ SiteIconType["appleIcon"] = "apple-icon";
131
+ })(SiteIconType || (exports.SiteIconType = SiteIconType = {}));
126
132
  var TagPool;
127
133
  (function (TagPool) {
128
134
  TagPool["content"] = "content";
@@ -167,6 +173,10 @@ var ContentType;
167
173
  ContentType["rssItem"] = "rss_item";
168
174
  ContentType["article"] = "article";
169
175
  })(ContentType || (exports.ContentType = ContentType = {}));
176
+ var VideoType;
177
+ (function (VideoType) {
178
+ VideoType["youtube"] = "youtube";
179
+ })(VideoType || (exports.VideoType = VideoType = {}));
170
180
  var ThemeCornerRadiusStyle;
171
181
  (function (ThemeCornerRadiusStyle) {
172
182
  ThemeCornerRadiusStyle["rounded"] = "rounded";
@@ -415,10 +425,6 @@ var FeedChannelType;
415
425
  FeedChannelType["youtube"] = "youtube";
416
426
  FeedChannelType["rss"] = "rss";
417
427
  })(FeedChannelType || (exports.FeedChannelType = FeedChannelType = {}));
418
- var VideoType;
419
- (function (VideoType) {
420
- VideoType["youtube"] = "youtube";
421
- })(VideoType || (exports.VideoType = VideoType = {}));
422
428
  var CommentReviewStatus;
423
429
  (function (CommentReviewStatus) {
424
430
  CommentReviewStatus["pending"] = "pending";
@@ -817,6 +823,16 @@ var ParraAPI = /** @class */ (function () {
817
823
  if (options === void 0) { options = {}; }
818
824
  return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/content-cards"), method: "get", query: query }, options));
819
825
  };
826
+ this.updateSiteIcon = function (tenant_id, site_id, site_icon_type, site_icon_size, body, options) {
827
+ if (options === void 0) { options = {}; }
828
+ return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/sites/").concat(site_id, "/icons/").concat(site_icon_type, "/").concat(site_icon_size), method: "put", body: JSON.stringify(body), headers: {
829
+ "content-type": "application/json",
830
+ } }, options));
831
+ };
832
+ this.deleteSiteIcon = function (tenant_id, site_id, site_icon_type, site_icon_size, options) {
833
+ if (options === void 0) { options = {}; }
834
+ return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/sites/").concat(site_id, "/icons/").concat(site_icon_type, "/").concat(site_icon_size), method: "delete" }, options));
835
+ };
820
836
  this.updateBackgroundImageForContentCardById = function (tenant_id, content_card_id, body, options) {
821
837
  if (options === void 0) { options = {}; }
822
838
  var formData = new FormData();
@@ -858,6 +874,14 @@ var ParraAPI = /** @class */ (function () {
858
874
  "content-type": "application/json",
859
875
  }, raw: true }, options));
860
876
  };
877
+ this.getSiteForTenant = function (tenant_id, options) {
878
+ if (options === void 0) { options = {}; }
879
+ return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/site"), method: "get" }, options));
880
+ };
881
+ this.getSiteById = function (tenant_id, site_id, options) {
882
+ if (options === void 0) { options = {}; }
883
+ return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/sites/").concat(site_id), method: "get" }, options));
884
+ };
861
885
  this.createTag = function (tenant_id, body, options) {
862
886
  if (options === void 0) { options = {}; }
863
887
  return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tags"), method: "post", body: JSON.stringify(body), headers: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@parra/parra-js-sdk",
3
- "version": "0.3.621",
3
+ "version": "0.3.623",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",