@articlesq/sdk 0.0.1 → 0.0.2

package/dist/index.d.cts

@@ -315,6 +315,7 @@ type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boole
 type ClientOptions = {
     baseUrl: "https://articlesq.com/api/v1" | (string & {});
 };
+type Webhooks = ArticlePublishedWebhookRequest | ArticleUpdatedWebhookRequest | ArticleUnpublishedWebhookRequest;
 type ApiError = {
     error: {
         title: string;
@@ -390,7 +391,7 @@ type Article = {
      */
     datePublished: string | null;
     /**
-     * Last meaningful content update (schema.org `dateModified`) as an ISO 8601 string. Null until the article is edited after being published.
+     * Last meaningful content update (schema.org `dateModified`) as an ISO 8601 string. Stamped automatically when a published article's content changes, and overridable from the dashboard for imported content. Null until either happens.
      */
     dateModified: string | null;
 };
@@ -454,6 +455,24 @@ type UpdateArticleBody = {
      */
     faq?: Array<FaqItem>;
 };
+type ArticleEvent = {
+    /**
+     * Which event fired. `article.published` on an article becoming public, `article.updated` on a content change to an already-published article, `article.unpublished` when it returns to draft and leaves the public API.
+     */
+    type: "article.published" | "article.updated" | "article.unpublished";
+    /**
+     * When the event was generated, ISO 8601. Matches the `webhook-timestamp` header (seconds since the epoch) used to sign the request.
+     */
+    timestamp: string;
+    /**
+     * Identifies the article that changed. Fetch `GET /articles/{slug}` for the current content: the event is a notification, not a snapshot.
+     */
+    article: {
+        id: string;
+        slug: string;
+        projectId: string;
+    };
+};
 type ListArticlesData = {
     body?: never;
     path?: never;
@@ -594,6 +613,36 @@ type UpdateArticleResponses = {
     200: ArticleResponse;
 };
 type UpdateArticleResponse = UpdateArticleResponses[keyof UpdateArticleResponses];
+/**
+ * Event payload
+ */
+type ArticlePublishedWebhookPayload = ArticleEvent;
+type ArticlePublishedWebhookRequest = {
+    body: ArticlePublishedWebhookPayload;
+    key: "article.published";
+    path?: never;
+    query?: never;
+};
+/**
+ * Event payload
+ */
+type ArticleUpdatedWebhookPayload = ArticleEvent;
+type ArticleUpdatedWebhookRequest = {
+    body: ArticleUpdatedWebhookPayload;
+    key: "article.updated";
+    path?: never;
+    query?: never;
+};
+/**
+ * Event payload
+ */
+type ArticleUnpublishedWebhookPayload = ArticleEvent;
+type ArticleUnpublishedWebhookRequest = {
+    body: ArticleUnpublishedWebhookPayload;
+    key: "article.unpublished";
+    path?: never;
+    query?: never;
+};
 
 type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
     /**
@@ -733,4 +782,4 @@ declare function createArticlesNamespace(client: Client): {
     }>;
 };
 
-export { type ApiError, type ApiErrorCode, type Article, type ArticleResponse, type ArticleStatus, Articles, ArticlesQ, type ArticlesQOptions, type ClientOptions, type CreateArticleBody, type CreateArticleData, type CreateArticleError, type CreateArticleErrors, type CreateArticleResponse, type CreateArticleResponses, type FaqItem, type GetArticleData, type GetArticleError, type GetArticleErrors, type GetArticleResponse, type GetArticleResponses, type ListArticlesData, type ListArticlesError, type ListArticlesErrors, type ListArticlesResponse, type ListArticlesResponse2, type ListArticlesResponses, type Options, type Pagination, type UpdateArticleBody, type UpdateArticleData, type UpdateArticleError, type UpdateArticleErrors, type UpdateArticleResponse, type UpdateArticleResponses, ArticlesQ as default };
+export { type ApiError, type ApiErrorCode, type Article, type ArticleEvent, type ArticlePublishedWebhookPayload, type ArticlePublishedWebhookRequest, type ArticleResponse, type ArticleStatus, type ArticleUnpublishedWebhookPayload, type ArticleUnpublishedWebhookRequest, type ArticleUpdatedWebhookPayload, type ArticleUpdatedWebhookRequest, Articles, ArticlesQ, type ArticlesQOptions, type ClientOptions, type CreateArticleBody, type CreateArticleData, type CreateArticleError, type CreateArticleErrors, type CreateArticleResponse, type CreateArticleResponses, type FaqItem, type GetArticleData, type GetArticleError, type GetArticleErrors, type GetArticleResponse, type GetArticleResponses, type ListArticlesData, type ListArticlesError, type ListArticlesErrors, type ListArticlesResponse, type ListArticlesResponse2, type ListArticlesResponses, type Options, type Pagination, type UpdateArticleBody, type UpdateArticleData, type UpdateArticleError, type UpdateArticleErrors, type UpdateArticleResponse, type UpdateArticleResponses, type Webhooks, ArticlesQ as default };

package/dist/index.d.ts

@@ -315,6 +315,7 @@ type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boole
 type ClientOptions = {
     baseUrl: "https://articlesq.com/api/v1" | (string & {});
 };
+type Webhooks = ArticlePublishedWebhookRequest | ArticleUpdatedWebhookRequest | ArticleUnpublishedWebhookRequest;
 type ApiError = {
     error: {
         title: string;
@@ -390,7 +391,7 @@ type Article = {
      */
     datePublished: string | null;
     /**
-     * Last meaningful content update (schema.org `dateModified`) as an ISO 8601 string. Null until the article is edited after being published.
+     * Last meaningful content update (schema.org `dateModified`) as an ISO 8601 string. Stamped automatically when a published article's content changes, and overridable from the dashboard for imported content. Null until either happens.
      */
     dateModified: string | null;
 };
@@ -454,6 +455,24 @@ type UpdateArticleBody = {
      */
     faq?: Array<FaqItem>;
 };
+type ArticleEvent = {
+    /**
+     * Which event fired. `article.published` on an article becoming public, `article.updated` on a content change to an already-published article, `article.unpublished` when it returns to draft and leaves the public API.
+     */
+    type: "article.published" | "article.updated" | "article.unpublished";
+    /**
+     * When the event was generated, ISO 8601. Matches the `webhook-timestamp` header (seconds since the epoch) used to sign the request.
+     */
+    timestamp: string;
+    /**
+     * Identifies the article that changed. Fetch `GET /articles/{slug}` for the current content: the event is a notification, not a snapshot.
+     */
+    article: {
+        id: string;
+        slug: string;
+        projectId: string;
+    };
+};
 type ListArticlesData = {
     body?: never;
     path?: never;
@@ -594,6 +613,36 @@ type UpdateArticleResponses = {
     200: ArticleResponse;
 };
 type UpdateArticleResponse = UpdateArticleResponses[keyof UpdateArticleResponses];
+/**
+ * Event payload
+ */
+type ArticlePublishedWebhookPayload = ArticleEvent;
+type ArticlePublishedWebhookRequest = {
+    body: ArticlePublishedWebhookPayload;
+    key: "article.published";
+    path?: never;
+    query?: never;
+};
+/**
+ * Event payload
+ */
+type ArticleUpdatedWebhookPayload = ArticleEvent;
+type ArticleUpdatedWebhookRequest = {
+    body: ArticleUpdatedWebhookPayload;
+    key: "article.updated";
+    path?: never;
+    query?: never;
+};
+/**
+ * Event payload
+ */
+type ArticleUnpublishedWebhookPayload = ArticleEvent;
+type ArticleUnpublishedWebhookRequest = {
+    body: ArticleUnpublishedWebhookPayload;
+    key: "article.unpublished";
+    path?: never;
+    query?: never;
+};
 
 type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
     /**
@@ -733,4 +782,4 @@ declare function createArticlesNamespace(client: Client): {
     }>;
 };
 
-export { type ApiError, type ApiErrorCode, type Article, type ArticleResponse, type ArticleStatus, Articles, ArticlesQ, type ArticlesQOptions, type ClientOptions, type CreateArticleBody, type CreateArticleData, type CreateArticleError, type CreateArticleErrors, type CreateArticleResponse, type CreateArticleResponses, type FaqItem, type GetArticleData, type GetArticleError, type GetArticleErrors, type GetArticleResponse, type GetArticleResponses, type ListArticlesData, type ListArticlesError, type ListArticlesErrors, type ListArticlesResponse, type ListArticlesResponse2, type ListArticlesResponses, type Options, type Pagination, type UpdateArticleBody, type UpdateArticleData, type UpdateArticleError, type UpdateArticleErrors, type UpdateArticleResponse, type UpdateArticleResponses, ArticlesQ as default };
+export { type ApiError, type ApiErrorCode, type Article, type ArticleEvent, type ArticlePublishedWebhookPayload, type ArticlePublishedWebhookRequest, type ArticleResponse, type ArticleStatus, type ArticleUnpublishedWebhookPayload, type ArticleUnpublishedWebhookRequest, type ArticleUpdatedWebhookPayload, type ArticleUpdatedWebhookRequest, Articles, ArticlesQ, type ArticlesQOptions, type ClientOptions, type CreateArticleBody, type CreateArticleData, type CreateArticleError, type CreateArticleErrors, type CreateArticleResponse, type CreateArticleResponses, type FaqItem, type GetArticleData, type GetArticleError, type GetArticleErrors, type GetArticleResponse, type GetArticleResponses, type ListArticlesData, type ListArticlesError, type ListArticlesErrors, type ListArticlesResponse, type ListArticlesResponse2, type ListArticlesResponses, type Options, type Pagination, type UpdateArticleBody, type UpdateArticleData, type UpdateArticleError, type UpdateArticleErrors, type UpdateArticleResponse, type UpdateArticleResponses, type Webhooks, ArticlesQ as default };

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "@articlesq/sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "private": false,
   "description": "Official TypeScript SDK for the ArticlesQ API.",
   "license": "Apache-2.0",
   "author": "ArticlesQ",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alexand-ro/2-articlesq.git",
+    "directory": "packages/sdk"
+  },
   "homepage": "https://articlesq.com",
   "keywords": [
     "articlesq",