@articlesq/sdk 0.0.3 → 0.0.4
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.
- package/dist/index.d.cts +10 -2
- package/dist/index.d.ts +10 -2
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -428,6 +428,10 @@ type CreateArticleBody = {
|
|
|
428
428
|
* Defaults to `draft`.
|
|
429
429
|
*/
|
|
430
430
|
status?: "draft" | "published";
|
|
431
|
+
/**
|
|
432
|
+
* Public publish date (schema.org `datePublished`) as an ISO 8601 date-time. Can be set on a draft and is kept when the article is published, so you can back-date imported or scheduled content. `null` clears it. When it is not set, the date of the first publish is used.
|
|
433
|
+
*/
|
|
434
|
+
datePublished?: string | null;
|
|
431
435
|
/**
|
|
432
436
|
* Structured FAQ as plain-text Q/A pairs. Server trims whitespace, drops fully-empty pairs, and rejects half-filled ones (only `q` or only `a`).
|
|
433
437
|
*/
|
|
@@ -450,6 +454,10 @@ type UpdateArticleBody = {
|
|
|
450
454
|
* SEO meta description, recommended < 155 characters.
|
|
451
455
|
*/
|
|
452
456
|
metaDescription?: string;
|
|
457
|
+
/**
|
|
458
|
+
* Public publish date (schema.org `datePublished`) as an ISO 8601 date-time. Can be set on a draft and is kept when the article is published, so you can back-date imported or scheduled content. `null` clears it. When it is not set, the date of the first publish is used.
|
|
459
|
+
*/
|
|
460
|
+
datePublished?: string | null;
|
|
453
461
|
/**
|
|
454
462
|
* Replace the structured FAQ. Server trims whitespace, drops fully-empty pairs, rejects half-filled ones. Pass `[]` to remove all items. Omit to leave it unchanged.
|
|
455
463
|
*/
|
|
@@ -463,7 +471,7 @@ type GenerateArticleImagesBody = {
|
|
|
463
471
|
inline?: Array<InlineImagePrompt>;
|
|
464
472
|
};
|
|
465
473
|
/**
|
|
466
|
-
* Cover image (16:9). Replaces the current cover when the article already has one.
|
|
474
|
+
* Cover image (16:9). Replaces the current cover when the article already has one; the previous cover is kept in the article's image gallery.
|
|
467
475
|
*/
|
|
468
476
|
type CoverImagePrompt = {
|
|
469
477
|
/**
|
|
@@ -507,7 +515,7 @@ type GenerateArticleImagesResult = {
|
|
|
507
515
|
*/
|
|
508
516
|
generated: Array<string>;
|
|
509
517
|
/**
|
|
510
|
-
* Ids of the images that are not in the article after this call. Send an inline id again only if its `{{ID}}` marker is still in the returned `article.content`; if the marker is gone, another call already placed an image there. Send the cover again if `coverImage` did not change.
|
|
518
|
+
* Ids of the images that are not in the article after this call. Send an inline id again only if its `{{ID}}` marker is still in the returned `article.content`; if the marker is gone, another call already placed an image there. Send the cover again if `coverImage` did not change. Every image that was generated is kept in the article's image gallery, placed or not.
|
|
511
519
|
*/
|
|
512
520
|
failed: Array<string>;
|
|
513
521
|
};
|
package/dist/index.d.ts
CHANGED
|
@@ -428,6 +428,10 @@ type CreateArticleBody = {
|
|
|
428
428
|
* Defaults to `draft`.
|
|
429
429
|
*/
|
|
430
430
|
status?: "draft" | "published";
|
|
431
|
+
/**
|
|
432
|
+
* Public publish date (schema.org `datePublished`) as an ISO 8601 date-time. Can be set on a draft and is kept when the article is published, so you can back-date imported or scheduled content. `null` clears it. When it is not set, the date of the first publish is used.
|
|
433
|
+
*/
|
|
434
|
+
datePublished?: string | null;
|
|
431
435
|
/**
|
|
432
436
|
* Structured FAQ as plain-text Q/A pairs. Server trims whitespace, drops fully-empty pairs, and rejects half-filled ones (only `q` or only `a`).
|
|
433
437
|
*/
|
|
@@ -450,6 +454,10 @@ type UpdateArticleBody = {
|
|
|
450
454
|
* SEO meta description, recommended < 155 characters.
|
|
451
455
|
*/
|
|
452
456
|
metaDescription?: string;
|
|
457
|
+
/**
|
|
458
|
+
* Public publish date (schema.org `datePublished`) as an ISO 8601 date-time. Can be set on a draft and is kept when the article is published, so you can back-date imported or scheduled content. `null` clears it. When it is not set, the date of the first publish is used.
|
|
459
|
+
*/
|
|
460
|
+
datePublished?: string | null;
|
|
453
461
|
/**
|
|
454
462
|
* Replace the structured FAQ. Server trims whitespace, drops fully-empty pairs, rejects half-filled ones. Pass `[]` to remove all items. Omit to leave it unchanged.
|
|
455
463
|
*/
|
|
@@ -463,7 +471,7 @@ type GenerateArticleImagesBody = {
|
|
|
463
471
|
inline?: Array<InlineImagePrompt>;
|
|
464
472
|
};
|
|
465
473
|
/**
|
|
466
|
-
* Cover image (16:9). Replaces the current cover when the article already has one.
|
|
474
|
+
* Cover image (16:9). Replaces the current cover when the article already has one; the previous cover is kept in the article's image gallery.
|
|
467
475
|
*/
|
|
468
476
|
type CoverImagePrompt = {
|
|
469
477
|
/**
|
|
@@ -507,7 +515,7 @@ type GenerateArticleImagesResult = {
|
|
|
507
515
|
*/
|
|
508
516
|
generated: Array<string>;
|
|
509
517
|
/**
|
|
510
|
-
* Ids of the images that are not in the article after this call. Send an inline id again only if its `{{ID}}` marker is still in the returned `article.content`; if the marker is gone, another call already placed an image there. Send the cover again if `coverImage` did not change.
|
|
518
|
+
* Ids of the images that are not in the article after this call. Send an inline id again only if its `{{ID}}` marker is still in the returned `article.content`; if the marker is gone, another call already placed an image there. Send the cover again if `coverImage` did not change. Every image that was generated is kept in the article's image gallery, placed or not.
|
|
511
519
|
*/
|
|
512
520
|
failed: Array<string>;
|
|
513
521
|
};
|