@smartlyqofficial/node 0.1.54 → 0.1.56

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 CHANGED
@@ -1016,6 +1016,10 @@ type ShortsClip = {
1016
1016
  title?: string;
1017
1017
  hook_text?: string;
1018
1018
  transcript?: string;
1019
+ /**
1020
+ * The clip's aspect ratio.
1021
+ */
1022
+ format?: '9:16' | '4:5' | '1:1' | '16:9';
1019
1023
  clip_url?: string;
1020
1024
  thumbnail?: string;
1021
1025
  duration_ms?: number;
@@ -6191,6 +6195,10 @@ type GenerateShortsData = {
6191
6195
  * false = clean clips with no captions, hook, logo or music (caption_style and caption_format cannot be used then).
6192
6196
  */
6193
6197
  apply_brand_template?: boolean;
6198
+ /**
6199
+ * Output format (aspect ratio) of every clip: 9:16 vertical (TikTok, Reels, Shorts), 4:5 portrait (Instagram feed), 1:1 square or 16:9 landscape (YouTube, LinkedIn). The speaker is followed and the captions, hook, logo and CTA are placed for that canvas. GET /v1/shorts/caption-styles lists them with their pixel size.
6200
+ */
6201
+ format?: '9:16' | '4:5' | '1:1' | '16:9';
6194
6202
  /**
6195
6203
  * Public HTTPS URL to POST `job.completed` or `job.failed` to when this job finishes (same envelope, signature and retries as registered webhooks). It is signed with this job's own `webhook_secret`, returned once in the 202.
6196
6204
  */
@@ -6400,6 +6408,10 @@ type GetShortsResponses = {
6400
6408
  * Whether the clips got stock b-roll: asked for, or the brand template's (false when the job turned it off).
6401
6409
  */
6402
6410
  magic_broll?: boolean;
6411
+ /**
6412
+ * The clips' aspect ratio (9:16 for jobs made before formats existed).
6413
+ */
6414
+ format?: '9:16' | '4:5' | '1:1' | '16:9';
6403
6415
  };
6404
6416
  /**
6405
6417
  * Why the job failed (empty otherwise).
@@ -9183,6 +9195,20 @@ type ValidatePostData = {
9183
9195
  * Media URLs the post would carry (used for required-media and extension checks).
9184
9196
  */
9185
9197
  media_urls?: Array<string>;
9198
+ /**
9199
+ * Optional. Per-platform options as on create (post type, TikTok privacy, ...). The post type decides which media a platform needs.
9200
+ */
9201
+ platform_options?: {
9202
+ [key: string]: {
9203
+ [key: string]: unknown;
9204
+ };
9205
+ };
9206
+ /**
9207
+ * Optional. Per-platform text and media as on create; each platform is checked against its own.
9208
+ */
9209
+ platform_overrides?: {
9210
+ [key: string]: unknown;
9211
+ };
9186
9212
  };
9187
9213
  path?: never;
9188
9214
  query?: never;
@@ -9211,6 +9237,12 @@ type ValidatePostResponses = {
9211
9237
  * Human-readable, actionable problems (empty when valid).
9212
9238
  */
9213
9239
  errors?: Array<string>;
9240
+ /**
9241
+ * Non-blocking advisories per platform (e.g. aspect ratio); they do not make the post invalid.
9242
+ */
9243
+ warnings?: {
9244
+ [key: string]: Array<string>;
9245
+ };
9214
9246
  platforms?: {
9215
9247
  [key: string]: {
9216
9248
  characters?: number;
package/dist/index.d.ts CHANGED
@@ -1016,6 +1016,10 @@ type ShortsClip = {
1016
1016
  title?: string;
1017
1017
  hook_text?: string;
1018
1018
  transcript?: string;
1019
+ /**
1020
+ * The clip's aspect ratio.
1021
+ */
1022
+ format?: '9:16' | '4:5' | '1:1' | '16:9';
1019
1023
  clip_url?: string;
1020
1024
  thumbnail?: string;
1021
1025
  duration_ms?: number;
@@ -6191,6 +6195,10 @@ type GenerateShortsData = {
6191
6195
  * false = clean clips with no captions, hook, logo or music (caption_style and caption_format cannot be used then).
6192
6196
  */
6193
6197
  apply_brand_template?: boolean;
6198
+ /**
6199
+ * Output format (aspect ratio) of every clip: 9:16 vertical (TikTok, Reels, Shorts), 4:5 portrait (Instagram feed), 1:1 square or 16:9 landscape (YouTube, LinkedIn). The speaker is followed and the captions, hook, logo and CTA are placed for that canvas. GET /v1/shorts/caption-styles lists them with their pixel size.
6200
+ */
6201
+ format?: '9:16' | '4:5' | '1:1' | '16:9';
6194
6202
  /**
6195
6203
  * Public HTTPS URL to POST `job.completed` or `job.failed` to when this job finishes (same envelope, signature and retries as registered webhooks). It is signed with this job's own `webhook_secret`, returned once in the 202.
6196
6204
  */
@@ -6400,6 +6408,10 @@ type GetShortsResponses = {
6400
6408
  * Whether the clips got stock b-roll: asked for, or the brand template's (false when the job turned it off).
6401
6409
  */
6402
6410
  magic_broll?: boolean;
6411
+ /**
6412
+ * The clips' aspect ratio (9:16 for jobs made before formats existed).
6413
+ */
6414
+ format?: '9:16' | '4:5' | '1:1' | '16:9';
6403
6415
  };
6404
6416
  /**
6405
6417
  * Why the job failed (empty otherwise).
@@ -9183,6 +9195,20 @@ type ValidatePostData = {
9183
9195
  * Media URLs the post would carry (used for required-media and extension checks).
9184
9196
  */
9185
9197
  media_urls?: Array<string>;
9198
+ /**
9199
+ * Optional. Per-platform options as on create (post type, TikTok privacy, ...). The post type decides which media a platform needs.
9200
+ */
9201
+ platform_options?: {
9202
+ [key: string]: {
9203
+ [key: string]: unknown;
9204
+ };
9205
+ };
9206
+ /**
9207
+ * Optional. Per-platform text and media as on create; each platform is checked against its own.
9208
+ */
9209
+ platform_overrides?: {
9210
+ [key: string]: unknown;
9211
+ };
9186
9212
  };
9187
9213
  path?: never;
9188
9214
  query?: never;
@@ -9211,6 +9237,12 @@ type ValidatePostResponses = {
9211
9237
  * Human-readable, actionable problems (empty when valid).
9212
9238
  */
9213
9239
  errors?: Array<string>;
9240
+ /**
9241
+ * Non-blocking advisories per platform (e.g. aspect ratio); they do not make the post invalid.
9242
+ */
9243
+ warnings?: {
9244
+ [key: string]: Array<string>;
9245
+ };
9214
9246
  platforms?: {
9215
9247
  [key: string]: {
9216
9248
  characters?: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@smartlyqofficial/node",
3
- "version": "0.1.54",
3
+ "version": "0.1.56",
4
4
  "description": "Official Node.js SDK for the SmartlyQ API - social posting, AI content generation, SEO, CRM, and more.",
5
5
  "keywords": [
6
6
  "smartlyq",