@parra/parra-js-sdk 0.3.592 → 0.3.594

package/dist/ParraAPI.d.ts

@@ -858,6 +858,38 @@ export interface BillingPortalSession {
 export interface CreateEmailSubscriberRequestBody {
     email: string;
 }
+export declare enum TagPool {
+    content = "content"
+}
+export interface UpdateTagRequestBody {
+    title?: string;
+    description?: string | null;
+    slug?: string | null;
+}
+export interface CreateTagRequestBody {
+    title?: string;
+    description?: string | null;
+    slug?: string | null;
+    pool: TagPool;
+}
+export interface Tag {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+    tenant_id?: string | null;
+    title: string;
+    description?: string | null;
+    slug?: string | null;
+    pool: TagPool;
+}
+export interface TagCollectionResponse {
+    page: number;
+    page_count: number;
+    page_size: number;
+    total_count: number;
+    data: Array<Tag>;
+}
 export interface ArticleContent {
 }
 export interface UpdateArticleRequestBody {
@@ -884,6 +916,7 @@ export interface CreateArticleRequestBody {
 }
 export declare enum ArticleStatus {
     draft = "draft",
+    dirty = "dirty",
     published = "published",
     scheduled = "scheduled"
 }
@@ -938,6 +971,8 @@ export interface ArticleStub {
     header_image?: ImageAssetStub | null;
     status: ArticleStatus;
     scheduled_at?: string | null;
+    dirty?: boolean;
+    published?: boolean;
     published_at?: string | null;
     last_updated_at: string | null;
     authors: Array<CreatorUpdateSenderStub>;
@@ -959,6 +994,8 @@ export interface Article {
     header_image?: ImageAssetStub | null;
     status: ArticleStatus;
     scheduled_at?: string | null;
+    dirty?: boolean;
+    published?: boolean;
     published_at?: string | null;
     last_updated_at: string | null;
     authors: Array<CreatorUpdateSenderStub>;
@@ -984,6 +1021,14 @@ export interface ArticleAuthor {
     avatar?: ImageAssetStub | null;
     verified: boolean;
 }
+export interface AddTagRequestBody {
+    tag_id: string;
+}
+export interface TagStub {
+    id: string;
+    title: string;
+    slug?: string | null;
+}
 export interface ScheduleArticleRequestBody {
     schedule_at: string;
 }
@@ -1005,6 +1050,7 @@ export interface AppArticleStub {
     authors: Array<CreatorUpdateSenderStub>;
     reaction_options?: Array<ReactionOptionGroup>;
     reactions?: Array<ReactionSummary>;
+    tags?: Array<TagStub>;
 }
 export interface AppArticleCollectionResponse {
     page: number;
@@ -1057,6 +1103,7 @@ export interface AppArticle {
     authors: Array<CreatorUpdateSenderStub>;
     reaction_options?: Array<ReactionOptionGroup>;
     reactions?: Array<ReactionSummary>;
+    tags?: Array<TagStub>;
     json_content: ArticleContent;
     html_content: string;
     text_content: string;
@@ -3585,6 +3632,7 @@ export interface AppVideo {
     comments?: CommentSummary;
     products?: Array<AppAffiliateProduct>;
     sponsors?: Array<AppSponsor>;
+    tags?: Array<TagStub>;
 }
 export interface AppContentCard {
     id: string;
@@ -6711,6 +6759,12 @@ declare class ParraAPI {
     getPlansForTenantById: (tenant_id: string, options?: Options) => Promise<TenantPlansResponse>;
     createBillingPortalSession: (tenant_id: string, options?: Options) => Promise<BillingPortalSession>;
     createSubscriberForEmailAudienceById: (email_audience_id: string, body: CreateEmailSubscriberRequestBody, options?: Options) => Promise<Response>;
+    createTag: (tenant_id: string, body: CreateTagRequestBody, options?: Options) => Promise<Tag>;
+    paginateTags: (tenant_id: string, query?: {
+        pool?: string;
+    }, options?: Options) => Promise<TagCollectionResponse>;
+    updateTagById: (tenant_id: string, tag_id: string, body?: UpdateTagRequestBody, options?: Options) => Promise<Tag>;
+    deleteTagById: (tenant_id: string, tag_id: string, options?: Options) => Promise<Response>;
     createArticle: (tenant_id: string, body: CreateArticleRequestBody, options?: Options) => Promise<Article>;
     paginateArticles: (tenant_id: string, query?: {
         limit?: number;
@@ -6721,11 +6775,14 @@ declare class ParraAPI {
     deleteArticleById: (tenant_id: string, article_id: string, options?: Options) => Promise<Response>;
     addAuthorToArticle: (tenant_id: string, article_id: string, body: CreateArticleAuthorRequestBody, options?: Options) => Promise<ArticleAuthor>;
     removeAuthorFromArticle: (tenant_id: string, article_id: string, author_id: string, options?: Options) => Promise<Response>;
+    addTagToArticle: (tenant_id: string, article_id: string, body: AddTagRequestBody, options?: Options) => Promise<TagStub>;
+    removeTagFromArticle: (tenant_id: string, article_id: string, tag_id: string, options?: Options) => Promise<Response>;
     publishArticleById: (tenant_id: string, article_id: string, options?: Options) => Promise<Article>;
     scheduleArticleById: (tenant_id: string, article_id: string, body: ScheduleArticleRequestBody, options?: Options) => Promise<Article>;
     paginateAppArticles: (tenant_id: string, query?: {
         limit?: number;
         offset?: number;
+        tag_id?: string;
     }, options?: Options) => Promise<AppArticleCollectionResponse>;
     getAppArticleById: (tenant_id: string, article_id: string, query?: {
         include?: string;

package/dist/ParraAPI.js

@@ -11,8 +11,8 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LessonType = exports.TextAlign = exports.HeadingTag = exports.QrCodeEcLevel = exports.QrCodeStyle = exports.QrCodeLogoPaddingStyle = exports.BorderRadiusType = exports.BorderStyle = exports.TextTransform = 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.ReactionType = exports.ArticleStatus = exports.SubscriptionStatus = exports.Interval = exports.Currency = exports.FeedbackFormFieldType = exports.ContentCardActionType = exports.IdentityType = exports.PolicyDocumentType = exports.AppleSsoScope = exports.TenantArchetype = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
-exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.TenantUserMetricType = 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.ClientType = exports.PasswordlessStrategy = exports.SsoProvider = exports.SettingsItemType = 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 = void 0;
+exports.TextAlign = exports.HeadingTag = exports.QrCodeEcLevel = exports.QrCodeStyle = exports.QrCodeLogoPaddingStyle = exports.BorderRadiusType = exports.BorderStyle = exports.TextTransform = 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.ReactionType = exports.ArticleStatus = exports.TagPool = exports.SubscriptionStatus = exports.Interval = exports.Currency = exports.FeedbackFormFieldType = exports.ContentCardActionType = exports.IdentityType = exports.PolicyDocumentType = exports.AppleSsoScope = exports.TenantArchetype = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
+exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.TenantUserMetricType = 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.ClientType = exports.PasswordlessStrategy = exports.SsoProvider = exports.SettingsItemType = 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 = void 0;
 var TicketType;
 (function (TicketType) {
     TicketType["bug"] = "bug";
@@ -137,9 +137,14 @@ var SubscriptionStatus;
     SubscriptionStatus["canceled"] = "canceled";
     SubscriptionStatus["unpaid"] = "unpaid";
 })(SubscriptionStatus || (exports.SubscriptionStatus = SubscriptionStatus = {}));
+var TagPool;
+(function (TagPool) {
+    TagPool["content"] = "content";
+})(TagPool || (exports.TagPool = TagPool = {}));
 var ArticleStatus;
 (function (ArticleStatus) {
     ArticleStatus["draft"] = "draft";
+    ArticleStatus["dirty"] = "dirty";
     ArticleStatus["published"] = "published";
     ArticleStatus["scheduled"] = "scheduled";
 })(ArticleStatus || (exports.ArticleStatus = ArticleStatus = {}));
@@ -834,6 +839,26 @@ var ParraAPI = /** @class */ (function () {
                     "content-type": "application/json",
                 }, raw: true }, options));
         };
+        this.createTag = function (tenant_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tags"), method: "post", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.paginateTags = function (tenant_id, query, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tags"), method: "get", query: query }, options));
+        };
+        this.updateTagById = function (tenant_id, tag_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tags/").concat(tag_id), method: "put", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.deleteTagById = function (tenant_id, tag_id, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tags/").concat(tag_id), method: "delete" }, options));
+        };
         this.createArticle = function (tenant_id, body, options) {
             if (options === void 0) { options = {}; }
             return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/articles"), method: "post", body: JSON.stringify(body), headers: {
@@ -868,6 +893,16 @@ var ParraAPI = /** @class */ (function () {
             if (options === void 0) { options = {}; }
             return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/articles/").concat(article_id, "/authors/").concat(author_id), method: "delete" }, options));
         };
+        this.addTagToArticle = function (tenant_id, article_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/articles/").concat(article_id, "/tags"), method: "post", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.removeTagFromArticle = function (tenant_id, article_id, tag_id, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/articles/").concat(article_id, "/tags/").concat(tag_id), method: "delete" }, options));
+        };
         this.publishArticleById = function (tenant_id, article_id, options) {
             if (options === void 0) { options = {}; }
             return _this.http.execute(__assign({ path: "".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/articles/").concat(article_id, "/publish"), method: "post" }, options));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parra/parra-js-sdk",
-  "version": "0.3.592",
+  "version": "0.3.594",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",