@getlatedev/node 0.2.1226 → 0.2.1228
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/README.md +1 -0
- package/dist/index.d.mts +143 -56
- package/dist/index.d.ts +143 -56
- package/dist/index.js +8 -1
- package/dist/index.mjs +8 -1
- package/package.json +1 -1
- package/src/client.ts +2 -0
- package/src/generated/sdk.gen.ts +59 -25
- package/src/generated/types.gen.ts +145 -55
|
@@ -2295,35 +2295,35 @@ export type billingSystem = 'metronome' | 'stripe' | 'shopify';
|
|
|
2295
2295
|
*/
|
|
2296
2296
|
export type Blog = {
|
|
2297
2297
|
/**
|
|
2298
|
-
* Platform-native blog id. Shopify uses a numeric blog id. WordPress.com uses the numeric site id; self-hosted WordPress
|
|
2298
|
+
* Platform-native blog id. Shopify uses a numeric blog id. WordPress.com uses the numeric site id; self-hosted WordPress and Wix use `1`, scoped to the connected account.
|
|
2299
2299
|
*/
|
|
2300
2300
|
id?: string;
|
|
2301
|
-
platform?: 'shopify' | 'wordpress';
|
|
2301
|
+
platform?: 'shopify' | 'wordpress' | 'wix';
|
|
2302
2302
|
title?: string;
|
|
2303
2303
|
/**
|
|
2304
|
-
* URL slug on Shopify; site hostname on WordPress.
|
|
2304
|
+
* URL slug on Shopify; site hostname on WordPress and Wix.
|
|
2305
2305
|
*/
|
|
2306
2306
|
handle?: string;
|
|
2307
2307
|
};
|
|
2308
2308
|
|
|
2309
|
-
export type platform3 = 'shopify' | 'wordpress';
|
|
2309
|
+
export type platform3 = 'shopify' | 'wordpress' | 'wix';
|
|
2310
2310
|
|
|
2311
2311
|
/**
|
|
2312
2312
|
* An article inside a blog on the connected platform.
|
|
2313
2313
|
*/
|
|
2314
2314
|
export type BlogArticle = {
|
|
2315
2315
|
/**
|
|
2316
|
-
* Platform-native
|
|
2316
|
+
* Platform-native article/post id: numeric on Shopify and WordPress, a GUID on Wix.
|
|
2317
2317
|
*/
|
|
2318
2318
|
id?: string;
|
|
2319
2319
|
/**
|
|
2320
2320
|
* Platform-native id of the blog the article belongs to.
|
|
2321
2321
|
*/
|
|
2322
2322
|
blogId?: string;
|
|
2323
|
-
platform?: 'shopify' | 'wordpress';
|
|
2323
|
+
platform?: 'shopify' | 'wordpress' | 'wix';
|
|
2324
2324
|
title?: string;
|
|
2325
2325
|
/**
|
|
2326
|
-
* Article body as HTML.
|
|
2326
|
+
* Article body as HTML. Wix stores rich content, converted from and to HTML; Wix lists return null (get the article for its body).
|
|
2327
2327
|
*/
|
|
2328
2328
|
bodyHtml?: (string) | null;
|
|
2329
2329
|
/**
|
|
@@ -2331,11 +2331,11 @@ export type BlogArticle = {
|
|
|
2331
2331
|
*/
|
|
2332
2332
|
handle?: string;
|
|
2333
2333
|
/**
|
|
2334
|
-
* Tag names. On WordPress, missing tag names are created and matching is case-insensitive.
|
|
2334
|
+
* Tag names. On WordPress and Wix, missing tag names are created and matching is case-insensitive.
|
|
2335
2335
|
*/
|
|
2336
2336
|
tags?: Array<(string)>;
|
|
2337
2337
|
/**
|
|
2338
|
-
* Shopify author display name,
|
|
2338
|
+
* Shopify author display name, numeric WordPress user id serialized as a string, or Wix site member id. Wix posts without one are attributed to the site's default author.
|
|
2339
2339
|
*/
|
|
2340
2340
|
author?: (string) | null;
|
|
2341
2341
|
/**
|
|
@@ -2358,11 +2358,11 @@ export type BlogArticle = {
|
|
|
2358
2358
|
*/
|
|
2359
2359
|
publishedAt?: (string) | null;
|
|
2360
2360
|
/**
|
|
2361
|
-
* WordPress
|
|
2361
|
+
* WordPress and Wix. Post status (`future` = scheduled, `pending` = in review on Wix); omitted for Shopify.
|
|
2362
2362
|
*/
|
|
2363
2363
|
status?: 'publish' | 'future' | 'draft' | 'pending' | 'private';
|
|
2364
2364
|
/**
|
|
2365
|
-
* WordPress
|
|
2365
|
+
* WordPress and Wix. Scheduled publication time in UTC when status is `future`; null for other statuses and omitted for Shopify.
|
|
2366
2366
|
*/
|
|
2367
2367
|
publishDate?: (string) | null;
|
|
2368
2368
|
/**
|
|
@@ -2376,7 +2376,7 @@ export type BlogArticle = {
|
|
|
2376
2376
|
};
|
|
2377
2377
|
|
|
2378
2378
|
/**
|
|
2379
|
-
* WordPress
|
|
2379
|
+
* WordPress and Wix. Post status (`future` = scheduled, `pending` = in review on Wix); omitted for Shopify.
|
|
2380
2380
|
*/
|
|
2381
2381
|
export type status3 = 'publish' | 'future' | 'draft' | 'pending' | 'private';
|
|
2382
2382
|
|
|
@@ -10913,7 +10913,7 @@ export type contentType3 = 'story' | 'saved_story' | 'spotlight';
|
|
|
10913
10913
|
|
|
10914
10914
|
export type SocialAccount = {
|
|
10915
10915
|
_id: string;
|
|
10916
|
-
platform: 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'sms' | 'phone' | 'rcs' | 'whopads';
|
|
10916
|
+
platform: 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'wix' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'sms' | 'phone' | 'rcs' | 'whopads';
|
|
10917
10917
|
profileId: (string | Profile);
|
|
10918
10918
|
username?: string;
|
|
10919
10919
|
displayName?: string;
|
|
@@ -11023,7 +11023,7 @@ export type SocialAccount = {
|
|
|
11023
11023
|
};
|
|
11024
11024
|
};
|
|
11025
11025
|
|
|
11026
|
-
export type platform11 = 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'sms' | 'phone' | 'rcs' | 'whopads';
|
|
11026
|
+
export type platform11 = 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'wix' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'sms' | 'phone' | 'rcs' | 'whopads';
|
|
11027
11027
|
|
|
11028
11028
|
/**
|
|
11029
11029
|
* TikTok accounts only. The account type TikTok reported when the account was connected. `personal` accounts cannot use TikTok direct messages through the API (TikTok limits Business Messaging to Business Accounts): skip the inbox for them and tell the user to switch to a Business Account in the TikTok app, then reconnect. `business` is the prerequisite, not a guarantee; messaging also needs the messaging scopes granted and TikTok's regional availability. `unknown` on accounts connected before this was captured or whose grant left out the account-type scope.
|
|
@@ -11100,6 +11100,11 @@ export type StorePixelInstall = {
|
|
|
11100
11100
|
sidebarId?: (string) | null;
|
|
11101
11101
|
};
|
|
11102
11102
|
|
|
11103
|
+
/**
|
|
11104
|
+
* The store platform.
|
|
11105
|
+
*/
|
|
11106
|
+
export type platform12 = 'shopify' | 'wordpress';
|
|
11107
|
+
|
|
11103
11108
|
/**
|
|
11104
11109
|
* WordPress only.
|
|
11105
11110
|
*/
|
|
@@ -11779,7 +11784,7 @@ export type TrackingTag = {
|
|
|
11779
11784
|
autoTagging?: boolean;
|
|
11780
11785
|
};
|
|
11781
11786
|
|
|
11782
|
-
export type
|
|
11787
|
+
export type platform13 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads' | 'pinterestads' | 'whopads';
|
|
11783
11788
|
|
|
11784
11789
|
/**
|
|
11785
11790
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
@@ -13691,7 +13696,7 @@ export type WebhookPayloadComment = {
|
|
|
13691
13696
|
|
|
13692
13697
|
export type event14 = 'comment.received';
|
|
13693
13698
|
|
|
13694
|
-
export type
|
|
13699
|
+
export type platform14 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
|
|
13695
13700
|
|
|
13696
13701
|
export type WebhookPayloadCommerceOrder = {
|
|
13697
13702
|
/**
|
|
@@ -14053,7 +14058,7 @@ export type WebhookPayloadLead = {
|
|
|
14053
14058
|
|
|
14054
14059
|
export type event22 = 'lead.received';
|
|
14055
14060
|
|
|
14056
|
-
export type
|
|
14061
|
+
export type platform15 = 'facebook';
|
|
14057
14062
|
|
|
14058
14063
|
/**
|
|
14059
14064
|
* Webhook payload for message received events
|
|
@@ -15070,7 +15075,7 @@ export type event27 = 'message.sent';
|
|
|
15070
15075
|
/**
|
|
15071
15076
|
* Every platform whose outgoing messages Zernio observes. sms is absent on purpose: its carrier receipts update delivery status and never raise message.sent.
|
|
15072
15077
|
*/
|
|
15073
|
-
export type
|
|
15078
|
+
export type platform16 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'slack' | 'tiktok' | 'imessage';
|
|
15074
15079
|
|
|
15075
15080
|
/**
|
|
15076
15081
|
* WhatsApp send origin. whatsapp_business_app when sent from the WhatsApp Business phone app on a Coexistence number; cloud_api when sent through Zernio (dashboard, API, or broadcasts); meta_business_agent when Meta Business Agent answered on the number. Absent on non-WhatsApp platforms. Says where WhatsApp saw the send come from, not which Zernio surface produced it: read sentVia for that.
|
|
@@ -15645,7 +15650,7 @@ export type WebhookPayloadWhatsAppAccountAlertReceived = {
|
|
|
15645
15650
|
|
|
15646
15651
|
export type event38 = 'whatsapp.account.alert_received';
|
|
15647
15652
|
|
|
15648
|
-
export type
|
|
15653
|
+
export type platform17 = 'whatsapp';
|
|
15649
15654
|
|
|
15650
15655
|
/**
|
|
15651
15656
|
* Webhook payload for the `whatsapp.account.name_status_updated` event.
|
|
@@ -20229,7 +20234,7 @@ export type GetAllAccountsHealthData = {
|
|
|
20229
20234
|
/**
|
|
20230
20235
|
* Filter by platform
|
|
20231
20236
|
*/
|
|
20232
|
-
platform?: 'facebook' | 'instagram' | 'linkedin' | 'twitter' | 'tiktok' | 'youtube' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'whopads';
|
|
20237
|
+
platform?: 'facebook' | 'instagram' | 'linkedin' | 'twitter' | 'tiktok' | 'youtube' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'wix' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'redditads' | 'whopads';
|
|
20233
20238
|
/**
|
|
20234
20239
|
* Filter by profile ID
|
|
20235
20240
|
*/
|
|
@@ -21891,6 +21896,87 @@ export type GetWordPressAuthUrlError = (unknown | ErrorResponse | {
|
|
|
21891
21896
|
};
|
|
21892
21897
|
});
|
|
21893
21898
|
|
|
21899
|
+
export type GetWixConnectUrlData = {
|
|
21900
|
+
query: {
|
|
21901
|
+
/**
|
|
21902
|
+
* Your Zernio profile ID (get from /v1/profiles).
|
|
21903
|
+
*/
|
|
21904
|
+
profileId: string;
|
|
21905
|
+
/**
|
|
21906
|
+
* Custom redirect after connection. Must be an absolute http(s) URL or custom app scheme such as `myapp://callback`; relative and unsafe URLs return 400.
|
|
21907
|
+
*/
|
|
21908
|
+
redirect_url?: string;
|
|
21909
|
+
};
|
|
21910
|
+
};
|
|
21911
|
+
|
|
21912
|
+
export type GetWixConnectUrlResponse = ({
|
|
21913
|
+
/**
|
|
21914
|
+
* Wix installer URL to open in the user agent.
|
|
21915
|
+
*/
|
|
21916
|
+
authUrl: string;
|
|
21917
|
+
/**
|
|
21918
|
+
* Authenticated, expiring state handled by the callback.
|
|
21919
|
+
*/
|
|
21920
|
+
state: string;
|
|
21921
|
+
});
|
|
21922
|
+
|
|
21923
|
+
export type GetWixConnectUrlError = (unknown | ErrorResponse | {
|
|
21924
|
+
/**
|
|
21925
|
+
* Human-readable error message suitable for end-user display.
|
|
21926
|
+
*/
|
|
21927
|
+
error: string;
|
|
21928
|
+
/**
|
|
21929
|
+
* Machine-readable error code. Stable across versions.
|
|
21930
|
+
*/
|
|
21931
|
+
code: 'PAYMENT_REQUIRED';
|
|
21932
|
+
/**
|
|
21933
|
+
* Discriminator for which gate fired.
|
|
21934
|
+
*/
|
|
21935
|
+
reason: 'free_tier_exceeded' | 'twitter_passthrough' | 'enterprise_required' | 'card_verification_required';
|
|
21936
|
+
/**
|
|
21937
|
+
* Link to the relevant documentation page.
|
|
21938
|
+
*/
|
|
21939
|
+
documentation_url?: string;
|
|
21940
|
+
/**
|
|
21941
|
+
* Deep-link to send the end-user to. For
|
|
21942
|
+
* `free_tier_exceeded` and `twitter_passthrough` this opens
|
|
21943
|
+
* the add-payment-method drawer on the Zernio billing page.
|
|
21944
|
+
* For `enterprise_required` this is the Zernio enterprise
|
|
21945
|
+
* contact page.
|
|
21946
|
+
*
|
|
21947
|
+
*/
|
|
21948
|
+
dashboard_url?: string;
|
|
21949
|
+
/**
|
|
21950
|
+
* Structured context for SDK clients that want to render their own UX. Keys vary by `reason`.
|
|
21951
|
+
*/
|
|
21952
|
+
details?: {
|
|
21953
|
+
/**
|
|
21954
|
+
* How many accounts the free tier allows. Only set when reason=free_tier_exceeded.
|
|
21955
|
+
*/
|
|
21956
|
+
free_tier_account_limit?: number;
|
|
21957
|
+
/**
|
|
21958
|
+
* How many accounts the team currently has connected. Set when reason=free_tier_exceeded or reason=enterprise_required.
|
|
21959
|
+
*/
|
|
21960
|
+
current_account_count?: number;
|
|
21961
|
+
/**
|
|
21962
|
+
* Whether the team currently has a card on file in Stripe. Set when reason=free_tier_exceeded or reason=twitter_passthrough.
|
|
21963
|
+
*/
|
|
21964
|
+
has_payment_method?: boolean;
|
|
21965
|
+
/**
|
|
21966
|
+
* One-time card verification charge in USD cents, credited to usage. Only set when reason=card_verification_required.
|
|
21967
|
+
*/
|
|
21968
|
+
verification_amount_cents?: number;
|
|
21969
|
+
/**
|
|
21970
|
+
* The negotiated connected-account cap from the
|
|
21971
|
+
* team's enterprise contract. Self-service teams
|
|
21972
|
+
* have no cap and never receive this reason. Only
|
|
21973
|
+
* set when reason=enterprise_required.
|
|
21974
|
+
*
|
|
21975
|
+
*/
|
|
21976
|
+
effective_account_limit?: number;
|
|
21977
|
+
};
|
|
21978
|
+
});
|
|
21979
|
+
|
|
21894
21980
|
export type ConnectWordPressWithApplicationPasswordData = {
|
|
21895
21981
|
body: {
|
|
21896
21982
|
/**
|
|
@@ -47634,7 +47720,7 @@ export type ListAdAccountsData = {
|
|
|
47634
47720
|
*/
|
|
47635
47721
|
adAccountId?: string;
|
|
47636
47722
|
/**
|
|
47637
|
-
* Google Ads only. `true` returns only the customers this connection accepts as `adAccountId` (or `customerId`) on the other /v1/ads endpoints, i.e. those inside its ad-account selection. Without it every customer the Google login can reach is listed, including ones selected on another connection of the same login, which those endpoints answer with a 400. Ignored on other platforms.
|
|
47723
|
+
* Google Ads only. `true` returns only the customers this connection accepts as `adAccountId` (or `customerId`) on the other /v1/ads endpoints, i.e. those inside its ad-account selection. Without it every customer the Google login can reach is listed, including ones selected on another connection of the same login, which those endpoints answer with a 400. Ignored on other platforms. On every platform, each item's `selected` flags selection membership without narrowing the list.
|
|
47638
47724
|
*/
|
|
47639
47725
|
inScopeOnly?: boolean;
|
|
47640
47726
|
/**
|
|
@@ -47777,6 +47863,10 @@ export type ListAdAccountsResponse = ({
|
|
|
47777
47863
|
* Meta and X only. Always present on every Meta and X account. Human-readable reason when selectable is false; null when selectable.
|
|
47778
47864
|
*/
|
|
47779
47865
|
unusableReason?: (string) | null;
|
|
47866
|
+
/**
|
|
47867
|
+
* Always present. True when the ad account is in this connection's ad-account selection, or when the connection has no selection (then every ad account is usable). For a posting account (e.g. facebook, twitter) the selection of its ads connection applies. Unrelated to `selectable`, which is the platform's own status. Writes to an ad account with `selected: false` will answer 403 `ad_account_not_selected`.
|
|
47868
|
+
*/
|
|
47869
|
+
selected?: boolean;
|
|
47780
47870
|
}>;
|
|
47781
47871
|
/**
|
|
47782
47872
|
* Google only. When this list was fetched from Google. Null when it was never served from cache. Absent on other platforms.
|
|
@@ -54714,7 +54804,7 @@ export type GetTrackingTagStatsError = (unknown | ErrorResponse);
|
|
|
54714
54804
|
export type ListBlogsData = {
|
|
54715
54805
|
path: {
|
|
54716
54806
|
/**
|
|
54717
|
-
* Connected Shopify or
|
|
54807
|
+
* Connected Shopify, WordPress or Wix account id.
|
|
54718
54808
|
*/
|
|
54719
54809
|
accountId: string;
|
|
54720
54810
|
};
|
|
@@ -54731,7 +54821,7 @@ export type ListBlogsData = {
|
|
|
54731
54821
|
};
|
|
54732
54822
|
|
|
54733
54823
|
export type ListBlogsResponse = ({
|
|
54734
|
-
platform?: 'shopify' | 'wordpress';
|
|
54824
|
+
platform?: 'shopify' | 'wordpress' | 'wix';
|
|
54735
54825
|
blogs?: Array<Blog>;
|
|
54736
54826
|
/**
|
|
54737
54827
|
* Cursor for the next page; null when there are no more pages.
|
|
@@ -54767,18 +54857,18 @@ export type CreateBlogError = (ErrorResponse | unknown);
|
|
|
54767
54857
|
export type GetBlogData = {
|
|
54768
54858
|
path: {
|
|
54769
54859
|
/**
|
|
54770
|
-
* Connected Shopify or
|
|
54860
|
+
* Connected Shopify, WordPress or Wix account id.
|
|
54771
54861
|
*/
|
|
54772
54862
|
accountId: string;
|
|
54773
54863
|
/**
|
|
54774
|
-
* Platform-native
|
|
54864
|
+
* Platform-native blog/site id returned by the list operation.
|
|
54775
54865
|
*/
|
|
54776
54866
|
blogId: string;
|
|
54777
54867
|
};
|
|
54778
54868
|
};
|
|
54779
54869
|
|
|
54780
54870
|
export type GetBlogResponse = ({
|
|
54781
|
-
platform?: 'shopify' | 'wordpress';
|
|
54871
|
+
platform?: 'shopify' | 'wordpress' | 'wix';
|
|
54782
54872
|
blog?: Blog;
|
|
54783
54873
|
});
|
|
54784
54874
|
|
|
@@ -54798,7 +54888,7 @@ export type UpdateBlogData = {
|
|
|
54798
54888
|
*/
|
|
54799
54889
|
accountId: string;
|
|
54800
54890
|
/**
|
|
54801
|
-
* Platform-native
|
|
54891
|
+
* Platform-native blog id. Shopify blog ids are numeric; other values return 400.
|
|
54802
54892
|
*/
|
|
54803
54893
|
blogId: string;
|
|
54804
54894
|
};
|
|
@@ -54818,7 +54908,7 @@ export type DeleteBlogData = {
|
|
|
54818
54908
|
*/
|
|
54819
54909
|
accountId: string;
|
|
54820
54910
|
/**
|
|
54821
|
-
* Platform-native
|
|
54911
|
+
* Platform-native blog id. Shopify blog ids are numeric; other values return 400.
|
|
54822
54912
|
*/
|
|
54823
54913
|
blogId: string;
|
|
54824
54914
|
};
|
|
@@ -54831,11 +54921,11 @@ export type DeleteBlogError = (ErrorResponse | unknown);
|
|
|
54831
54921
|
export type ListBlogArticlesData = {
|
|
54832
54922
|
path: {
|
|
54833
54923
|
/**
|
|
54834
|
-
* Connected Shopify or
|
|
54924
|
+
* Connected Shopify, WordPress or Wix account id.
|
|
54835
54925
|
*/
|
|
54836
54926
|
accountId: string;
|
|
54837
54927
|
/**
|
|
54838
|
-
* Platform-native
|
|
54928
|
+
* Platform-native blog/site id returned by the list operation.
|
|
54839
54929
|
*/
|
|
54840
54930
|
blogId: string;
|
|
54841
54931
|
};
|
|
@@ -54852,7 +54942,7 @@ export type ListBlogArticlesData = {
|
|
|
54852
54942
|
};
|
|
54853
54943
|
|
|
54854
54944
|
export type ListBlogArticlesResponse = ({
|
|
54855
|
-
platform?: 'shopify' | 'wordpress';
|
|
54945
|
+
platform?: 'shopify' | 'wordpress' | 'wix';
|
|
54856
54946
|
articles?: Array<BlogArticle>;
|
|
54857
54947
|
/**
|
|
54858
54948
|
* Cursor for the next page; null when there are no more pages.
|
|
@@ -54874,11 +54964,11 @@ export type CreateBlogArticleData = {
|
|
|
54874
54964
|
*/
|
|
54875
54965
|
handle?: string;
|
|
54876
54966
|
/**
|
|
54877
|
-
* Tag names. WordPress
|
|
54967
|
+
* Tag names. WordPress and Wix resolve existing names case-insensitively and create missing tags (Wix allows up to 30).
|
|
54878
54968
|
*/
|
|
54879
54969
|
tags?: Array<(string)>;
|
|
54880
54970
|
/**
|
|
54881
|
-
* Shopify author display name,
|
|
54971
|
+
* Shopify author display name, numeric WordPress user id serialized as a string, or Wix site member id. Assigning another WordPress user may require elevated capability. Wix posts without one go to the site's default author.
|
|
54882
54972
|
*/
|
|
54883
54973
|
author?: string;
|
|
54884
54974
|
/**
|
|
@@ -54886,21 +54976,21 @@ export type CreateBlogArticleData = {
|
|
|
54886
54976
|
*/
|
|
54887
54977
|
excerpt?: string;
|
|
54888
54978
|
/**
|
|
54889
|
-
* Featured image from a public URL. WordPress downloads it into the media library; JPEG, PNG, GIF and WebP are accepted up to 10 MB.
|
|
54979
|
+
* Featured image from a public URL. WordPress downloads it into the media library and Wix imports it into the Media Manager; JPEG, PNG, GIF and WebP are accepted up to 10 MB.
|
|
54890
54980
|
*/
|
|
54891
54981
|
image?: {
|
|
54892
54982
|
url: string;
|
|
54893
54983
|
altText?: string;
|
|
54894
54984
|
};
|
|
54895
54985
|
/**
|
|
54896
|
-
* Shopify
|
|
54986
|
+
* Shopify and Wix. Search-engine overrides: Shopify global title_tag and description_tag metafields, Wix post SEO title and meta description. WordPress rejects this field.
|
|
54897
54987
|
*/
|
|
54898
54988
|
seo?: {
|
|
54899
54989
|
title?: string;
|
|
54900
54990
|
description?: string;
|
|
54901
54991
|
};
|
|
54902
54992
|
/**
|
|
54903
|
-
* Set false for a draft or true to publish. On WordPress false takes priority over a future publishDate; omission with no date defaults to draft.
|
|
54993
|
+
* Set false for a draft or true to publish. On WordPress and Wix false takes priority over a future publishDate; omission with no date defaults to draft.
|
|
54904
54994
|
*/
|
|
54905
54995
|
isPublished?: boolean;
|
|
54906
54996
|
/**
|
|
@@ -54910,18 +55000,18 @@ export type CreateBlogArticleData = {
|
|
|
54910
55000
|
};
|
|
54911
55001
|
path: {
|
|
54912
55002
|
/**
|
|
54913
|
-
* Connected Shopify or
|
|
55003
|
+
* Connected Shopify, WordPress or Wix account id.
|
|
54914
55004
|
*/
|
|
54915
55005
|
accountId: string;
|
|
54916
55006
|
/**
|
|
54917
|
-
* Platform-native
|
|
55007
|
+
* Platform-native blog/site id returned by the list operation.
|
|
54918
55008
|
*/
|
|
54919
55009
|
blogId: string;
|
|
54920
55010
|
};
|
|
54921
55011
|
};
|
|
54922
55012
|
|
|
54923
55013
|
export type CreateBlogArticleResponse = ({
|
|
54924
|
-
platform?: 'shopify' | 'wordpress';
|
|
55014
|
+
platform?: 'shopify' | 'wordpress' | 'wix';
|
|
54925
55015
|
article?: BlogArticle;
|
|
54926
55016
|
});
|
|
54927
55017
|
|
|
@@ -54930,22 +55020,22 @@ export type CreateBlogArticleError = (ErrorResponse | unknown);
|
|
|
54930
55020
|
export type GetBlogArticleData = {
|
|
54931
55021
|
path: {
|
|
54932
55022
|
/**
|
|
54933
|
-
* Connected Shopify or
|
|
55023
|
+
* Connected Shopify, WordPress or Wix account id.
|
|
54934
55024
|
*/
|
|
54935
55025
|
accountId: string;
|
|
54936
55026
|
/**
|
|
54937
|
-
* Platform-native
|
|
55027
|
+
* Platform-native article id: numeric on Shopify and WordPress, a GUID on Wix. Other formats return 400.
|
|
54938
55028
|
*/
|
|
54939
55029
|
articleId: string;
|
|
54940
55030
|
/**
|
|
54941
|
-
* Platform-native
|
|
55031
|
+
* Platform-native blog/site id returned by the list operation.
|
|
54942
55032
|
*/
|
|
54943
55033
|
blogId: string;
|
|
54944
55034
|
};
|
|
54945
55035
|
};
|
|
54946
55036
|
|
|
54947
55037
|
export type GetBlogArticleResponse = ({
|
|
54948
|
-
platform?: 'shopify' | 'wordpress';
|
|
55038
|
+
platform?: 'shopify' | 'wordpress' | 'wix';
|
|
54949
55039
|
article?: BlogArticle;
|
|
54950
55040
|
});
|
|
54951
55041
|
|
|
@@ -54963,11 +55053,11 @@ export type UpdateBlogArticleData = {
|
|
|
54963
55053
|
*/
|
|
54964
55054
|
handle?: string;
|
|
54965
55055
|
/**
|
|
54966
|
-
* Replaces the full tag-name list. WordPress
|
|
55056
|
+
* Replaces the full tag-name list. WordPress and Wix resolve existing names case-insensitively and create missing tags (Wix allows up to 30).
|
|
54967
55057
|
*/
|
|
54968
55058
|
tags?: Array<(string)>;
|
|
54969
55059
|
/**
|
|
54970
|
-
* Shopify author display name,
|
|
55060
|
+
* Shopify author display name, numeric WordPress user id serialized as a string, or Wix site member id. Assigning another WordPress user may require elevated capability. Wix posts without one go to the site's default author.
|
|
54971
55061
|
*/
|
|
54972
55062
|
author?: string;
|
|
54973
55063
|
/**
|
|
@@ -54975,21 +55065,21 @@ export type UpdateBlogArticleData = {
|
|
|
54975
55065
|
*/
|
|
54976
55066
|
excerpt?: string;
|
|
54977
55067
|
/**
|
|
54978
|
-
* Featured image from a public URL. WordPress downloads it into the media library; JPEG, PNG, GIF and WebP are accepted up to 10 MB. Omit to preserve it; null removal is not supported.
|
|
55068
|
+
* Featured image from a public URL. WordPress downloads it into the media library and Wix imports it into the Media Manager; JPEG, PNG, GIF and WebP are accepted up to 10 MB. Omit to preserve it; null removal is not supported.
|
|
54979
55069
|
*/
|
|
54980
55070
|
image?: {
|
|
54981
55071
|
url: string;
|
|
54982
55072
|
altText?: string;
|
|
54983
55073
|
};
|
|
54984
55074
|
/**
|
|
54985
|
-
* Shopify
|
|
55075
|
+
* Shopify and Wix. Search-engine overrides: Shopify global title_tag and description_tag metafields, Wix post SEO title and meta description. WordPress rejects this field.
|
|
54986
55076
|
*/
|
|
54987
55077
|
seo?: {
|
|
54988
55078
|
title?: string;
|
|
54989
55079
|
description?: string;
|
|
54990
55080
|
};
|
|
54991
55081
|
/**
|
|
54992
|
-
* Set false to move to draft or true to publish. On WordPress false takes priority over a future publishDate; omission preserves status unless publishDate is sent.
|
|
55082
|
+
* Set false to move to draft or true to publish. On WordPress and Wix false takes priority over a future publishDate; omission preserves status unless publishDate is sent (edits to a published Wix post go live).
|
|
54993
55083
|
*/
|
|
54994
55084
|
isPublished?: boolean;
|
|
54995
55085
|
/**
|
|
@@ -54999,22 +55089,22 @@ export type UpdateBlogArticleData = {
|
|
|
54999
55089
|
};
|
|
55000
55090
|
path: {
|
|
55001
55091
|
/**
|
|
55002
|
-
* Connected Shopify or
|
|
55092
|
+
* Connected Shopify, WordPress or Wix account id.
|
|
55003
55093
|
*/
|
|
55004
55094
|
accountId: string;
|
|
55005
55095
|
/**
|
|
55006
|
-
* Platform-native
|
|
55096
|
+
* Platform-native article id: numeric on Shopify and WordPress, a GUID on Wix. Other formats return 400.
|
|
55007
55097
|
*/
|
|
55008
55098
|
articleId: string;
|
|
55009
55099
|
/**
|
|
55010
|
-
* Platform-native
|
|
55100
|
+
* Platform-native blog/site id returned by the list operation.
|
|
55011
55101
|
*/
|
|
55012
55102
|
blogId: string;
|
|
55013
55103
|
};
|
|
55014
55104
|
};
|
|
55015
55105
|
|
|
55016
55106
|
export type UpdateBlogArticleResponse = ({
|
|
55017
|
-
platform?: 'shopify' | 'wordpress';
|
|
55107
|
+
platform?: 'shopify' | 'wordpress' | 'wix';
|
|
55018
55108
|
article?: BlogArticle;
|
|
55019
55109
|
});
|
|
55020
55110
|
|
|
@@ -55023,15 +55113,15 @@ export type UpdateBlogArticleError = (ErrorResponse | unknown);
|
|
|
55023
55113
|
export type DeleteBlogArticleData = {
|
|
55024
55114
|
path: {
|
|
55025
55115
|
/**
|
|
55026
|
-
* Connected Shopify or
|
|
55116
|
+
* Connected Shopify, WordPress or Wix account id.
|
|
55027
55117
|
*/
|
|
55028
55118
|
accountId: string;
|
|
55029
55119
|
/**
|
|
55030
|
-
* Platform-native
|
|
55120
|
+
* Platform-native article id: numeric on Shopify and WordPress, a GUID on Wix. Other formats return 400.
|
|
55031
55121
|
*/
|
|
55032
55122
|
articleId: string;
|
|
55033
55123
|
/**
|
|
55034
|
-
* Platform-native
|
|
55124
|
+
* Platform-native blog/site id returned by the list operation.
|
|
55035
55125
|
*/
|
|
55036
55126
|
blogId: string;
|
|
55037
55127
|
};
|