@zernio/node 0.2.996 → 0.2.998
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 +78 -0
- package/dist/index.d.mts +2221 -96
- package/dist/index.d.ts +2221 -96
- package/dist/index.js +524 -1
- package/dist/index.mjs +524 -1
- package/package.json +1 -1
- package/src/client.ts +154 -0
- package/src/generated/sdk.gen.ts +907 -70
- package/src/generated/types.gen.ts +2399 -96
|
@@ -3076,6 +3076,437 @@ export type CommentAutomationTemplateElement = {
|
|
|
3076
3076
|
}>;
|
|
3077
3077
|
};
|
|
3078
3078
|
|
|
3079
|
+
/**
|
|
3080
|
+
* An operation a store supports. Calling an operation outside this list answers 400 platform_not_supported.
|
|
3081
|
+
*/
|
|
3082
|
+
export type CommerceCapability = 'products.read' | 'products.create' | 'products.update' | 'products.status' | 'products.price' | 'products.variants' | 'products.images' | 'products.images_remove' | 'collections.read' | 'collections.write' | 'metafields.read' | 'metafields.write' | 'pages.read' | 'pages.write' | 'inventory.read' | 'inventory.write' | 'channels.read' | 'channels.write' | 'discounts.read' | 'discounts.write' | 'navigation.read' | 'navigation.write' | 'metaobjects.read' | 'metaobjects.write' | 'markets.read' | 'markets.write' | 'marketing.write';
|
|
3083
|
+
|
|
3084
|
+
/**
|
|
3085
|
+
* A store kept in sync with an ad-platform product catalog.
|
|
3086
|
+
*/
|
|
3087
|
+
export type CommerceCatalogSync = {
|
|
3088
|
+
id?: string;
|
|
3089
|
+
/**
|
|
3090
|
+
* The store SocialAccount id.
|
|
3091
|
+
*/
|
|
3092
|
+
accountId?: string;
|
|
3093
|
+
catalogPlatform?: 'meta';
|
|
3094
|
+
/**
|
|
3095
|
+
* The Meta login account whose token writes to the catalog.
|
|
3096
|
+
*/
|
|
3097
|
+
catalogAccountId?: string;
|
|
3098
|
+
catalogId?: string;
|
|
3099
|
+
runStatus?: 'pending' | 'running' | 'succeeded' | 'failed';
|
|
3100
|
+
lastRunStartedAt?: (string) | null;
|
|
3101
|
+
lastRunFinishedAt?: (string) | null;
|
|
3102
|
+
/**
|
|
3103
|
+
* Why the last run failed, or how many items Meta rejected in a run that otherwise succeeded. Null after a clean run.
|
|
3104
|
+
*/
|
|
3105
|
+
lastError?: (string) | null;
|
|
3106
|
+
/**
|
|
3107
|
+
* Catalog items (one per variant) Meta accepted in the last full run.
|
|
3108
|
+
*/
|
|
3109
|
+
itemsSent?: number;
|
|
3110
|
+
/**
|
|
3111
|
+
* Products the last full run could not list: not published to the online store or without an image.
|
|
3112
|
+
*/
|
|
3113
|
+
itemsSkipped?: number;
|
|
3114
|
+
/**
|
|
3115
|
+
* Items the last full run removed because the store no longer has them.
|
|
3116
|
+
*/
|
|
3117
|
+
itemsDeleted?: number;
|
|
3118
|
+
createdAt?: string;
|
|
3119
|
+
};
|
|
3120
|
+
|
|
3121
|
+
export type catalogPlatform = 'meta';
|
|
3122
|
+
|
|
3123
|
+
export type runStatus = 'pending' | 'running' | 'succeeded' | 'failed';
|
|
3124
|
+
|
|
3125
|
+
export type CommerceChannel = {
|
|
3126
|
+
id?: string;
|
|
3127
|
+
name?: string;
|
|
3128
|
+
};
|
|
3129
|
+
|
|
3130
|
+
/**
|
|
3131
|
+
* A product collection on a connected store.
|
|
3132
|
+
*/
|
|
3133
|
+
export type CommerceCollection = {
|
|
3134
|
+
/**
|
|
3135
|
+
* Platform-native collection id.
|
|
3136
|
+
*/
|
|
3137
|
+
id?: string;
|
|
3138
|
+
accountId?: string;
|
|
3139
|
+
platform?: 'shopify' | 'woocommerce';
|
|
3140
|
+
title?: string;
|
|
3141
|
+
handle?: (string) | null;
|
|
3142
|
+
descriptionHtml?: (string) | null;
|
|
3143
|
+
image?: (CommerceImage | null);
|
|
3144
|
+
sortOrder?: 'manual' | 'best_selling' | 'alpha_asc' | 'alpha_desc' | 'price_asc' | 'price_desc' | 'created' | 'created_desc' | 'most_relevant';
|
|
3145
|
+
/**
|
|
3146
|
+
* Updates a few seconds after a membership change.
|
|
3147
|
+
*/
|
|
3148
|
+
productCount?: (number) | null;
|
|
3149
|
+
seo?: {
|
|
3150
|
+
title?: (string) | null;
|
|
3151
|
+
description?: (string) | null;
|
|
3152
|
+
};
|
|
3153
|
+
updatedAt?: (string) | null;
|
|
3154
|
+
platformData?: {
|
|
3155
|
+
[key: string]: unknown;
|
|
3156
|
+
} | null;
|
|
3157
|
+
};
|
|
3158
|
+
|
|
3159
|
+
export type platform4 = 'shopify' | 'woocommerce';
|
|
3160
|
+
|
|
3161
|
+
export type sortOrder = 'manual' | 'best_selling' | 'alpha_asc' | 'alpha_desc' | 'price_asc' | 'price_desc' | 'created' | 'created_desc' | 'most_relevant';
|
|
3162
|
+
|
|
3163
|
+
export type CommerceDiscount = {
|
|
3164
|
+
id?: string;
|
|
3165
|
+
accountId?: string;
|
|
3166
|
+
platform?: 'shopify';
|
|
3167
|
+
title?: string;
|
|
3168
|
+
method?: 'code' | 'automatic';
|
|
3169
|
+
type?: 'percentage' | 'fixed_amount' | 'free_shipping' | 'buy_x_get_y' | 'app';
|
|
3170
|
+
/**
|
|
3171
|
+
* The first 10 codes; codeCount has the total.
|
|
3172
|
+
*/
|
|
3173
|
+
codes?: Array<(string)>;
|
|
3174
|
+
codeCount?: (number) | null;
|
|
3175
|
+
/**
|
|
3176
|
+
* Null for free shipping, buy-X-get-Y and app discounts.
|
|
3177
|
+
*/
|
|
3178
|
+
value?: ({
|
|
3179
|
+
type?: 'percentage';
|
|
3180
|
+
percentage?: number;
|
|
3181
|
+
} | {
|
|
3182
|
+
type?: 'fixed_amount';
|
|
3183
|
+
amount?: CommerceMoney;
|
|
3184
|
+
appliesOnEachItem?: boolean;
|
|
3185
|
+
} | null);
|
|
3186
|
+
appliesTo?: {
|
|
3187
|
+
type?: 'all' | 'products' | 'collections';
|
|
3188
|
+
productIds?: Array<(string)>;
|
|
3189
|
+
variantIds?: Array<(string)>;
|
|
3190
|
+
collectionIds?: Array<(string)>;
|
|
3191
|
+
} | null;
|
|
3192
|
+
minimum?: {
|
|
3193
|
+
type?: 'subtotal' | 'quantity';
|
|
3194
|
+
amount?: CommerceMoney;
|
|
3195
|
+
quantity?: number;
|
|
3196
|
+
} | null;
|
|
3197
|
+
usageLimit?: (number) | null;
|
|
3198
|
+
oncePerCustomer?: boolean;
|
|
3199
|
+
usageCount?: number;
|
|
3200
|
+
startsAt?: string;
|
|
3201
|
+
endsAt?: (string) | null;
|
|
3202
|
+
status?: 'active' | 'scheduled' | 'expired';
|
|
3203
|
+
platformStatus?: string;
|
|
3204
|
+
summary?: string;
|
|
3205
|
+
platformData?: {
|
|
3206
|
+
[key: string]: unknown;
|
|
3207
|
+
} | null;
|
|
3208
|
+
};
|
|
3209
|
+
|
|
3210
|
+
export type platform5 = 'shopify';
|
|
3211
|
+
|
|
3212
|
+
export type method = 'code' | 'automatic';
|
|
3213
|
+
|
|
3214
|
+
export type type3 = 'percentage' | 'fixed_amount' | 'free_shipping' | 'buy_x_get_y' | 'app';
|
|
3215
|
+
|
|
3216
|
+
export type status10 = 'active' | 'scheduled' | 'expired';
|
|
3217
|
+
|
|
3218
|
+
export type CommerceImage = {
|
|
3219
|
+
/**
|
|
3220
|
+
* Media id, used to reorder or remove images. Null for collection images.
|
|
3221
|
+
*/
|
|
3222
|
+
id?: (string) | null;
|
|
3223
|
+
url?: string;
|
|
3224
|
+
altText?: (string) | null;
|
|
3225
|
+
};
|
|
3226
|
+
|
|
3227
|
+
export type CommerceInventoryItem = {
|
|
3228
|
+
productId?: string;
|
|
3229
|
+
variantId?: string;
|
|
3230
|
+
sku?: (string) | null;
|
|
3231
|
+
/**
|
|
3232
|
+
* False when the platform does not count stock for the variant.
|
|
3233
|
+
*/
|
|
3234
|
+
tracked?: boolean;
|
|
3235
|
+
levels?: Array<{
|
|
3236
|
+
locationId?: string;
|
|
3237
|
+
available?: (number) | null;
|
|
3238
|
+
onHand?: (number) | null;
|
|
3239
|
+
/**
|
|
3240
|
+
* Reserved for unfulfilled orders.
|
|
3241
|
+
*/
|
|
3242
|
+
committed?: (number) | null;
|
|
3243
|
+
incoming?: (number) | null;
|
|
3244
|
+
}>;
|
|
3245
|
+
};
|
|
3246
|
+
|
|
3247
|
+
export type CommerceLocation = {
|
|
3248
|
+
id?: string;
|
|
3249
|
+
name?: string;
|
|
3250
|
+
isActive?: boolean;
|
|
3251
|
+
fulfillsOnlineOrders?: boolean;
|
|
3252
|
+
address?: {
|
|
3253
|
+
line1?: (string) | null;
|
|
3254
|
+
line2?: (string) | null;
|
|
3255
|
+
city?: (string) | null;
|
|
3256
|
+
region?: (string) | null;
|
|
3257
|
+
postalCode?: (string) | null;
|
|
3258
|
+
countryCode?: (string) | null;
|
|
3259
|
+
phone?: (string) | null;
|
|
3260
|
+
};
|
|
3261
|
+
};
|
|
3262
|
+
|
|
3263
|
+
export type CommerceMarket = {
|
|
3264
|
+
id?: string;
|
|
3265
|
+
name?: string;
|
|
3266
|
+
handle?: string;
|
|
3267
|
+
status?: 'active' | 'draft';
|
|
3268
|
+
type?: string;
|
|
3269
|
+
};
|
|
3270
|
+
|
|
3271
|
+
export type status11 = 'active' | 'draft';
|
|
3272
|
+
|
|
3273
|
+
export type CommerceMenu = {
|
|
3274
|
+
id?: string;
|
|
3275
|
+
handle?: string;
|
|
3276
|
+
title?: string;
|
|
3277
|
+
items?: Array<CommerceMenuItem>;
|
|
3278
|
+
};
|
|
3279
|
+
|
|
3280
|
+
export type CommerceMenuItem = {
|
|
3281
|
+
id?: (string) | null;
|
|
3282
|
+
title?: string;
|
|
3283
|
+
type?: 'frontpage' | 'collection' | 'collections' | 'product' | 'catalog' | 'page' | 'blog' | 'article' | 'search' | 'shop_policy' | 'http' | 'metaobject' | 'customer_account_page';
|
|
3284
|
+
url?: (string) | null;
|
|
3285
|
+
/**
|
|
3286
|
+
* The linked product, collection, page, blog, article or metaobject id.
|
|
3287
|
+
*/
|
|
3288
|
+
resourceId?: (string) | null;
|
|
3289
|
+
items?: Array<CommerceMenuItem>;
|
|
3290
|
+
};
|
|
3291
|
+
|
|
3292
|
+
export type type4 = 'frontpage' | 'collection' | 'collections' | 'product' | 'catalog' | 'page' | 'blog' | 'article' | 'search' | 'shop_policy' | 'http' | 'metaobject' | 'customer_account_page';
|
|
3293
|
+
|
|
3294
|
+
export type CommerceMenuItemInput = {
|
|
3295
|
+
title: string;
|
|
3296
|
+
type: 'frontpage' | 'collection' | 'collections' | 'product' | 'catalog' | 'page' | 'blog' | 'article' | 'search' | 'shop_policy' | 'http' | 'metaobject' | 'customer_account_page';
|
|
3297
|
+
/**
|
|
3298
|
+
* For http items.
|
|
3299
|
+
*/
|
|
3300
|
+
url?: string;
|
|
3301
|
+
/**
|
|
3302
|
+
* For product, collection, page, blog, article and metaobject items.
|
|
3303
|
+
*/
|
|
3304
|
+
resourceId?: string;
|
|
3305
|
+
items?: Array<CommerceMenuItemInput>;
|
|
3306
|
+
};
|
|
3307
|
+
|
|
3308
|
+
export type CommerceMetafield = {
|
|
3309
|
+
namespace: string;
|
|
3310
|
+
key: string;
|
|
3311
|
+
/**
|
|
3312
|
+
* Platform value type, e.g. single_line_text_field, number_integer, json.
|
|
3313
|
+
*/
|
|
3314
|
+
type: string;
|
|
3315
|
+
/**
|
|
3316
|
+
* The value serialized as a string, JSON for structured types.
|
|
3317
|
+
*/
|
|
3318
|
+
value: string;
|
|
3319
|
+
};
|
|
3320
|
+
|
|
3321
|
+
export type CommerceMetaobject = {
|
|
3322
|
+
id?: string;
|
|
3323
|
+
type?: string;
|
|
3324
|
+
handle?: string;
|
|
3325
|
+
displayName?: string;
|
|
3326
|
+
fields?: Array<{
|
|
3327
|
+
key?: string;
|
|
3328
|
+
type?: string;
|
|
3329
|
+
value?: (string) | null;
|
|
3330
|
+
}>;
|
|
3331
|
+
};
|
|
3332
|
+
|
|
3333
|
+
export type CommerceMetaobjectDefinition = {
|
|
3334
|
+
id?: string;
|
|
3335
|
+
type?: string;
|
|
3336
|
+
name?: string;
|
|
3337
|
+
fields?: Array<{
|
|
3338
|
+
key?: string;
|
|
3339
|
+
name?: string;
|
|
3340
|
+
type?: string;
|
|
3341
|
+
required?: boolean;
|
|
3342
|
+
}>;
|
|
3343
|
+
};
|
|
3344
|
+
|
|
3345
|
+
/**
|
|
3346
|
+
* An exact amount of money. The amount is a decimal string so cents are never lost to floating point.
|
|
3347
|
+
*/
|
|
3348
|
+
export type CommerceMoney = {
|
|
3349
|
+
amount: string;
|
|
3350
|
+
/**
|
|
3351
|
+
* ISO 4217 code. Never null: the store currency is filled in when the platform omits it.
|
|
3352
|
+
*/
|
|
3353
|
+
currency: string;
|
|
3354
|
+
};
|
|
3355
|
+
|
|
3356
|
+
export type CommercePage = {
|
|
3357
|
+
id?: string;
|
|
3358
|
+
accountId?: string;
|
|
3359
|
+
platform?: 'shopify';
|
|
3360
|
+
title?: string;
|
|
3361
|
+
handle?: string;
|
|
3362
|
+
bodyHtml?: string;
|
|
3363
|
+
isPublished?: boolean;
|
|
3364
|
+
publishedAt?: (string) | null;
|
|
3365
|
+
createdAt?: (string) | null;
|
|
3366
|
+
updatedAt?: (string) | null;
|
|
3367
|
+
};
|
|
3368
|
+
|
|
3369
|
+
export type CommercePriceList = {
|
|
3370
|
+
id?: string;
|
|
3371
|
+
name?: string;
|
|
3372
|
+
currency?: string;
|
|
3373
|
+
};
|
|
3374
|
+
|
|
3375
|
+
/**
|
|
3376
|
+
* A product on a connected store, in the platform-neutral shape.
|
|
3377
|
+
*/
|
|
3378
|
+
export type CommerceProduct = {
|
|
3379
|
+
/**
|
|
3380
|
+
* Platform-native product id.
|
|
3381
|
+
*/
|
|
3382
|
+
id?: string;
|
|
3383
|
+
accountId?: string;
|
|
3384
|
+
platform?: 'shopify';
|
|
3385
|
+
title?: string;
|
|
3386
|
+
descriptionHtml?: (string) | null;
|
|
3387
|
+
/**
|
|
3388
|
+
* URL slug of the product.
|
|
3389
|
+
*/
|
|
3390
|
+
handle?: (string) | null;
|
|
3391
|
+
vendor?: (string) | null;
|
|
3392
|
+
productType?: (string) | null;
|
|
3393
|
+
tags?: Array<(string)>;
|
|
3394
|
+
status?: CommerceProductStatus;
|
|
3395
|
+
/**
|
|
3396
|
+
* The raw status on the platform, e.g. ACTIVE on Shopify.
|
|
3397
|
+
*/
|
|
3398
|
+
platformStatus?: string;
|
|
3399
|
+
featuredImage?: (CommerceImage | null);
|
|
3400
|
+
/**
|
|
3401
|
+
* First 20 images, in store order.
|
|
3402
|
+
*/
|
|
3403
|
+
images?: Array<CommerceImage>;
|
|
3404
|
+
/**
|
|
3405
|
+
* Option axes (e.g. Size, Color) and their values.
|
|
3406
|
+
*/
|
|
3407
|
+
options?: Array<{
|
|
3408
|
+
name?: string;
|
|
3409
|
+
values?: Array<(string)>;
|
|
3410
|
+
}>;
|
|
3411
|
+
/**
|
|
3412
|
+
* First 100 variants.
|
|
3413
|
+
*/
|
|
3414
|
+
variants?: Array<CommerceVariant>;
|
|
3415
|
+
totalInventory?: (number) | null;
|
|
3416
|
+
/**
|
|
3417
|
+
* Public storefront URL; null while the product is not published.
|
|
3418
|
+
*/
|
|
3419
|
+
url?: (string) | null;
|
|
3420
|
+
seo?: {
|
|
3421
|
+
title?: (string) | null;
|
|
3422
|
+
description?: (string) | null;
|
|
3423
|
+
};
|
|
3424
|
+
createdAt?: (string) | null;
|
|
3425
|
+
updatedAt?: (string) | null;
|
|
3426
|
+
publishedAt?: (string) | null;
|
|
3427
|
+
/**
|
|
3428
|
+
* Platform-only fields. Null when the platform has none.
|
|
3429
|
+
*/
|
|
3430
|
+
platformData?: {
|
|
3431
|
+
[key: string]: unknown;
|
|
3432
|
+
} | null;
|
|
3433
|
+
};
|
|
3434
|
+
|
|
3435
|
+
/**
|
|
3436
|
+
* Zernio product status. The platform value is returned as platformStatus. Shopify: ACTIVE, DRAFT and ARCHIVED map to the same names; UNLISTED maps to inactive.
|
|
3437
|
+
*/
|
|
3438
|
+
export type CommerceProductStatus = 'active' | 'draft' | 'pending_review' | 'rejected' | 'inactive' | 'archived' | 'deleted';
|
|
3439
|
+
|
|
3440
|
+
export type CommerceRedirect = {
|
|
3441
|
+
id?: string;
|
|
3442
|
+
path?: string;
|
|
3443
|
+
target?: string;
|
|
3444
|
+
};
|
|
3445
|
+
|
|
3446
|
+
export type CommerceStore = {
|
|
3447
|
+
/**
|
|
3448
|
+
* Zernio SocialAccount id of the store.
|
|
3449
|
+
*/
|
|
3450
|
+
accountId: string;
|
|
3451
|
+
platform: 'shopify' | 'woocommerce';
|
|
3452
|
+
name: string;
|
|
3453
|
+
/**
|
|
3454
|
+
* The platform domain of the store, e.g. my-store.myshopify.com.
|
|
3455
|
+
*/
|
|
3456
|
+
domain: string;
|
|
3457
|
+
/**
|
|
3458
|
+
* Public storefront URL.
|
|
3459
|
+
*/
|
|
3460
|
+
url: (string) | null;
|
|
3461
|
+
/**
|
|
3462
|
+
* ISO 4217 code the store sells in.
|
|
3463
|
+
*/
|
|
3464
|
+
currency: string;
|
|
3465
|
+
/**
|
|
3466
|
+
* ISO 3166-1 alpha-2 country of the store.
|
|
3467
|
+
*/
|
|
3468
|
+
country: (string) | null;
|
|
3469
|
+
capabilities: Array<CommerceCapability>;
|
|
3470
|
+
/**
|
|
3471
|
+
* Capabilities the platform supports that this store has not granted yet.
|
|
3472
|
+
*/
|
|
3473
|
+
missingCapabilities: Array<CommerceCapability>;
|
|
3474
|
+
/**
|
|
3475
|
+
* Shopify: a page in the Shopify admin where the store owner approves the permissions missingCapabilities need, on the existing install (no reinstall; they can revoke them later). Null when nothing is missing or the store cannot grant them this way (a store connected with its own custom-app token).
|
|
3476
|
+
*/
|
|
3477
|
+
grantPermissionsUrl: (string) | null;
|
|
3478
|
+
};
|
|
3479
|
+
|
|
3480
|
+
/**
|
|
3481
|
+
* A purchasable variant of a product (one per option combination).
|
|
3482
|
+
*/
|
|
3483
|
+
export type CommerceVariant = {
|
|
3484
|
+
/**
|
|
3485
|
+
* Platform-native variant id.
|
|
3486
|
+
*/
|
|
3487
|
+
id?: string;
|
|
3488
|
+
/**
|
|
3489
|
+
* Option combination label, e.g. "S / Blue".
|
|
3490
|
+
*/
|
|
3491
|
+
title?: string;
|
|
3492
|
+
sku?: (string) | null;
|
|
3493
|
+
barcode?: (string) | null;
|
|
3494
|
+
price?: CommerceMoney;
|
|
3495
|
+
/**
|
|
3496
|
+
* Strike-through price; null when the variant is not on sale.
|
|
3497
|
+
*/
|
|
3498
|
+
compareAtPrice?: (CommerceMoney | null);
|
|
3499
|
+
/**
|
|
3500
|
+
* Units on hand; null when inventory is not tracked.
|
|
3501
|
+
*/
|
|
3502
|
+
inventoryQuantity?: (number) | null;
|
|
3503
|
+
availableForSale?: (boolean) | null;
|
|
3504
|
+
options?: Array<{
|
|
3505
|
+
name?: string;
|
|
3506
|
+
value?: string;
|
|
3507
|
+
}>;
|
|
3508
|
+
};
|
|
3509
|
+
|
|
3079
3510
|
/**
|
|
3080
3511
|
* An OAuth client (AI assistant / MCP connector) authorized by the user and still
|
|
3081
3512
|
* holding at least one live token.
|
|
@@ -3227,7 +3658,7 @@ export type ConversionDestination = {
|
|
|
3227
3658
|
* For LinkedIn, `inactive` means the rule is soft-deleted (`enabled: false`).
|
|
3228
3659
|
*
|
|
3229
3660
|
*/
|
|
3230
|
-
export type
|
|
3661
|
+
export type status12 = 'active' | 'inactive';
|
|
3231
3662
|
|
|
3232
3663
|
/**
|
|
3233
3664
|
* A single conversion event to relay to the ad platform. All PII fields
|
|
@@ -3911,7 +4342,7 @@ export type objective = 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS'
|
|
|
3911
4342
|
* newly created ad(s) after Meta accepts them.
|
|
3912
4343
|
*
|
|
3913
4344
|
*/
|
|
3914
|
-
export type
|
|
4345
|
+
export type status13 = 'ACTIVE' | 'PAUSED';
|
|
3915
4346
|
|
|
3916
4347
|
/**
|
|
3917
4348
|
* Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
|
|
@@ -4283,7 +4714,7 @@ export type privacy_level = 2;
|
|
|
4283
4714
|
/**
|
|
4284
4715
|
* 1=SCHEDULED, 2=ACTIVE, 3=COMPLETED, 4=CANCELED
|
|
4285
4716
|
*/
|
|
4286
|
-
export type
|
|
4717
|
+
export type status14 = 1 | 2 | 3 | 4;
|
|
4287
4718
|
|
|
4288
4719
|
/**
|
|
4289
4720
|
* 1=STAGE_INSTANCE, 2=VOICE, 3=EXTERNAL
|
|
@@ -4317,7 +4748,7 @@ export type DmButton = {
|
|
|
4317
4748
|
phone?: string;
|
|
4318
4749
|
};
|
|
4319
4750
|
|
|
4320
|
-
export type
|
|
4751
|
+
export type type5 = 'url' | 'postback' | 'phone';
|
|
4321
4752
|
|
|
4322
4753
|
/**
|
|
4323
4754
|
* Canonical error envelope. `error` is the human-readable message; `type`,
|
|
@@ -4438,7 +4869,7 @@ export type ErrorResponse = {
|
|
|
4438
4869
|
/**
|
|
4439
4870
|
* Error class for programmatic handling.
|
|
4440
4871
|
*/
|
|
4441
|
-
export type
|
|
4872
|
+
export type type6 = 'invalid_request_error' | 'authentication_error' | 'permission_error' | 'not_found' | 'rate_limit_error' | 'platform_error' | 'api_error';
|
|
4442
4873
|
|
|
4443
4874
|
/**
|
|
4444
4875
|
* Meta ad create failures only. The step that failed: `media` (image/video download or upload), `campaign`, `adset`, `creative`, `ad` (the ad POST itself, where Meta's code 31 / 3858385 hold and 100 / 1359188 payment rejections land), `activation` (switching the created objects on), or `other` (a read or check before any write).
|
|
@@ -4479,7 +4910,7 @@ export type ExternalPostMediaItem = {
|
|
|
4479
4910
|
unavailableReason?: 'platform_withheld';
|
|
4480
4911
|
};
|
|
4481
4912
|
|
|
4482
|
-
export type
|
|
4913
|
+
export type type7 = 'image' | 'video';
|
|
4483
4914
|
|
|
4484
4915
|
/**
|
|
4485
4916
|
* unavailable means the media file could not be retrieved (url is null or, for LinkedIn videos, a cover image standing in for the file). available or absent means the file is available at url (older synced items omit the field).
|
|
@@ -4811,7 +5242,7 @@ export type FeedbackReceipt = {
|
|
|
4811
5242
|
duplicate?: boolean;
|
|
4812
5243
|
};
|
|
4813
5244
|
|
|
4814
|
-
export type
|
|
5245
|
+
export type status15 = 'received';
|
|
4815
5246
|
|
|
4816
5247
|
export type FollowerStatsResponse = {
|
|
4817
5248
|
accounts?: Array<AccountWithFollowerStats>;
|
|
@@ -4936,7 +5367,7 @@ export type GoogleAdLabel = {
|
|
|
4936
5367
|
description?: (string) | null;
|
|
4937
5368
|
};
|
|
4938
5369
|
|
|
4939
|
-
export type
|
|
5370
|
+
export type status16 = 'ENABLED' | 'REMOVED' | 'UNKNOWN';
|
|
4940
5371
|
|
|
4941
5372
|
/**
|
|
4942
5373
|
* At least one id across the four target lists. Up to 1000 ids per list.
|
|
@@ -5034,7 +5465,7 @@ export type GoogleAdsManagerLink = {
|
|
|
5034
5465
|
/**
|
|
5035
5466
|
* Status the link has after this call.
|
|
5036
5467
|
*/
|
|
5037
|
-
export type
|
|
5468
|
+
export type status17 = 'PENDING' | 'ACTIVE' | 'REFUSED' | 'CANCELED' | 'INACTIVE';
|
|
5038
5469
|
|
|
5039
5470
|
/**
|
|
5040
5471
|
* Link one asset to the asset group. Send exactly one of asset (an existing asset), text, imageUrl or youtubeVideoId (new content, created in the same request).
|
|
@@ -5206,7 +5637,7 @@ export type topicType = 'STANDARD' | 'EVENT' | 'OFFER';
|
|
|
5206
5637
|
/**
|
|
5207
5638
|
* Button action type: LEARN_MORE, BOOK, ORDER, SHOP, SIGN_UP, CALL
|
|
5208
5639
|
*/
|
|
5209
|
-
export type
|
|
5640
|
+
export type type8 = 'LEARN_MORE' | 'BOOK' | 'ORDER' | 'SHOP' | 'SIGN_UP' | 'CALL';
|
|
5210
5641
|
|
|
5211
5642
|
/**
|
|
5212
5643
|
* A Google Business Profile review, as returned by every gmb-reviews read endpoint.
|
|
@@ -5524,7 +5955,7 @@ export type GoogleListingGroupFilterNode = {
|
|
|
5524
5955
|
} | null;
|
|
5525
5956
|
};
|
|
5526
5957
|
|
|
5527
|
-
export type
|
|
5958
|
+
export type type9 = 'SUBDIVISION' | 'UNIT_INCLUDED' | 'UNIT_EXCLUDED';
|
|
5528
5959
|
|
|
5529
5960
|
export type GoogleListingGroupNode = {
|
|
5530
5961
|
dimension: GoogleListingGroupDimension;
|
|
@@ -5755,7 +6186,7 @@ export type GoogleRecommendationResult = {
|
|
|
5755
6186
|
error?: string;
|
|
5756
6187
|
};
|
|
5757
6188
|
|
|
5758
|
-
export type
|
|
6189
|
+
export type status18 = 'applied' | 'dismissed' | 'failed';
|
|
5759
6190
|
|
|
5760
6191
|
export type GoogleRsaDescription = {
|
|
5761
6192
|
text: string;
|
|
@@ -5850,7 +6281,7 @@ export type ImessageSender = {
|
|
|
5850
6281
|
isActive?: boolean;
|
|
5851
6282
|
};
|
|
5852
6283
|
|
|
5853
|
-
export type
|
|
6284
|
+
export type platform6 = 'imessage';
|
|
5854
6285
|
|
|
5855
6286
|
/**
|
|
5856
6287
|
* A provisioned iMessage sender order and its lifecycle. Activation is asynchronous: poll GET /v1/imessage/senders/{senderId} or subscribe to account.connected.
|
|
@@ -5887,7 +6318,7 @@ export type kind = 'phone' | 'email';
|
|
|
5887
6318
|
|
|
5888
6319
|
export type region = 'US' | 'GB';
|
|
5889
6320
|
|
|
5890
|
-
export type
|
|
6321
|
+
export type status19 = 'ordering' | 'activating' | 'active' | 'suspended' | 'canceled' | 'failed';
|
|
5891
6322
|
|
|
5892
6323
|
/**
|
|
5893
6324
|
* Attachment snapshot inside an edit-history entry.
|
|
@@ -5959,7 +6390,7 @@ export type InboxWebhookConversation = {
|
|
|
5959
6390
|
contactId?: string;
|
|
5960
6391
|
};
|
|
5961
6392
|
|
|
5962
|
-
export type
|
|
6393
|
+
export type status20 = 'active' | 'archived';
|
|
5963
6394
|
|
|
5964
6395
|
/**
|
|
5965
6396
|
* The conversation object included in conversation lifecycle webhook payloads (conversation.started, conversation.control_changed).
|
|
@@ -5997,7 +6428,7 @@ export type InboxWebhookConversationDetail = {
|
|
|
5997
6428
|
contactId?: string;
|
|
5998
6429
|
};
|
|
5999
6430
|
|
|
6000
|
-
export type
|
|
6431
|
+
export type platform7 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'rcs' | 'slack' | 'tiktok' | 'imessage';
|
|
6001
6432
|
|
|
6002
6433
|
/**
|
|
6003
6434
|
* The message object included in inbox webhook payloads.
|
|
@@ -6113,7 +6544,7 @@ export type InboxWebhookMessage = {
|
|
|
6113
6544
|
isRead: boolean;
|
|
6114
6545
|
};
|
|
6115
6546
|
|
|
6116
|
-
export type
|
|
6547
|
+
export type platform8 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'sms';
|
|
6117
6548
|
|
|
6118
6549
|
export type direction2 = 'incoming' | 'outgoing';
|
|
6119
6550
|
|
|
@@ -6241,7 +6672,7 @@ export type InstagramAccountInsightsResponse = {
|
|
|
6241
6672
|
/**
|
|
6242
6673
|
* Platform that served this response.
|
|
6243
6674
|
*/
|
|
6244
|
-
export type
|
|
6675
|
+
export type platform9 = 'facebook' | 'instagram' | 'youtube' | 'linkedin' | 'tiktok';
|
|
6245
6676
|
|
|
6246
6677
|
export type metricType = 'time_series' | 'total_value';
|
|
6247
6678
|
|
|
@@ -7025,7 +7456,7 @@ export type MediaItem = {
|
|
|
7025
7456
|
tiktokProcessed?: boolean;
|
|
7026
7457
|
};
|
|
7027
7458
|
|
|
7028
|
-
export type
|
|
7459
|
+
export type type10 = 'image' | 'video' | 'gif' | 'document';
|
|
7029
7460
|
|
|
7030
7461
|
export type MediaUploadResponse = {
|
|
7031
7462
|
files?: Array<UploadedFile>;
|
|
@@ -7676,7 +8107,7 @@ export type OwnedPhoneNumber = {
|
|
|
7676
8107
|
}>;
|
|
7677
8108
|
};
|
|
7678
8109
|
|
|
7679
|
-
export type
|
|
8110
|
+
export type status21 = 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
7680
8111
|
|
|
7681
8112
|
export type metaVerificationStatus = 'pending' | 'code_requested' | 'verified' | 'expired';
|
|
7682
8113
|
|
|
@@ -7806,7 +8237,7 @@ export type PlatformAnalytics = {
|
|
|
7806
8237
|
errorMessage?: (string) | null;
|
|
7807
8238
|
};
|
|
7808
8239
|
|
|
7809
|
-
export type
|
|
8240
|
+
export type status22 = 'published' | 'failed';
|
|
7810
8241
|
|
|
7811
8242
|
/**
|
|
7812
8243
|
* Sync state of analytics for this platform
|
|
@@ -7935,7 +8366,7 @@ export type PortfolioBidStrategy = {
|
|
|
7935
8366
|
targetRoas?: (number) | null;
|
|
7936
8367
|
};
|
|
7937
8368
|
|
|
7938
|
-
export type
|
|
8369
|
+
export type type11 = 'TARGET_CPA' | 'TARGET_ROAS' | 'MAXIMIZE_CONVERSIONS' | 'MAXIMIZE_CONVERSION_VALUE';
|
|
7939
8370
|
|
|
7940
8371
|
export type Post = {
|
|
7941
8372
|
_id?: string;
|
|
@@ -8206,9 +8637,7 @@ export type Product = {
|
|
|
8206
8637
|
publishedAt?: (string) | null;
|
|
8207
8638
|
};
|
|
8208
8639
|
|
|
8209
|
-
export type
|
|
8210
|
-
|
|
8211
|
-
export type status21 = 'active' | 'draft' | 'archived';
|
|
8640
|
+
export type status23 = 'active' | 'draft' | 'archived';
|
|
8212
8641
|
|
|
8213
8642
|
export type ProductImage = {
|
|
8214
8643
|
url?: string;
|
|
@@ -8415,7 +8844,7 @@ export type RcsAgent = {
|
|
|
8415
8844
|
createdAt?: string;
|
|
8416
8845
|
};
|
|
8417
8846
|
|
|
8418
|
-
export type
|
|
8847
|
+
export type status24 = 'requested' | 'changes_requested' | 'brand_vetting' | 'agent_review' | 'testing' | 'launch_review' | 'launching' | 'live' | 'rejected' | 'deactivated';
|
|
8419
8848
|
|
|
8420
8849
|
export type useCase = 'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP';
|
|
8421
8850
|
|
|
@@ -8467,7 +8896,7 @@ export type RcsBrand = RcsBrandInput & {
|
|
|
8467
8896
|
/**
|
|
8468
8897
|
* draft = not filed yet (still editable).
|
|
8469
8898
|
*/
|
|
8470
|
-
export type
|
|
8899
|
+
export type status25 = 'draft' | 'vetting' | 'verified' | 'rejected';
|
|
8471
8900
|
|
|
8472
8901
|
export type RcsBrandInput = {
|
|
8473
8902
|
displayName: string;
|
|
@@ -8554,7 +8983,7 @@ export type RcsCarrierApproval = {
|
|
|
8554
8983
|
|
|
8555
8984
|
export type scope2 = 'carrier' | 'hub' | 'bot';
|
|
8556
8985
|
|
|
8557
|
-
export type
|
|
8986
|
+
export type status26 = 'PENDING' | 'SUBMITTED' | 'APPROVED' | 'REJECTED';
|
|
8558
8987
|
|
|
8559
8988
|
/**
|
|
8560
8989
|
* Message content. `suggestions` (max 11) render as chips under the message.
|
|
@@ -8580,7 +9009,7 @@ export type RcsContent = {
|
|
|
8580
9009
|
suggestions?: Array<RcsSuggestion>;
|
|
8581
9010
|
};
|
|
8582
9011
|
|
|
8583
|
-
export type
|
|
9012
|
+
export type type12 = 'text';
|
|
8584
9013
|
|
|
8585
9014
|
export type orientation = 'VERTICAL' | 'HORIZONTAL';
|
|
8586
9015
|
|
|
@@ -8693,7 +9122,7 @@ export type RcsSuggestion = {
|
|
|
8693
9122
|
postbackData?: string;
|
|
8694
9123
|
};
|
|
8695
9124
|
|
|
8696
|
-
export type
|
|
9125
|
+
export type type13 = 'reply';
|
|
8697
9126
|
|
|
8698
9127
|
export type application = 'BROWSER' | 'WEBVIEW';
|
|
8699
9128
|
|
|
@@ -8957,7 +9386,7 @@ export type ReviewWebhookReview = {
|
|
|
8957
9386
|
/**
|
|
8958
9387
|
* Platform the review originated on. Currently Google Business Profile only.
|
|
8959
9388
|
*/
|
|
8960
|
-
export type
|
|
9389
|
+
export type platform10 = 'googlebusiness';
|
|
8961
9390
|
|
|
8962
9391
|
/**
|
|
8963
9392
|
* A Meta Reach & Frequency prediction. Money values in whole units of the ad account currency.
|
|
@@ -9163,7 +9592,7 @@ export type SocialAccount = {
|
|
|
9163
9592
|
};
|
|
9164
9593
|
};
|
|
9165
9594
|
|
|
9166
|
-
export type
|
|
9595
|
+
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' | 'sms' | 'phone' | 'rcs';
|
|
9167
9596
|
|
|
9168
9597
|
/**
|
|
9169
9598
|
* A tracking tag's install on a connected store: a Shopify web pixel, or a Custom HTML widget on a WordPress site. Fields marked Shopify or WordPress are present only for that platform.
|
|
@@ -9238,7 +9667,7 @@ export type StorePixelInstall = {
|
|
|
9238
9667
|
/**
|
|
9239
9668
|
* WordPress only.
|
|
9240
9669
|
*/
|
|
9241
|
-
export type
|
|
9670
|
+
export type method2 = 'wordpress_widget';
|
|
9242
9671
|
|
|
9243
9672
|
/**
|
|
9244
9673
|
* Normalized, platform-agnostic ad-targeting spec. Every field is optional, an
|
|
@@ -9805,7 +10234,7 @@ export type TrackingTag = {
|
|
|
9805
10234
|
autoTagging?: boolean;
|
|
9806
10235
|
};
|
|
9807
10236
|
|
|
9808
|
-
export type
|
|
10237
|
+
export type platform12 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads' | 'pinterestads';
|
|
9809
10238
|
|
|
9810
10239
|
/**
|
|
9811
10240
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
@@ -10044,7 +10473,7 @@ export type UploadedFile = {
|
|
|
10044
10473
|
mimeType?: string;
|
|
10045
10474
|
};
|
|
10046
10475
|
|
|
10047
|
-
export type
|
|
10476
|
+
export type type14 = 'image' | 'video' | 'document';
|
|
10048
10477
|
|
|
10049
10478
|
export type UploadTokenResponse = {
|
|
10050
10479
|
token?: string;
|
|
@@ -10053,7 +10482,7 @@ export type UploadTokenResponse = {
|
|
|
10053
10482
|
status?: 'pending' | 'completed' | 'expired';
|
|
10054
10483
|
};
|
|
10055
10484
|
|
|
10056
|
-
export type
|
|
10485
|
+
export type status27 = 'pending' | 'completed' | 'expired';
|
|
10057
10486
|
|
|
10058
10487
|
export type UploadTokenStatusResponse = {
|
|
10059
10488
|
token?: string;
|
|
@@ -10552,7 +10981,7 @@ export type Verification = {
|
|
|
10552
10981
|
resend?: boolean;
|
|
10553
10982
|
};
|
|
10554
10983
|
|
|
10555
|
-
export type
|
|
10984
|
+
export type status28 = 'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed';
|
|
10556
10985
|
|
|
10557
10986
|
export type channel4 = 'sms';
|
|
10558
10987
|
|
|
@@ -10579,7 +11008,7 @@ export type Webhook = {
|
|
|
10579
11008
|
/**
|
|
10580
11009
|
* Events subscribed to
|
|
10581
11010
|
*/
|
|
10582
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated')>;
|
|
11011
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted')>;
|
|
10583
11012
|
/**
|
|
10584
11013
|
* Whether webhook delivery is enabled
|
|
10585
11014
|
*/
|
|
@@ -10701,7 +11130,7 @@ export type WebhookLog = {
|
|
|
10701
11130
|
/**
|
|
10702
11131
|
* Delivery outcome
|
|
10703
11132
|
*/
|
|
10704
|
-
export type
|
|
11133
|
+
export type status29 = 'success' | 'failed';
|
|
10705
11134
|
|
|
10706
11135
|
/**
|
|
10707
11136
|
* Webhook payload for `account.ads.initial_sync_completed` events.
|
|
@@ -10813,7 +11242,7 @@ export type event = 'account.ads.initial_sync_completed';
|
|
|
10813
11242
|
/**
|
|
10814
11243
|
* Overall outcome of the initial sync.
|
|
10815
11244
|
*/
|
|
10816
|
-
export type
|
|
11245
|
+
export type status30 = 'success' | 'failure';
|
|
10817
11246
|
|
|
10818
11247
|
/**
|
|
10819
11248
|
* Stable category for UX branching. New values may be added; existing ones are
|
|
@@ -11528,7 +11957,46 @@ export type WebhookPayloadComment = {
|
|
|
11528
11957
|
|
|
11529
11958
|
export type event12 = 'comment.received';
|
|
11530
11959
|
|
|
11531
|
-
export type
|
|
11960
|
+
export type platform13 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
|
|
11961
|
+
|
|
11962
|
+
export type WebhookPayloadCommerceProduct = {
|
|
11963
|
+
id?: string;
|
|
11964
|
+
event?: 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted';
|
|
11965
|
+
/**
|
|
11966
|
+
* UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
|
|
11967
|
+
*/
|
|
11968
|
+
timestamp?: string;
|
|
11969
|
+
store?: {
|
|
11970
|
+
/**
|
|
11971
|
+
* Zernio SocialAccount id of the store.
|
|
11972
|
+
*/
|
|
11973
|
+
accountId?: string;
|
|
11974
|
+
platform?: 'shopify' | 'woocommerce';
|
|
11975
|
+
/**
|
|
11976
|
+
* The platform id of the shop.
|
|
11977
|
+
*/
|
|
11978
|
+
shopId?: (string) | null;
|
|
11979
|
+
};
|
|
11980
|
+
resource?: {
|
|
11981
|
+
type?: 'product';
|
|
11982
|
+
/**
|
|
11983
|
+
* Platform-native product id.
|
|
11984
|
+
*/
|
|
11985
|
+
id?: string;
|
|
11986
|
+
/**
|
|
11987
|
+
* Zernio product status; null on delete.
|
|
11988
|
+
*/
|
|
11989
|
+
status?: (CommerceProductStatus | null);
|
|
11990
|
+
/**
|
|
11991
|
+
* Raw platform status, e.g. ACTIVE; null on delete.
|
|
11992
|
+
*/
|
|
11993
|
+
platformStatus?: (string) | null;
|
|
11994
|
+
};
|
|
11995
|
+
};
|
|
11996
|
+
|
|
11997
|
+
export type event13 = 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted';
|
|
11998
|
+
|
|
11999
|
+
export type type15 = 'product';
|
|
11532
12000
|
|
|
11533
12001
|
/**
|
|
11534
12002
|
* WhatsApp only. Who answers a conversation changed: Meta Business Agent took it over,
|
|
@@ -11564,7 +12032,7 @@ export type WebhookPayloadConversationControlChanged = {
|
|
|
11564
12032
|
timestamp: string;
|
|
11565
12033
|
};
|
|
11566
12034
|
|
|
11567
|
-
export type
|
|
12035
|
+
export type event14 = 'conversation.control_changed';
|
|
11568
12036
|
|
|
11569
12037
|
/**
|
|
11570
12038
|
* Who answers now. ai_agent: Meta Business Agent; app: you; other: another partner app on the number.
|
|
@@ -11601,7 +12069,7 @@ export type WebhookPayloadConversationStarted = {
|
|
|
11601
12069
|
timestamp: string;
|
|
11602
12070
|
};
|
|
11603
12071
|
|
|
11604
|
-
export type
|
|
12072
|
+
export type event15 = 'conversation.started';
|
|
11605
12073
|
|
|
11606
12074
|
/**
|
|
11607
12075
|
* Webhook payload for post.external.created / post.external.updated /
|
|
@@ -11633,7 +12101,7 @@ export type WebhookPayloadExternalPost = {
|
|
|
11633
12101
|
timestamp: string;
|
|
11634
12102
|
};
|
|
11635
12103
|
|
|
11636
|
-
export type
|
|
12104
|
+
export type event16 = 'post.external.created' | 'post.external.updated' | 'post.external.deleted';
|
|
11637
12105
|
|
|
11638
12106
|
/**
|
|
11639
12107
|
* Webhook payload for lead.received events (Meta Lead Gen / Instant Forms).
|
|
@@ -11704,9 +12172,9 @@ export type WebhookPayloadLead = {
|
|
|
11704
12172
|
timestamp: string;
|
|
11705
12173
|
};
|
|
11706
12174
|
|
|
11707
|
-
export type
|
|
12175
|
+
export type event17 = 'lead.received';
|
|
11708
12176
|
|
|
11709
|
-
export type
|
|
12177
|
+
export type platform14 = 'facebook';
|
|
11710
12178
|
|
|
11711
12179
|
/**
|
|
11712
12180
|
* Webhook payload for message received events
|
|
@@ -12242,7 +12710,7 @@ export type WebhookPayloadMessage = {
|
|
|
12242
12710
|
timestamp: string;
|
|
12243
12711
|
};
|
|
12244
12712
|
|
|
12245
|
-
export type
|
|
12713
|
+
export type event18 = 'message.received';
|
|
12246
12714
|
|
|
12247
12715
|
/**
|
|
12248
12716
|
* Which Zernio surface produced the message. Always present and
|
|
@@ -12303,7 +12771,7 @@ export type WebhookPayloadMessageDeleted = {
|
|
|
12303
12771
|
timestamp: string;
|
|
12304
12772
|
};
|
|
12305
12773
|
|
|
12306
|
-
export type
|
|
12774
|
+
export type event19 = 'message.deleted';
|
|
12307
12775
|
|
|
12308
12776
|
/**
|
|
12309
12777
|
* Shared payload for message.delivered, message.read, and
|
|
@@ -12363,7 +12831,7 @@ export type WebhookPayloadMessageDeliveryStatus = {
|
|
|
12363
12831
|
timestamp: string;
|
|
12364
12832
|
};
|
|
12365
12833
|
|
|
12366
|
-
export type
|
|
12834
|
+
export type event20 = 'message.delivered' | 'message.read' | 'message.failed';
|
|
12367
12835
|
|
|
12368
12836
|
/**
|
|
12369
12837
|
* Webhook payload for message.edited events. Fires when the sender
|
|
@@ -12401,7 +12869,7 @@ export type WebhookPayloadMessageEdited = {
|
|
|
12401
12869
|
timestamp: string;
|
|
12402
12870
|
};
|
|
12403
12871
|
|
|
12404
|
-
export type
|
|
12872
|
+
export type event21 = 'message.edited';
|
|
12405
12873
|
|
|
12406
12874
|
/**
|
|
12407
12875
|
* Webhook payload for message sent events (fired when a message is sent via the API, or from the WhatsApp Business app on Coexistence numbers)
|
|
@@ -12617,12 +13085,12 @@ export type WebhookPayloadMessageSent = {
|
|
|
12617
13085
|
timestamp: string;
|
|
12618
13086
|
};
|
|
12619
13087
|
|
|
12620
|
-
export type
|
|
13088
|
+
export type event22 = 'message.sent';
|
|
12621
13089
|
|
|
12622
13090
|
/**
|
|
12623
13091
|
* Every platform whose outgoing messages Zernio observes. sms is absent on purpose: its carrier receipts update delivery status and never raise message.sent.
|
|
12624
13092
|
*/
|
|
12625
|
-
export type
|
|
13093
|
+
export type platform15 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'slack' | 'tiktok' | 'imessage';
|
|
12626
13094
|
|
|
12627
13095
|
/**
|
|
12628
13096
|
* 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.
|
|
@@ -12671,7 +13139,7 @@ export type WebhookPayloadPhoneNumberStockAvailable = {
|
|
|
12671
13139
|
timestamp: string;
|
|
12672
13140
|
};
|
|
12673
13141
|
|
|
12674
|
-
export type
|
|
13142
|
+
export type event23 = 'phone_number.stock_available';
|
|
12675
13143
|
|
|
12676
13144
|
/**
|
|
12677
13145
|
* Webhook payload for post events
|
|
@@ -12721,7 +13189,7 @@ export type WebhookPayloadPost = {
|
|
|
12721
13189
|
timestamp: string;
|
|
12722
13190
|
};
|
|
12723
13191
|
|
|
12724
|
-
export type
|
|
13192
|
+
export type event24 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
|
|
12725
13193
|
|
|
12726
13194
|
/**
|
|
12727
13195
|
* Webhook payload for the per-platform terminal events
|
|
@@ -12840,12 +13308,12 @@ export type WebhookPayloadPostPlatform = {
|
|
|
12840
13308
|
timestamp: string;
|
|
12841
13309
|
};
|
|
12842
13310
|
|
|
12843
|
-
export type
|
|
13311
|
+
export type event25 = 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved';
|
|
12844
13312
|
|
|
12845
13313
|
/**
|
|
12846
13314
|
* Terminal status this event fires on. Matches the event suffix.
|
|
12847
13315
|
*/
|
|
12848
|
-
export type
|
|
13316
|
+
export type status31 = 'published' | 'failed' | 'deleted';
|
|
12849
13317
|
|
|
12850
13318
|
/**
|
|
12851
13319
|
* Webhook payload for reaction received events (WhatsApp, Telegram, Slack, Instagram, Facebook Messenger, TikTok)
|
|
@@ -12900,7 +13368,7 @@ export type WebhookPayloadReaction = {
|
|
|
12900
13368
|
timestamp: string;
|
|
12901
13369
|
};
|
|
12902
13370
|
|
|
12903
|
-
export type
|
|
13371
|
+
export type event26 = 'reaction.received';
|
|
12904
13372
|
|
|
12905
13373
|
export type action = 'added' | 'removed';
|
|
12906
13374
|
|
|
@@ -12974,7 +13442,7 @@ export type WebhookPayloadReferral = {
|
|
|
12974
13442
|
timestamp: string;
|
|
12975
13443
|
};
|
|
12976
13444
|
|
|
12977
|
-
export type
|
|
13445
|
+
export type event27 = 'referral.received';
|
|
12978
13446
|
|
|
12979
13447
|
/**
|
|
12980
13448
|
* Webhook payload for the review.new event (new review posted on a connected account).
|
|
@@ -13001,7 +13469,7 @@ export type WebhookPayloadReviewNew = {
|
|
|
13001
13469
|
timestamp: string;
|
|
13002
13470
|
};
|
|
13003
13471
|
|
|
13004
|
-
export type
|
|
13472
|
+
export type event28 = 'review.new';
|
|
13005
13473
|
|
|
13006
13474
|
/**
|
|
13007
13475
|
* Webhook payload for the review.updated event. Fired when the reviewer edits their
|
|
@@ -13034,7 +13502,7 @@ export type WebhookPayloadReviewUpdated = {
|
|
|
13034
13502
|
timestamp: string;
|
|
13035
13503
|
};
|
|
13036
13504
|
|
|
13037
|
-
export type
|
|
13505
|
+
export type event29 = 'review.updated';
|
|
13038
13506
|
|
|
13039
13507
|
/**
|
|
13040
13508
|
* Webhook payload for test deliveries
|
|
@@ -13055,7 +13523,7 @@ export type WebhookPayloadTest = {
|
|
|
13055
13523
|
timestamp: string;
|
|
13056
13524
|
};
|
|
13057
13525
|
|
|
13058
|
-
export type
|
|
13526
|
+
export type event30 = 'webhook.test';
|
|
13059
13527
|
|
|
13060
13528
|
/**
|
|
13061
13529
|
* Webhook payload for the `whatsapp.account.name_status_updated` event.
|
|
@@ -13104,14 +13572,14 @@ export type WebhookPayloadWhatsAppAccountNameStatusUpdated = {
|
|
|
13104
13572
|
timestamp: string;
|
|
13105
13573
|
};
|
|
13106
13574
|
|
|
13107
|
-
export type
|
|
13575
|
+
export type event31 = 'whatsapp.account.name_status_updated';
|
|
13108
13576
|
|
|
13109
|
-
export type
|
|
13577
|
+
export type platform16 = 'whatsapp';
|
|
13110
13578
|
|
|
13111
13579
|
/**
|
|
13112
13580
|
* Normalized from Meta's `decision` (REJECTED -> DECLINED, DEFERRED -> PENDING_REVIEW; the review is still open on DEFERRED, not a rejection).
|
|
13113
13581
|
*/
|
|
13114
|
-
export type
|
|
13582
|
+
export type status32 = 'APPROVED' | 'DECLINED' | 'PENDING_REVIEW';
|
|
13115
13583
|
|
|
13116
13584
|
/**
|
|
13117
13585
|
* Webhook payload for the `whatsapp.template.category_updated` event.
|
|
@@ -13175,7 +13643,7 @@ export type WebhookPayloadWhatsAppTemplateCategoryUpdated = {
|
|
|
13175
13643
|
timestamp: string;
|
|
13176
13644
|
};
|
|
13177
13645
|
|
|
13178
|
-
export type
|
|
13646
|
+
export type event32 = 'whatsapp.template.category_updated';
|
|
13179
13647
|
|
|
13180
13648
|
/**
|
|
13181
13649
|
* `scheduled` is Meta's 24h advance notice of an upcoming
|
|
@@ -13252,7 +13720,7 @@ export type WebhookPayloadWhatsAppTemplateStatusUpdated = {
|
|
|
13252
13720
|
timestamp: string;
|
|
13253
13721
|
};
|
|
13254
13722
|
|
|
13255
|
-
export type
|
|
13723
|
+
export type event33 = 'whatsapp.template.status_updated';
|
|
13256
13724
|
|
|
13257
13725
|
/**
|
|
13258
13726
|
* New status. Forwarded verbatim from Meta's `event` field.
|
|
@@ -13260,7 +13728,7 @@ export type event32 = 'whatsapp.template.status_updated';
|
|
|
13260
13728
|
* request before the template is actually removed.
|
|
13261
13729
|
*
|
|
13262
13730
|
*/
|
|
13263
|
-
export type
|
|
13731
|
+
export type status33 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
|
|
13264
13732
|
|
|
13265
13733
|
export type WhatsAppBodyComponent = {
|
|
13266
13734
|
type: 'body';
|
|
@@ -13414,7 +13882,7 @@ export type WhatsAppSandboxSession = {
|
|
|
13414
13882
|
* list responses.
|
|
13415
13883
|
*
|
|
13416
13884
|
*/
|
|
13417
|
-
export type
|
|
13885
|
+
export type status34 = 'pending' | 'active';
|
|
13418
13886
|
|
|
13419
13887
|
export type WhatsAppTemplateButton = {
|
|
13420
13888
|
type: 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
|
|
@@ -13448,7 +13916,7 @@ export type WhatsAppTemplateButton = {
|
|
|
13448
13916
|
navigate_screen?: string;
|
|
13449
13917
|
};
|
|
13450
13918
|
|
|
13451
|
-
export type
|
|
13919
|
+
export type type16 = 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
|
|
13452
13920
|
|
|
13453
13921
|
/**
|
|
13454
13922
|
* Required when type is otp
|
|
@@ -13490,7 +13958,7 @@ export type WhatsAppTemplateLookupError = {
|
|
|
13490
13958
|
};
|
|
13491
13959
|
};
|
|
13492
13960
|
|
|
13493
|
-
export type
|
|
13961
|
+
export type type17 = 'platform_error';
|
|
13494
13962
|
|
|
13495
13963
|
export type code = 'platform_api_error';
|
|
13496
13964
|
|
|
@@ -13572,7 +14040,7 @@ export type WorkflowExecutionEvent = {
|
|
|
13572
14040
|
|
|
13573
14041
|
export type action2 = 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
|
|
13574
14042
|
|
|
13575
|
-
export type
|
|
14043
|
+
export type status35 = 'success' | 'failed' | 'pending';
|
|
13576
14044
|
|
|
13577
14045
|
/**
|
|
13578
14046
|
* A node in a workflow graph. `config` shape depends on `type`.
|
|
@@ -13649,7 +14117,7 @@ export type WorkflowNode = {
|
|
|
13649
14117
|
* integrations (webhook, ai, handoff, start_call).
|
|
13650
14118
|
*
|
|
13651
14119
|
*/
|
|
13652
|
-
export type
|
|
14120
|
+
export type type18 = 'trigger' | 'send_message' | 'wait_for_reply' | 'condition' | 'set_variable' | 'delay' | 'webhook' | 'ai' | 'handoff' | 'start_call' | 'a_b_split' | 'set_field' | 'enroll_sequence' | 'add_tag' | 'remove_tag' | 'end';
|
|
13653
14121
|
|
|
13654
14122
|
/**
|
|
13655
14123
|
* A single X API operation with its per-call price and the Zernio platform methods that trigger it.
|
|
@@ -13785,7 +14253,7 @@ export type XArticleBlock = {
|
|
|
13785
14253
|
entity_ranges?: Array<XArticleEntityRange>;
|
|
13786
14254
|
};
|
|
13787
14255
|
|
|
13788
|
-
export type
|
|
14256
|
+
export type type19 = 'unstyled' | 'header-one' | 'header-two' | 'header-three' | 'unordered-list-item' | 'ordered-list-item' | 'blockquote' | 'atomic';
|
|
13789
14257
|
|
|
13790
14258
|
/**
|
|
13791
14259
|
* X's snake_case content-state shape. Standard DraftJS camelCase fields such as entityMap, inlineStyleRanges, and entityRanges are rejected.
|
|
@@ -13864,7 +14332,7 @@ export type XArticleEntity = {
|
|
|
13864
14332
|
|
|
13865
14333
|
export type mutability = 'immutable' | 'mutable' | 'segmented';
|
|
13866
14334
|
|
|
13867
|
-
export type
|
|
14335
|
+
export type type20 = 'divider' | 'latex';
|
|
13868
14336
|
|
|
13869
14337
|
/**
|
|
13870
14338
|
* The referenced entity must exist, and offset plus length must not exceed the containing block's text length.
|
|
@@ -23904,7 +24372,7 @@ export type CreateWebhookSettingsData = {
|
|
|
23904
24372
|
/**
|
|
23905
24373
|
* Events to subscribe to (at least one required)
|
|
23906
24374
|
*/
|
|
23907
|
-
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated')>;
|
|
24375
|
+
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted')>;
|
|
23908
24376
|
/**
|
|
23909
24377
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
23910
24378
|
*/
|
|
@@ -23972,7 +24440,7 @@ export type UpdateWebhookSettingsData = {
|
|
|
23972
24440
|
/**
|
|
23973
24441
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
23974
24442
|
*/
|
|
23975
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated')>;
|
|
24443
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted')>;
|
|
23976
24444
|
/**
|
|
23977
24445
|
* Enable or disable webhook delivery
|
|
23978
24446
|
*/
|
|
@@ -38175,19 +38643,27 @@ export type UpdateAdCampaignStatusData = {
|
|
|
38175
38643
|
|
|
38176
38644
|
export type UpdateAdCampaignStatusResponse = ({
|
|
38177
38645
|
/**
|
|
38178
|
-
* The status
|
|
38646
|
+
* The campaign's delivery status derived from its switch as read back (`paused` when the switch is off). Echoes the request when the platform could not be read.
|
|
38179
38647
|
*/
|
|
38180
38648
|
status?: 'active' | 'paused';
|
|
38181
38649
|
/**
|
|
38182
|
-
*
|
|
38650
|
+
* The campaign's own switch as read back from the platform, in the raw platform vocabulary (Meta effective_status, TikTok ENABLE / DISABLE, Google ENABLED / PAUSED, ChatGPT (OpenAI) status). Null when the platform could not be read, which is always the case on Pinterest, LinkedIn and X (no single-campaign read).
|
|
38183
38651
|
*/
|
|
38184
|
-
|
|
38652
|
+
platformCampaignStatus?: (string) | null;
|
|
38185
38653
|
/**
|
|
38186
|
-
*
|
|
38654
|
+
* When the switch was read back. Null when it could not be read.
|
|
38187
38655
|
*/
|
|
38188
|
-
|
|
38656
|
+
statusReadAt?: (string) | null;
|
|
38657
|
+
/**
|
|
38658
|
+
* 1 when the campaign's switch was written.
|
|
38659
|
+
*/
|
|
38660
|
+
updated?: 0 | 1;
|
|
38661
|
+
/**
|
|
38662
|
+
* 1 when a live read showed the campaign already in the requested state, so nothing was written.
|
|
38663
|
+
*/
|
|
38664
|
+
skipped?: 0 | 1;
|
|
38189
38665
|
/**
|
|
38190
|
-
* Why
|
|
38666
|
+
* Why the write was skipped, for example "Campaign already switched off".
|
|
38191
38667
|
*/
|
|
38192
38668
|
skippedReasons?: Array<(string)>;
|
|
38193
38669
|
});
|
|
@@ -38599,8 +39075,12 @@ export type BulkUpdateAdCampaignStatusResponse = ({
|
|
|
38599
39075
|
results?: Array<{
|
|
38600
39076
|
platformCampaignId?: string;
|
|
38601
39077
|
platform?: string;
|
|
38602
|
-
updated?:
|
|
38603
|
-
skipped?:
|
|
39078
|
+
updated?: 0 | 1;
|
|
39079
|
+
skipped?: 0 | 1;
|
|
39080
|
+
/**
|
|
39081
|
+
* The campaign's own switch read back from the platform; null when it could not be read.
|
|
39082
|
+
*/
|
|
39083
|
+
platformCampaignStatus?: (string) | null;
|
|
38604
39084
|
error?: string;
|
|
38605
39085
|
}>;
|
|
38606
39086
|
});
|
|
@@ -39284,20 +39764,23 @@ export type UpdateAdSetResponse = ({
|
|
|
39284
39764
|
budget?: AdBudget;
|
|
39285
39765
|
budgetLevel?: 'adset';
|
|
39286
39766
|
/**
|
|
39287
|
-
*
|
|
39767
|
+
* As in PUT /v1/ads/ad-sets/{adSetId}/status: delivery derived from the switches read back.
|
|
39288
39768
|
*/
|
|
39289
39769
|
status?: 'active' | 'paused';
|
|
39290
39770
|
/**
|
|
39291
|
-
*
|
|
39771
|
+
* The ad set's own switch read back from the platform; null when it could not be read.
|
|
39292
39772
|
*/
|
|
39293
|
-
|
|
39773
|
+
platformAdSetStatus?: (string) | null;
|
|
39774
|
+
platformCampaignStatus?: (string) | null;
|
|
39775
|
+
statusReadAt?: (string) | null;
|
|
39294
39776
|
/**
|
|
39295
|
-
*
|
|
39777
|
+
* 1 when the ad set's switch was written.
|
|
39296
39778
|
*/
|
|
39297
|
-
|
|
39779
|
+
statusUpdated?: 0 | 1;
|
|
39298
39780
|
/**
|
|
39299
|
-
*
|
|
39781
|
+
* 1 when a live read showed it already in the requested state.
|
|
39300
39782
|
*/
|
|
39783
|
+
statusSkipped?: 0 | 1;
|
|
39301
39784
|
statusSkippedReasons?: Array<(string)>;
|
|
39302
39785
|
bidStrategy?: BidStrategy;
|
|
39303
39786
|
bidAmount?: (number) | null;
|
|
@@ -39347,19 +39830,31 @@ export type UpdateAdSetStatusData = {
|
|
|
39347
39830
|
|
|
39348
39831
|
export type UpdateAdSetStatusResponse = ({
|
|
39349
39832
|
/**
|
|
39350
|
-
* The status
|
|
39833
|
+
* The ad set's delivery status derived from the switches read back: `paused` when its own switch or its campaign's switch is off. Echoes the request when the platform could not be read.
|
|
39351
39834
|
*/
|
|
39352
39835
|
status?: 'active' | 'paused';
|
|
39353
39836
|
/**
|
|
39354
|
-
*
|
|
39837
|
+
* The ad set's own switch as read back from the platform, in the raw platform vocabulary (Meta effective_status, TikTok ENABLE / DISABLE, Google ENABLED / PAUSED, LinkedIn and Pinterest ACTIVE / PAUSED, ChatGPT (OpenAI) status). Null when the platform could not be read, which is always the case on X.
|
|
39355
39838
|
*/
|
|
39356
|
-
|
|
39839
|
+
platformAdSetStatus?: (string) | null;
|
|
39357
39840
|
/**
|
|
39358
|
-
*
|
|
39841
|
+
* The parent campaign's switch, read in the same call where the platform returns it, otherwise the stored value.
|
|
39359
39842
|
*/
|
|
39360
|
-
|
|
39843
|
+
platformCampaignStatus?: (string) | null;
|
|
39844
|
+
/**
|
|
39845
|
+
* When the ad set switch was read back. Null when it could not be read.
|
|
39846
|
+
*/
|
|
39847
|
+
statusReadAt?: (string) | null;
|
|
39848
|
+
/**
|
|
39849
|
+
* 1 when the ad set's switch was written.
|
|
39850
|
+
*/
|
|
39851
|
+
updated?: 0 | 1;
|
|
39852
|
+
/**
|
|
39853
|
+
* 1 when a live read showed the ad set already in the requested state, so nothing was written.
|
|
39854
|
+
*/
|
|
39855
|
+
skipped?: 0 | 1;
|
|
39361
39856
|
/**
|
|
39362
|
-
* Why
|
|
39857
|
+
* Why the write was skipped, for example "Ad set already switched off".
|
|
39363
39858
|
*/
|
|
39364
39859
|
skippedReasons?: Array<(string)>;
|
|
39365
39860
|
});
|
|
@@ -50789,6 +51284,1814 @@ export type UpdateProductError = (ErrorResponse | {
|
|
|
50789
51284
|
error?: string;
|
|
50790
51285
|
} | unknown);
|
|
50791
51286
|
|
|
51287
|
+
export type GetCommerceStoreData = {
|
|
51288
|
+
query: {
|
|
51289
|
+
/**
|
|
51290
|
+
* Connected store SocialAccount id.
|
|
51291
|
+
*/
|
|
51292
|
+
accountId: string;
|
|
51293
|
+
};
|
|
51294
|
+
};
|
|
51295
|
+
|
|
51296
|
+
export type GetCommerceStoreResponse = ({
|
|
51297
|
+
store?: CommerceStore;
|
|
51298
|
+
});
|
|
51299
|
+
|
|
51300
|
+
export type GetCommerceStoreError = (ErrorResponse | {
|
|
51301
|
+
error?: string;
|
|
51302
|
+
} | unknown);
|
|
51303
|
+
|
|
51304
|
+
export type ListCommerceProductsData = {
|
|
51305
|
+
query: {
|
|
51306
|
+
/**
|
|
51307
|
+
* Connected store SocialAccount id.
|
|
51308
|
+
*/
|
|
51309
|
+
accountId: string;
|
|
51310
|
+
/**
|
|
51311
|
+
* Only products in this collection.
|
|
51312
|
+
*/
|
|
51313
|
+
collectionId?: string;
|
|
51314
|
+
/**
|
|
51315
|
+
* Opaque cursor from a previous response. Omit for the first page.
|
|
51316
|
+
*/
|
|
51317
|
+
cursor?: string;
|
|
51318
|
+
limit?: number;
|
|
51319
|
+
/**
|
|
51320
|
+
* Platform product search syntax (Shopify: title, vendor, product_type, tag, sku, handle, ...).
|
|
51321
|
+
*/
|
|
51322
|
+
query?: string;
|
|
51323
|
+
status?: CommerceProductStatus;
|
|
51324
|
+
};
|
|
51325
|
+
};
|
|
51326
|
+
|
|
51327
|
+
export type ListCommerceProductsResponse = ({
|
|
51328
|
+
products?: Array<CommerceProduct>;
|
|
51329
|
+
nextCursor?: (string) | null;
|
|
51330
|
+
});
|
|
51331
|
+
|
|
51332
|
+
export type ListCommerceProductsError = (ErrorResponse | {
|
|
51333
|
+
error?: string;
|
|
51334
|
+
} | unknown);
|
|
51335
|
+
|
|
51336
|
+
export type CreateCommerceProductData = {
|
|
51337
|
+
body: {
|
|
51338
|
+
accountId: string;
|
|
51339
|
+
title: string;
|
|
51340
|
+
descriptionHtml?: string;
|
|
51341
|
+
handle?: string;
|
|
51342
|
+
vendor?: string;
|
|
51343
|
+
productType?: string;
|
|
51344
|
+
tags?: Array<(string)>;
|
|
51345
|
+
seo?: {
|
|
51346
|
+
title?: string;
|
|
51347
|
+
description?: string;
|
|
51348
|
+
};
|
|
51349
|
+
status?: 'draft' | 'active';
|
|
51350
|
+
images?: Array<{
|
|
51351
|
+
url: string;
|
|
51352
|
+
altText?: string;
|
|
51353
|
+
}>;
|
|
51354
|
+
options?: Array<{
|
|
51355
|
+
name: string;
|
|
51356
|
+
values: Array<(string)>;
|
|
51357
|
+
}>;
|
|
51358
|
+
variants: Array<{
|
|
51359
|
+
sku?: string;
|
|
51360
|
+
/**
|
|
51361
|
+
* Decimal amount in the store currency.
|
|
51362
|
+
*/
|
|
51363
|
+
price: (number | string);
|
|
51364
|
+
compareAtPrice?: (number | string | null);
|
|
51365
|
+
/**
|
|
51366
|
+
* One value per product option, e.g. [{ name: Size, value: M }].
|
|
51367
|
+
*/
|
|
51368
|
+
options?: Array<{
|
|
51369
|
+
name: string;
|
|
51370
|
+
value: string;
|
|
51371
|
+
}>;
|
|
51372
|
+
}>;
|
|
51373
|
+
};
|
|
51374
|
+
};
|
|
51375
|
+
|
|
51376
|
+
export type CreateCommerceProductResponse = ({
|
|
51377
|
+
product?: CommerceProduct;
|
|
51378
|
+
});
|
|
51379
|
+
|
|
51380
|
+
export type CreateCommerceProductError = (ErrorResponse | {
|
|
51381
|
+
error?: string;
|
|
51382
|
+
} | unknown);
|
|
51383
|
+
|
|
51384
|
+
export type ChangeCommerceProductStateData = {
|
|
51385
|
+
body: {
|
|
51386
|
+
accountId: string;
|
|
51387
|
+
productIds: Array<(string)>;
|
|
51388
|
+
action: 'activate' | 'deactivate' | 'archive' | 'delete';
|
|
51389
|
+
};
|
|
51390
|
+
};
|
|
51391
|
+
|
|
51392
|
+
export type ChangeCommerceProductStateResponse = ({
|
|
51393
|
+
action?: 'activate' | 'deactivate' | 'archive' | 'delete';
|
|
51394
|
+
succeeded?: Array<(string)>;
|
|
51395
|
+
failed?: Array<{
|
|
51396
|
+
productId?: string;
|
|
51397
|
+
message?: string;
|
|
51398
|
+
}>;
|
|
51399
|
+
});
|
|
51400
|
+
|
|
51401
|
+
export type ChangeCommerceProductStateError = (ErrorResponse | {
|
|
51402
|
+
error?: string;
|
|
51403
|
+
} | unknown);
|
|
51404
|
+
|
|
51405
|
+
export type GetCommerceProductData = {
|
|
51406
|
+
path: {
|
|
51407
|
+
/**
|
|
51408
|
+
* Platform-native product id.
|
|
51409
|
+
*/
|
|
51410
|
+
productId: string;
|
|
51411
|
+
};
|
|
51412
|
+
query: {
|
|
51413
|
+
/**
|
|
51414
|
+
* Connected store SocialAccount id.
|
|
51415
|
+
*/
|
|
51416
|
+
accountId: string;
|
|
51417
|
+
};
|
|
51418
|
+
};
|
|
51419
|
+
|
|
51420
|
+
export type GetCommerceProductResponse = ({
|
|
51421
|
+
product?: CommerceProduct;
|
|
51422
|
+
});
|
|
51423
|
+
|
|
51424
|
+
export type GetCommerceProductError = (ErrorResponse | {
|
|
51425
|
+
error?: string;
|
|
51426
|
+
} | unknown);
|
|
51427
|
+
|
|
51428
|
+
export type UpdateCommerceProductData = {
|
|
51429
|
+
body: {
|
|
51430
|
+
accountId: string;
|
|
51431
|
+
title?: string;
|
|
51432
|
+
descriptionHtml?: string;
|
|
51433
|
+
handle?: string;
|
|
51434
|
+
vendor?: string;
|
|
51435
|
+
productType?: string;
|
|
51436
|
+
tags?: Array<(string)>;
|
|
51437
|
+
seo?: {
|
|
51438
|
+
title?: string;
|
|
51439
|
+
description?: string;
|
|
51440
|
+
};
|
|
51441
|
+
};
|
|
51442
|
+
path: {
|
|
51443
|
+
/**
|
|
51444
|
+
* Platform-native product id.
|
|
51445
|
+
*/
|
|
51446
|
+
productId: string;
|
|
51447
|
+
};
|
|
51448
|
+
};
|
|
51449
|
+
|
|
51450
|
+
export type UpdateCommerceProductResponse = ({
|
|
51451
|
+
product?: CommerceProduct;
|
|
51452
|
+
});
|
|
51453
|
+
|
|
51454
|
+
export type UpdateCommerceProductError = (ErrorResponse | {
|
|
51455
|
+
error?: string;
|
|
51456
|
+
} | unknown);
|
|
51457
|
+
|
|
51458
|
+
export type UpdateCommerceProductPricesData = {
|
|
51459
|
+
body: {
|
|
51460
|
+
accountId: string;
|
|
51461
|
+
variants: Array<{
|
|
51462
|
+
/**
|
|
51463
|
+
* Variant id from the product response.
|
|
51464
|
+
*/
|
|
51465
|
+
id: string;
|
|
51466
|
+
price?: (number | string);
|
|
51467
|
+
compareAtPrice?: (number | string | null);
|
|
51468
|
+
}>;
|
|
51469
|
+
};
|
|
51470
|
+
path: {
|
|
51471
|
+
/**
|
|
51472
|
+
* Platform-native product id.
|
|
51473
|
+
*/
|
|
51474
|
+
productId: string;
|
|
51475
|
+
};
|
|
51476
|
+
};
|
|
51477
|
+
|
|
51478
|
+
export type UpdateCommerceProductPricesResponse = ({
|
|
51479
|
+
product?: CommerceProduct;
|
|
51480
|
+
});
|
|
51481
|
+
|
|
51482
|
+
export type UpdateCommerceProductPricesError = (ErrorResponse | {
|
|
51483
|
+
error?: string;
|
|
51484
|
+
} | unknown);
|
|
51485
|
+
|
|
51486
|
+
export type ListCommerceCollectionsData = {
|
|
51487
|
+
query: {
|
|
51488
|
+
/**
|
|
51489
|
+
* Connected store SocialAccount id.
|
|
51490
|
+
*/
|
|
51491
|
+
accountId: string;
|
|
51492
|
+
cursor?: string;
|
|
51493
|
+
limit?: number;
|
|
51494
|
+
/**
|
|
51495
|
+
* Platform collection search syntax (Shopify: title, handle, collection_type, ...).
|
|
51496
|
+
*/
|
|
51497
|
+
query?: string;
|
|
51498
|
+
};
|
|
51499
|
+
};
|
|
51500
|
+
|
|
51501
|
+
export type ListCommerceCollectionsResponse = ({
|
|
51502
|
+
collections?: Array<CommerceCollection>;
|
|
51503
|
+
nextCursor?: (string) | null;
|
|
51504
|
+
});
|
|
51505
|
+
|
|
51506
|
+
export type ListCommerceCollectionsError = (ErrorResponse | {
|
|
51507
|
+
error?: string;
|
|
51508
|
+
} | unknown);
|
|
51509
|
+
|
|
51510
|
+
export type CreateCommerceCollectionData = {
|
|
51511
|
+
body: {
|
|
51512
|
+
accountId: string;
|
|
51513
|
+
title: string;
|
|
51514
|
+
descriptionHtml?: string;
|
|
51515
|
+
handle?: string;
|
|
51516
|
+
sortOrder?: 'manual' | 'best_selling' | 'alpha_asc' | 'alpha_desc' | 'price_asc' | 'price_desc' | 'created' | 'created_desc' | 'most_relevant';
|
|
51517
|
+
seo?: {
|
|
51518
|
+
title?: string;
|
|
51519
|
+
description?: string;
|
|
51520
|
+
};
|
|
51521
|
+
image?: {
|
|
51522
|
+
url: string;
|
|
51523
|
+
altText?: string;
|
|
51524
|
+
};
|
|
51525
|
+
productIds?: Array<(string)>;
|
|
51526
|
+
};
|
|
51527
|
+
};
|
|
51528
|
+
|
|
51529
|
+
export type CreateCommerceCollectionResponse = ({
|
|
51530
|
+
collection?: CommerceCollection;
|
|
51531
|
+
});
|
|
51532
|
+
|
|
51533
|
+
export type CreateCommerceCollectionError = (ErrorResponse | {
|
|
51534
|
+
error?: string;
|
|
51535
|
+
} | unknown);
|
|
51536
|
+
|
|
51537
|
+
export type GetCommerceCollectionData = {
|
|
51538
|
+
path: {
|
|
51539
|
+
/**
|
|
51540
|
+
* Platform-native collection id.
|
|
51541
|
+
*/
|
|
51542
|
+
collectionId: string;
|
|
51543
|
+
};
|
|
51544
|
+
query: {
|
|
51545
|
+
/**
|
|
51546
|
+
* Connected store SocialAccount id.
|
|
51547
|
+
*/
|
|
51548
|
+
accountId: string;
|
|
51549
|
+
};
|
|
51550
|
+
};
|
|
51551
|
+
|
|
51552
|
+
export type GetCommerceCollectionResponse = ({
|
|
51553
|
+
collection?: CommerceCollection;
|
|
51554
|
+
});
|
|
51555
|
+
|
|
51556
|
+
export type GetCommerceCollectionError = (ErrorResponse | {
|
|
51557
|
+
error?: string;
|
|
51558
|
+
} | unknown);
|
|
51559
|
+
|
|
51560
|
+
export type UpdateCommerceCollectionData = {
|
|
51561
|
+
body: {
|
|
51562
|
+
accountId: string;
|
|
51563
|
+
title?: string;
|
|
51564
|
+
descriptionHtml?: string;
|
|
51565
|
+
handle?: string;
|
|
51566
|
+
sortOrder?: 'manual' | 'best_selling' | 'alpha_asc' | 'alpha_desc' | 'price_asc' | 'price_desc' | 'created' | 'created_desc' | 'most_relevant';
|
|
51567
|
+
seo?: {
|
|
51568
|
+
title?: string;
|
|
51569
|
+
description?: string;
|
|
51570
|
+
};
|
|
51571
|
+
image?: {
|
|
51572
|
+
url: string;
|
|
51573
|
+
altText?: string;
|
|
51574
|
+
};
|
|
51575
|
+
};
|
|
51576
|
+
path: {
|
|
51577
|
+
/**
|
|
51578
|
+
* Platform-native collection id.
|
|
51579
|
+
*/
|
|
51580
|
+
collectionId: string;
|
|
51581
|
+
};
|
|
51582
|
+
};
|
|
51583
|
+
|
|
51584
|
+
export type UpdateCommerceCollectionResponse = ({
|
|
51585
|
+
collection?: CommerceCollection;
|
|
51586
|
+
});
|
|
51587
|
+
|
|
51588
|
+
export type UpdateCommerceCollectionError = (ErrorResponse | {
|
|
51589
|
+
error?: string;
|
|
51590
|
+
} | unknown);
|
|
51591
|
+
|
|
51592
|
+
export type DeleteCommerceCollectionData = {
|
|
51593
|
+
path: {
|
|
51594
|
+
/**
|
|
51595
|
+
* Platform-native collection id.
|
|
51596
|
+
*/
|
|
51597
|
+
collectionId: string;
|
|
51598
|
+
};
|
|
51599
|
+
query: {
|
|
51600
|
+
/**
|
|
51601
|
+
* Connected store SocialAccount id.
|
|
51602
|
+
*/
|
|
51603
|
+
accountId: string;
|
|
51604
|
+
};
|
|
51605
|
+
};
|
|
51606
|
+
|
|
51607
|
+
export type DeleteCommerceCollectionResponse = ({
|
|
51608
|
+
deleted?: boolean;
|
|
51609
|
+
collectionId?: string;
|
|
51610
|
+
});
|
|
51611
|
+
|
|
51612
|
+
export type DeleteCommerceCollectionError = (ErrorResponse | {
|
|
51613
|
+
error?: string;
|
|
51614
|
+
} | unknown);
|
|
51615
|
+
|
|
51616
|
+
export type ChangeCommerceCollectionProductsData = {
|
|
51617
|
+
body: {
|
|
51618
|
+
accountId: string;
|
|
51619
|
+
add?: Array<(string)>;
|
|
51620
|
+
remove?: Array<(string)>;
|
|
51621
|
+
};
|
|
51622
|
+
path: {
|
|
51623
|
+
/**
|
|
51624
|
+
* Platform-native collection id.
|
|
51625
|
+
*/
|
|
51626
|
+
collectionId: string;
|
|
51627
|
+
};
|
|
51628
|
+
};
|
|
51629
|
+
|
|
51630
|
+
export type ChangeCommerceCollectionProductsResponse = ({
|
|
51631
|
+
collection?: CommerceCollection;
|
|
51632
|
+
pending?: boolean;
|
|
51633
|
+
});
|
|
51634
|
+
|
|
51635
|
+
export type ChangeCommerceCollectionProductsError = (ErrorResponse | {
|
|
51636
|
+
error?: string;
|
|
51637
|
+
} | unknown);
|
|
51638
|
+
|
|
51639
|
+
export type CreateCommerceProductVariantsData = {
|
|
51640
|
+
body: {
|
|
51641
|
+
accountId: string;
|
|
51642
|
+
variants: Array<{
|
|
51643
|
+
sku?: string;
|
|
51644
|
+
price: (number | string);
|
|
51645
|
+
compareAtPrice?: (number | string | null);
|
|
51646
|
+
options?: Array<{
|
|
51647
|
+
name?: string;
|
|
51648
|
+
value?: string;
|
|
51649
|
+
}>;
|
|
51650
|
+
}>;
|
|
51651
|
+
};
|
|
51652
|
+
path: {
|
|
51653
|
+
/**
|
|
51654
|
+
* Platform-native id.
|
|
51655
|
+
*/
|
|
51656
|
+
productId: string;
|
|
51657
|
+
};
|
|
51658
|
+
};
|
|
51659
|
+
|
|
51660
|
+
export type CreateCommerceProductVariantsResponse = ({
|
|
51661
|
+
product?: CommerceProduct;
|
|
51662
|
+
});
|
|
51663
|
+
|
|
51664
|
+
export type CreateCommerceProductVariantsError = (ErrorResponse | {
|
|
51665
|
+
error?: string;
|
|
51666
|
+
} | unknown);
|
|
51667
|
+
|
|
51668
|
+
export type DeleteCommerceProductVariantsData = {
|
|
51669
|
+
path: {
|
|
51670
|
+
/**
|
|
51671
|
+
* Platform-native id.
|
|
51672
|
+
*/
|
|
51673
|
+
productId: string;
|
|
51674
|
+
};
|
|
51675
|
+
query: {
|
|
51676
|
+
/**
|
|
51677
|
+
* Connected store SocialAccount id.
|
|
51678
|
+
*/
|
|
51679
|
+
accountId: string;
|
|
51680
|
+
/**
|
|
51681
|
+
* Comma-separated ids.
|
|
51682
|
+
*/
|
|
51683
|
+
variantIds: string;
|
|
51684
|
+
};
|
|
51685
|
+
};
|
|
51686
|
+
|
|
51687
|
+
export type DeleteCommerceProductVariantsResponse = ({
|
|
51688
|
+
product?: CommerceProduct;
|
|
51689
|
+
});
|
|
51690
|
+
|
|
51691
|
+
export type DeleteCommerceProductVariantsError = (ErrorResponse | {
|
|
51692
|
+
error?: string;
|
|
51693
|
+
} | unknown);
|
|
51694
|
+
|
|
51695
|
+
export type CreateCommerceProductOptionsData = {
|
|
51696
|
+
body: {
|
|
51697
|
+
accountId: string;
|
|
51698
|
+
options: Array<{
|
|
51699
|
+
name: string;
|
|
51700
|
+
values: Array<(string)>;
|
|
51701
|
+
}>;
|
|
51702
|
+
createVariants?: boolean;
|
|
51703
|
+
};
|
|
51704
|
+
path: {
|
|
51705
|
+
/**
|
|
51706
|
+
* Platform-native id.
|
|
51707
|
+
*/
|
|
51708
|
+
productId: string;
|
|
51709
|
+
};
|
|
51710
|
+
};
|
|
51711
|
+
|
|
51712
|
+
export type CreateCommerceProductOptionsResponse = ({
|
|
51713
|
+
product?: CommerceProduct;
|
|
51714
|
+
});
|
|
51715
|
+
|
|
51716
|
+
export type CreateCommerceProductOptionsError = (ErrorResponse | {
|
|
51717
|
+
error?: string;
|
|
51718
|
+
} | unknown);
|
|
51719
|
+
|
|
51720
|
+
export type DeleteCommerceProductOptionsData = {
|
|
51721
|
+
path: {
|
|
51722
|
+
/**
|
|
51723
|
+
* Platform-native id.
|
|
51724
|
+
*/
|
|
51725
|
+
productId: string;
|
|
51726
|
+
};
|
|
51727
|
+
query: {
|
|
51728
|
+
/**
|
|
51729
|
+
* Connected store SocialAccount id.
|
|
51730
|
+
*/
|
|
51731
|
+
accountId: string;
|
|
51732
|
+
/**
|
|
51733
|
+
* Comma-separated option names.
|
|
51734
|
+
*/
|
|
51735
|
+
names: string;
|
|
51736
|
+
};
|
|
51737
|
+
};
|
|
51738
|
+
|
|
51739
|
+
export type DeleteCommerceProductOptionsResponse = ({
|
|
51740
|
+
product?: CommerceProduct;
|
|
51741
|
+
});
|
|
51742
|
+
|
|
51743
|
+
export type DeleteCommerceProductOptionsError = (ErrorResponse | {
|
|
51744
|
+
error?: string;
|
|
51745
|
+
} | unknown);
|
|
51746
|
+
|
|
51747
|
+
export type AddCommerceProductImagesData = {
|
|
51748
|
+
body: {
|
|
51749
|
+
accountId: string;
|
|
51750
|
+
images: Array<{
|
|
51751
|
+
url: string;
|
|
51752
|
+
altText?: string;
|
|
51753
|
+
}>;
|
|
51754
|
+
};
|
|
51755
|
+
path: {
|
|
51756
|
+
/**
|
|
51757
|
+
* Platform-native id.
|
|
51758
|
+
*/
|
|
51759
|
+
productId: string;
|
|
51760
|
+
};
|
|
51761
|
+
};
|
|
51762
|
+
|
|
51763
|
+
export type AddCommerceProductImagesResponse = ({
|
|
51764
|
+
product?: CommerceProduct;
|
|
51765
|
+
});
|
|
51766
|
+
|
|
51767
|
+
export type AddCommerceProductImagesError = (ErrorResponse | {
|
|
51768
|
+
error?: string;
|
|
51769
|
+
} | unknown);
|
|
51770
|
+
|
|
51771
|
+
export type RemoveCommerceProductImagesData = {
|
|
51772
|
+
path: {
|
|
51773
|
+
/**
|
|
51774
|
+
* Platform-native id.
|
|
51775
|
+
*/
|
|
51776
|
+
productId: string;
|
|
51777
|
+
};
|
|
51778
|
+
query: {
|
|
51779
|
+
/**
|
|
51780
|
+
* Connected store SocialAccount id.
|
|
51781
|
+
*/
|
|
51782
|
+
accountId: string;
|
|
51783
|
+
/**
|
|
51784
|
+
* Comma-separated ids.
|
|
51785
|
+
*/
|
|
51786
|
+
imageIds: string;
|
|
51787
|
+
};
|
|
51788
|
+
};
|
|
51789
|
+
|
|
51790
|
+
export type RemoveCommerceProductImagesResponse = ({
|
|
51791
|
+
product?: CommerceProduct;
|
|
51792
|
+
});
|
|
51793
|
+
|
|
51794
|
+
export type RemoveCommerceProductImagesError = (ErrorResponse | {
|
|
51795
|
+
error?: string;
|
|
51796
|
+
} | unknown);
|
|
51797
|
+
|
|
51798
|
+
export type ReorderCommerceProductImagesData = {
|
|
51799
|
+
body: {
|
|
51800
|
+
accountId: string;
|
|
51801
|
+
imageIds: Array<(string)>;
|
|
51802
|
+
};
|
|
51803
|
+
path: {
|
|
51804
|
+
/**
|
|
51805
|
+
* Platform-native id.
|
|
51806
|
+
*/
|
|
51807
|
+
productId: string;
|
|
51808
|
+
};
|
|
51809
|
+
};
|
|
51810
|
+
|
|
51811
|
+
export type ReorderCommerceProductImagesResponse = ({
|
|
51812
|
+
pending?: boolean;
|
|
51813
|
+
});
|
|
51814
|
+
|
|
51815
|
+
export type ReorderCommerceProductImagesError = (ErrorResponse | {
|
|
51816
|
+
error?: string;
|
|
51817
|
+
} | unknown);
|
|
51818
|
+
|
|
51819
|
+
export type DuplicateCommerceProductData = {
|
|
51820
|
+
body: {
|
|
51821
|
+
accountId: string;
|
|
51822
|
+
title: string;
|
|
51823
|
+
status?: 'draft' | 'active';
|
|
51824
|
+
includeImages?: boolean;
|
|
51825
|
+
};
|
|
51826
|
+
path: {
|
|
51827
|
+
/**
|
|
51828
|
+
* Platform-native id.
|
|
51829
|
+
*/
|
|
51830
|
+
productId: string;
|
|
51831
|
+
};
|
|
51832
|
+
};
|
|
51833
|
+
|
|
51834
|
+
export type DuplicateCommerceProductResponse = ({
|
|
51835
|
+
product?: CommerceProduct;
|
|
51836
|
+
});
|
|
51837
|
+
|
|
51838
|
+
export type DuplicateCommerceProductError = (ErrorResponse | {
|
|
51839
|
+
error?: string;
|
|
51840
|
+
} | unknown);
|
|
51841
|
+
|
|
51842
|
+
export type ListProductMetafieldsData = {
|
|
51843
|
+
path: {
|
|
51844
|
+
/**
|
|
51845
|
+
* Platform-native id.
|
|
51846
|
+
*/
|
|
51847
|
+
productId: string;
|
|
51848
|
+
};
|
|
51849
|
+
query: {
|
|
51850
|
+
/**
|
|
51851
|
+
* Connected store SocialAccount id.
|
|
51852
|
+
*/
|
|
51853
|
+
accountId: string;
|
|
51854
|
+
};
|
|
51855
|
+
};
|
|
51856
|
+
|
|
51857
|
+
export type ListProductMetafieldsResponse = ({
|
|
51858
|
+
metafields?: Array<CommerceMetafield>;
|
|
51859
|
+
});
|
|
51860
|
+
|
|
51861
|
+
export type ListProductMetafieldsError = (ErrorResponse | {
|
|
51862
|
+
error?: string;
|
|
51863
|
+
} | unknown);
|
|
51864
|
+
|
|
51865
|
+
export type SetProductMetafieldsData = {
|
|
51866
|
+
body: {
|
|
51867
|
+
accountId: string;
|
|
51868
|
+
metafields: Array<CommerceMetafield>;
|
|
51869
|
+
};
|
|
51870
|
+
path: {
|
|
51871
|
+
/**
|
|
51872
|
+
* Platform-native id.
|
|
51873
|
+
*/
|
|
51874
|
+
productId: string;
|
|
51875
|
+
};
|
|
51876
|
+
};
|
|
51877
|
+
|
|
51878
|
+
export type SetProductMetafieldsResponse = ({
|
|
51879
|
+
metafields?: Array<CommerceMetafield>;
|
|
51880
|
+
});
|
|
51881
|
+
|
|
51882
|
+
export type SetProductMetafieldsError = (ErrorResponse | {
|
|
51883
|
+
error?: string;
|
|
51884
|
+
} | unknown);
|
|
51885
|
+
|
|
51886
|
+
export type DeleteProductMetafieldsData = {
|
|
51887
|
+
path: {
|
|
51888
|
+
/**
|
|
51889
|
+
* Platform-native id.
|
|
51890
|
+
*/
|
|
51891
|
+
productId: string;
|
|
51892
|
+
};
|
|
51893
|
+
query: {
|
|
51894
|
+
/**
|
|
51895
|
+
* Connected store SocialAccount id.
|
|
51896
|
+
*/
|
|
51897
|
+
accountId: string;
|
|
51898
|
+
/**
|
|
51899
|
+
* Comma-separated namespace.key pairs.
|
|
51900
|
+
*/
|
|
51901
|
+
keys: string;
|
|
51902
|
+
};
|
|
51903
|
+
};
|
|
51904
|
+
|
|
51905
|
+
export type DeleteProductMetafieldsResponse = ({
|
|
51906
|
+
deleted?: number;
|
|
51907
|
+
});
|
|
51908
|
+
|
|
51909
|
+
export type DeleteProductMetafieldsError = (ErrorResponse | {
|
|
51910
|
+
error?: string;
|
|
51911
|
+
} | unknown);
|
|
51912
|
+
|
|
51913
|
+
export type ChangeProductChannelsData = {
|
|
51914
|
+
body: {
|
|
51915
|
+
accountId: string;
|
|
51916
|
+
/**
|
|
51917
|
+
* Channel ids from GET /v1/commerce/channels.
|
|
51918
|
+
*/
|
|
51919
|
+
publish?: Array<(string)>;
|
|
51920
|
+
unpublish?: Array<(string)>;
|
|
51921
|
+
};
|
|
51922
|
+
path: {
|
|
51923
|
+
/**
|
|
51924
|
+
* Platform-native id.
|
|
51925
|
+
*/
|
|
51926
|
+
productId: string;
|
|
51927
|
+
};
|
|
51928
|
+
};
|
|
51929
|
+
|
|
51930
|
+
export type ChangeProductChannelsResponse = ({
|
|
51931
|
+
productId?: string;
|
|
51932
|
+
published?: Array<(string)>;
|
|
51933
|
+
unpublished?: Array<(string)>;
|
|
51934
|
+
});
|
|
51935
|
+
|
|
51936
|
+
export type ChangeProductChannelsError = (ErrorResponse | {
|
|
51937
|
+
error?: string;
|
|
51938
|
+
} | unknown);
|
|
51939
|
+
|
|
51940
|
+
export type ListCollectionMetafieldsData = {
|
|
51941
|
+
path: {
|
|
51942
|
+
/**
|
|
51943
|
+
* Platform-native id.
|
|
51944
|
+
*/
|
|
51945
|
+
collectionId: string;
|
|
51946
|
+
};
|
|
51947
|
+
query: {
|
|
51948
|
+
/**
|
|
51949
|
+
* Connected store SocialAccount id.
|
|
51950
|
+
*/
|
|
51951
|
+
accountId: string;
|
|
51952
|
+
};
|
|
51953
|
+
};
|
|
51954
|
+
|
|
51955
|
+
export type ListCollectionMetafieldsResponse = ({
|
|
51956
|
+
metafields?: Array<CommerceMetafield>;
|
|
51957
|
+
});
|
|
51958
|
+
|
|
51959
|
+
export type ListCollectionMetafieldsError = (ErrorResponse | {
|
|
51960
|
+
error?: string;
|
|
51961
|
+
} | unknown);
|
|
51962
|
+
|
|
51963
|
+
export type SetCollectionMetafieldsData = {
|
|
51964
|
+
body: {
|
|
51965
|
+
accountId: string;
|
|
51966
|
+
metafields: Array<CommerceMetafield>;
|
|
51967
|
+
};
|
|
51968
|
+
path: {
|
|
51969
|
+
/**
|
|
51970
|
+
* Platform-native id.
|
|
51971
|
+
*/
|
|
51972
|
+
collectionId: string;
|
|
51973
|
+
};
|
|
51974
|
+
};
|
|
51975
|
+
|
|
51976
|
+
export type SetCollectionMetafieldsResponse = ({
|
|
51977
|
+
metafields?: Array<CommerceMetafield>;
|
|
51978
|
+
});
|
|
51979
|
+
|
|
51980
|
+
export type SetCollectionMetafieldsError = (ErrorResponse | {
|
|
51981
|
+
error?: string;
|
|
51982
|
+
} | unknown);
|
|
51983
|
+
|
|
51984
|
+
export type DeleteCollectionMetafieldsData = {
|
|
51985
|
+
path: {
|
|
51986
|
+
/**
|
|
51987
|
+
* Platform-native id.
|
|
51988
|
+
*/
|
|
51989
|
+
collectionId: string;
|
|
51990
|
+
};
|
|
51991
|
+
query: {
|
|
51992
|
+
/**
|
|
51993
|
+
* Connected store SocialAccount id.
|
|
51994
|
+
*/
|
|
51995
|
+
accountId: string;
|
|
51996
|
+
/**
|
|
51997
|
+
* Comma-separated namespace.key pairs.
|
|
51998
|
+
*/
|
|
51999
|
+
keys: string;
|
|
52000
|
+
};
|
|
52001
|
+
};
|
|
52002
|
+
|
|
52003
|
+
export type DeleteCollectionMetafieldsResponse = ({
|
|
52004
|
+
deleted?: number;
|
|
52005
|
+
});
|
|
52006
|
+
|
|
52007
|
+
export type DeleteCollectionMetafieldsError = (ErrorResponse | {
|
|
52008
|
+
error?: string;
|
|
52009
|
+
} | unknown);
|
|
52010
|
+
|
|
52011
|
+
export type ChangeCollectionChannelsData = {
|
|
52012
|
+
body: {
|
|
52013
|
+
accountId: string;
|
|
52014
|
+
/**
|
|
52015
|
+
* Channel ids from GET /v1/commerce/channels.
|
|
52016
|
+
*/
|
|
52017
|
+
publish?: Array<(string)>;
|
|
52018
|
+
unpublish?: Array<(string)>;
|
|
52019
|
+
};
|
|
52020
|
+
path: {
|
|
52021
|
+
/**
|
|
52022
|
+
* Platform-native id.
|
|
52023
|
+
*/
|
|
52024
|
+
collectionId: string;
|
|
52025
|
+
};
|
|
52026
|
+
};
|
|
52027
|
+
|
|
52028
|
+
export type ChangeCollectionChannelsResponse = ({
|
|
52029
|
+
collectionId?: string;
|
|
52030
|
+
published?: Array<(string)>;
|
|
52031
|
+
unpublished?: Array<(string)>;
|
|
52032
|
+
});
|
|
52033
|
+
|
|
52034
|
+
export type ChangeCollectionChannelsError = (ErrorResponse | {
|
|
52035
|
+
error?: string;
|
|
52036
|
+
} | unknown);
|
|
52037
|
+
|
|
52038
|
+
export type ChangeCommerceProductTagsData = {
|
|
52039
|
+
body: {
|
|
52040
|
+
accountId: string;
|
|
52041
|
+
productIds: Array<(string)>;
|
|
52042
|
+
add?: Array<(string)>;
|
|
52043
|
+
remove?: Array<(string)>;
|
|
52044
|
+
};
|
|
52045
|
+
};
|
|
52046
|
+
|
|
52047
|
+
export type ChangeCommerceProductTagsResponse = ({
|
|
52048
|
+
succeeded?: Array<(string)>;
|
|
52049
|
+
failed?: Array<{
|
|
52050
|
+
id?: string;
|
|
52051
|
+
message?: string;
|
|
52052
|
+
}>;
|
|
52053
|
+
});
|
|
52054
|
+
|
|
52055
|
+
export type ChangeCommerceProductTagsError = (ErrorResponse | {
|
|
52056
|
+
error?: string;
|
|
52057
|
+
} | unknown);
|
|
52058
|
+
|
|
52059
|
+
export type ReorderCommerceCollectionProductsData = {
|
|
52060
|
+
body: {
|
|
52061
|
+
accountId: string;
|
|
52062
|
+
moves: Array<{
|
|
52063
|
+
productId: string;
|
|
52064
|
+
position: number;
|
|
52065
|
+
}>;
|
|
52066
|
+
};
|
|
52067
|
+
path: {
|
|
52068
|
+
/**
|
|
52069
|
+
* Platform-native id.
|
|
52070
|
+
*/
|
|
52071
|
+
collectionId: string;
|
|
52072
|
+
};
|
|
52073
|
+
};
|
|
52074
|
+
|
|
52075
|
+
export type ReorderCommerceCollectionProductsResponse = ({
|
|
52076
|
+
pending?: boolean;
|
|
52077
|
+
});
|
|
52078
|
+
|
|
52079
|
+
export type ReorderCommerceCollectionProductsError = (ErrorResponse | {
|
|
52080
|
+
error?: string;
|
|
52081
|
+
} | unknown);
|
|
52082
|
+
|
|
52083
|
+
export type ListCommercePagesData = {
|
|
52084
|
+
query: {
|
|
52085
|
+
/**
|
|
52086
|
+
* Connected store SocialAccount id.
|
|
52087
|
+
*/
|
|
52088
|
+
accountId: string;
|
|
52089
|
+
cursor?: string;
|
|
52090
|
+
limit?: number;
|
|
52091
|
+
/**
|
|
52092
|
+
* Platform search syntax, passed through.
|
|
52093
|
+
*/
|
|
52094
|
+
query?: string;
|
|
52095
|
+
};
|
|
52096
|
+
};
|
|
52097
|
+
|
|
52098
|
+
export type ListCommercePagesResponse = ({
|
|
52099
|
+
pages?: Array<CommercePage>;
|
|
52100
|
+
nextCursor?: (string) | null;
|
|
52101
|
+
});
|
|
52102
|
+
|
|
52103
|
+
export type ListCommercePagesError = (ErrorResponse | {
|
|
52104
|
+
error?: string;
|
|
52105
|
+
} | unknown);
|
|
52106
|
+
|
|
52107
|
+
export type CreateCommercePageData = {
|
|
52108
|
+
body: {
|
|
52109
|
+
accountId: string;
|
|
52110
|
+
title: string;
|
|
52111
|
+
handle?: string;
|
|
52112
|
+
bodyHtml?: string;
|
|
52113
|
+
isPublished?: boolean;
|
|
52114
|
+
};
|
|
52115
|
+
};
|
|
52116
|
+
|
|
52117
|
+
export type CreateCommercePageResponse = ({
|
|
52118
|
+
page?: CommercePage;
|
|
52119
|
+
});
|
|
52120
|
+
|
|
52121
|
+
export type CreateCommercePageError = (ErrorResponse | {
|
|
52122
|
+
error?: string;
|
|
52123
|
+
} | unknown);
|
|
52124
|
+
|
|
52125
|
+
export type GetCommercePageData = {
|
|
52126
|
+
path: {
|
|
52127
|
+
/**
|
|
52128
|
+
* Platform-native id.
|
|
52129
|
+
*/
|
|
52130
|
+
pageId: string;
|
|
52131
|
+
};
|
|
52132
|
+
query: {
|
|
52133
|
+
/**
|
|
52134
|
+
* Connected store SocialAccount id.
|
|
52135
|
+
*/
|
|
52136
|
+
accountId: string;
|
|
52137
|
+
};
|
|
52138
|
+
};
|
|
52139
|
+
|
|
52140
|
+
export type GetCommercePageResponse = ({
|
|
52141
|
+
page?: CommercePage;
|
|
52142
|
+
});
|
|
52143
|
+
|
|
52144
|
+
export type GetCommercePageError = (ErrorResponse | {
|
|
52145
|
+
error?: string;
|
|
52146
|
+
} | unknown);
|
|
52147
|
+
|
|
52148
|
+
export type UpdateCommercePageData = {
|
|
52149
|
+
body: {
|
|
52150
|
+
accountId: string;
|
|
52151
|
+
title?: string;
|
|
52152
|
+
handle?: string;
|
|
52153
|
+
bodyHtml?: string;
|
|
52154
|
+
isPublished?: boolean;
|
|
52155
|
+
};
|
|
52156
|
+
path: {
|
|
52157
|
+
/**
|
|
52158
|
+
* Platform-native id.
|
|
52159
|
+
*/
|
|
52160
|
+
pageId: string;
|
|
52161
|
+
};
|
|
52162
|
+
};
|
|
52163
|
+
|
|
52164
|
+
export type UpdateCommercePageResponse = ({
|
|
52165
|
+
page?: CommercePage;
|
|
52166
|
+
});
|
|
52167
|
+
|
|
52168
|
+
export type UpdateCommercePageError = (ErrorResponse | {
|
|
52169
|
+
error?: string;
|
|
52170
|
+
} | unknown);
|
|
52171
|
+
|
|
52172
|
+
export type DeleteCommercePageData = {
|
|
52173
|
+
path: {
|
|
52174
|
+
/**
|
|
52175
|
+
* Platform-native id.
|
|
52176
|
+
*/
|
|
52177
|
+
pageId: string;
|
|
52178
|
+
};
|
|
52179
|
+
query: {
|
|
52180
|
+
/**
|
|
52181
|
+
* Connected store SocialAccount id.
|
|
52182
|
+
*/
|
|
52183
|
+
accountId: string;
|
|
52184
|
+
};
|
|
52185
|
+
};
|
|
52186
|
+
|
|
52187
|
+
export type DeleteCommercePageResponse = ({
|
|
52188
|
+
deleted?: boolean;
|
|
52189
|
+
pageId?: string;
|
|
52190
|
+
});
|
|
52191
|
+
|
|
52192
|
+
export type DeleteCommercePageError = (ErrorResponse | {
|
|
52193
|
+
error?: string;
|
|
52194
|
+
} | unknown);
|
|
52195
|
+
|
|
52196
|
+
export type ListCommerceLocationsData = {
|
|
52197
|
+
query: {
|
|
52198
|
+
/**
|
|
52199
|
+
* Connected store SocialAccount id.
|
|
52200
|
+
*/
|
|
52201
|
+
accountId: string;
|
|
52202
|
+
};
|
|
52203
|
+
};
|
|
52204
|
+
|
|
52205
|
+
export type ListCommerceLocationsResponse = ({
|
|
52206
|
+
locations?: Array<CommerceLocation>;
|
|
52207
|
+
});
|
|
52208
|
+
|
|
52209
|
+
export type ListCommerceLocationsError = (ErrorResponse | {
|
|
52210
|
+
error?: string;
|
|
52211
|
+
} | unknown);
|
|
52212
|
+
|
|
52213
|
+
export type ListCommerceInventoryData = {
|
|
52214
|
+
query: {
|
|
52215
|
+
/**
|
|
52216
|
+
* Connected store SocialAccount id.
|
|
52217
|
+
*/
|
|
52218
|
+
accountId: string;
|
|
52219
|
+
productId: string;
|
|
52220
|
+
};
|
|
52221
|
+
};
|
|
52222
|
+
|
|
52223
|
+
export type ListCommerceInventoryResponse = ({
|
|
52224
|
+
inventory?: Array<CommerceInventoryItem>;
|
|
52225
|
+
});
|
|
52226
|
+
|
|
52227
|
+
export type ListCommerceInventoryError = (ErrorResponse | {
|
|
52228
|
+
error?: string;
|
|
52229
|
+
} | unknown);
|
|
52230
|
+
|
|
52231
|
+
export type ChangeCommerceInventoryData = {
|
|
52232
|
+
body: {
|
|
52233
|
+
accountId: string;
|
|
52234
|
+
mode?: 'set' | 'adjust';
|
|
52235
|
+
changes: Array<{
|
|
52236
|
+
variantId: string;
|
|
52237
|
+
locationId: string;
|
|
52238
|
+
quantity: number;
|
|
52239
|
+
}>;
|
|
52240
|
+
};
|
|
52241
|
+
path: {
|
|
52242
|
+
/**
|
|
52243
|
+
* Platform-native id.
|
|
52244
|
+
*/
|
|
52245
|
+
productId: string;
|
|
52246
|
+
};
|
|
52247
|
+
};
|
|
52248
|
+
|
|
52249
|
+
export type ChangeCommerceInventoryResponse = ({
|
|
52250
|
+
inventory?: Array<CommerceInventoryItem>;
|
|
52251
|
+
});
|
|
52252
|
+
|
|
52253
|
+
export type ChangeCommerceInventoryError = (ErrorResponse | {
|
|
52254
|
+
error?: string;
|
|
52255
|
+
} | unknown);
|
|
52256
|
+
|
|
52257
|
+
export type ListCommerceChannelsData = {
|
|
52258
|
+
query: {
|
|
52259
|
+
/**
|
|
52260
|
+
* Connected store SocialAccount id.
|
|
52261
|
+
*/
|
|
52262
|
+
accountId: string;
|
|
52263
|
+
};
|
|
52264
|
+
};
|
|
52265
|
+
|
|
52266
|
+
export type ListCommerceChannelsResponse = ({
|
|
52267
|
+
channels?: Array<CommerceChannel>;
|
|
52268
|
+
});
|
|
52269
|
+
|
|
52270
|
+
export type ListCommerceChannelsError = (ErrorResponse | {
|
|
52271
|
+
error?: string;
|
|
52272
|
+
} | unknown);
|
|
52273
|
+
|
|
52274
|
+
export type ListCommerceDiscountsData = {
|
|
52275
|
+
query: {
|
|
52276
|
+
/**
|
|
52277
|
+
* Connected store SocialAccount id.
|
|
52278
|
+
*/
|
|
52279
|
+
accountId: string;
|
|
52280
|
+
cursor?: string;
|
|
52281
|
+
limit?: number;
|
|
52282
|
+
/**
|
|
52283
|
+
* Platform search syntax, passed through.
|
|
52284
|
+
*/
|
|
52285
|
+
query?: string;
|
|
52286
|
+
};
|
|
52287
|
+
};
|
|
52288
|
+
|
|
52289
|
+
export type ListCommerceDiscountsResponse = ({
|
|
52290
|
+
discounts?: Array<CommerceDiscount>;
|
|
52291
|
+
nextCursor?: (string) | null;
|
|
52292
|
+
});
|
|
52293
|
+
|
|
52294
|
+
export type ListCommerceDiscountsError = (ErrorResponse | {
|
|
52295
|
+
error?: string;
|
|
52296
|
+
} | unknown);
|
|
52297
|
+
|
|
52298
|
+
export type CreateCommerceDiscountData = {
|
|
52299
|
+
body: {
|
|
52300
|
+
accountId: string;
|
|
52301
|
+
title: string;
|
|
52302
|
+
method: 'code' | 'automatic';
|
|
52303
|
+
type: 'percentage' | 'fixed_amount' | 'free_shipping';
|
|
52304
|
+
/**
|
|
52305
|
+
* Required for method code.
|
|
52306
|
+
*/
|
|
52307
|
+
code?: string;
|
|
52308
|
+
/**
|
|
52309
|
+
* For type percentage, e.g. 15 for 15%.
|
|
52310
|
+
*/
|
|
52311
|
+
percentage?: number;
|
|
52312
|
+
/**
|
|
52313
|
+
* For type fixed_amount, a decimal in the store currency.
|
|
52314
|
+
*/
|
|
52315
|
+
amount?: string;
|
|
52316
|
+
/**
|
|
52317
|
+
* fixed_amount only: take the amount off each item instead of once per order.
|
|
52318
|
+
*/
|
|
52319
|
+
appliesOnEachItem?: boolean;
|
|
52320
|
+
/**
|
|
52321
|
+
* Minimum order subtotal, a decimal in the store currency.
|
|
52322
|
+
*/
|
|
52323
|
+
minimumSubtotal?: (string) | null;
|
|
52324
|
+
minimumQuantity?: (number) | null;
|
|
52325
|
+
/**
|
|
52326
|
+
* Code discounts only: total uses allowed.
|
|
52327
|
+
*/
|
|
52328
|
+
usageLimit?: (number) | null;
|
|
52329
|
+
/**
|
|
52330
|
+
* Code discounts only.
|
|
52331
|
+
*/
|
|
52332
|
+
oncePerCustomer?: boolean;
|
|
52333
|
+
/**
|
|
52334
|
+
* Defaults to now.
|
|
52335
|
+
*/
|
|
52336
|
+
startsAt?: string;
|
|
52337
|
+
endsAt?: (string) | null;
|
|
52338
|
+
productIds?: Array<(string)>;
|
|
52339
|
+
collectionIds?: Array<(string)>;
|
|
52340
|
+
};
|
|
52341
|
+
};
|
|
52342
|
+
|
|
52343
|
+
export type CreateCommerceDiscountResponse = ({
|
|
52344
|
+
discount?: CommerceDiscount;
|
|
52345
|
+
});
|
|
52346
|
+
|
|
52347
|
+
export type CreateCommerceDiscountError = (ErrorResponse | {
|
|
52348
|
+
error?: string;
|
|
52349
|
+
} | unknown);
|
|
52350
|
+
|
|
52351
|
+
export type GetCommerceDiscountData = {
|
|
52352
|
+
path: {
|
|
52353
|
+
/**
|
|
52354
|
+
* Platform-native id.
|
|
52355
|
+
*/
|
|
52356
|
+
discountId: string;
|
|
52357
|
+
};
|
|
52358
|
+
query: {
|
|
52359
|
+
/**
|
|
52360
|
+
* Connected store SocialAccount id.
|
|
52361
|
+
*/
|
|
52362
|
+
accountId: string;
|
|
52363
|
+
};
|
|
52364
|
+
};
|
|
52365
|
+
|
|
52366
|
+
export type GetCommerceDiscountResponse = ({
|
|
52367
|
+
discount?: CommerceDiscount;
|
|
52368
|
+
});
|
|
52369
|
+
|
|
52370
|
+
export type GetCommerceDiscountError = (ErrorResponse | {
|
|
52371
|
+
error?: string;
|
|
52372
|
+
} | unknown);
|
|
52373
|
+
|
|
52374
|
+
export type UpdateCommerceDiscountData = {
|
|
52375
|
+
body: {
|
|
52376
|
+
accountId: string;
|
|
52377
|
+
title?: string;
|
|
52378
|
+
/**
|
|
52379
|
+
* Required for method code.
|
|
52380
|
+
*/
|
|
52381
|
+
code?: string;
|
|
52382
|
+
/**
|
|
52383
|
+
* For type percentage, e.g. 15 for 15%.
|
|
52384
|
+
*/
|
|
52385
|
+
percentage?: number;
|
|
52386
|
+
/**
|
|
52387
|
+
* For type fixed_amount, a decimal in the store currency.
|
|
52388
|
+
*/
|
|
52389
|
+
amount?: string;
|
|
52390
|
+
/**
|
|
52391
|
+
* fixed_amount only: take the amount off each item instead of once per order.
|
|
52392
|
+
*/
|
|
52393
|
+
appliesOnEachItem?: boolean;
|
|
52394
|
+
/**
|
|
52395
|
+
* Minimum order subtotal, a decimal in the store currency.
|
|
52396
|
+
*/
|
|
52397
|
+
minimumSubtotal?: (string) | null;
|
|
52398
|
+
minimumQuantity?: (number) | null;
|
|
52399
|
+
/**
|
|
52400
|
+
* Code discounts only: total uses allowed.
|
|
52401
|
+
*/
|
|
52402
|
+
usageLimit?: (number) | null;
|
|
52403
|
+
/**
|
|
52404
|
+
* Code discounts only.
|
|
52405
|
+
*/
|
|
52406
|
+
oncePerCustomer?: boolean;
|
|
52407
|
+
/**
|
|
52408
|
+
* Defaults to now.
|
|
52409
|
+
*/
|
|
52410
|
+
startsAt?: string;
|
|
52411
|
+
endsAt?: (string) | null;
|
|
52412
|
+
};
|
|
52413
|
+
path: {
|
|
52414
|
+
/**
|
|
52415
|
+
* Platform-native id.
|
|
52416
|
+
*/
|
|
52417
|
+
discountId: string;
|
|
52418
|
+
};
|
|
52419
|
+
};
|
|
52420
|
+
|
|
52421
|
+
export type UpdateCommerceDiscountResponse = ({
|
|
52422
|
+
discount?: CommerceDiscount;
|
|
52423
|
+
});
|
|
52424
|
+
|
|
52425
|
+
export type UpdateCommerceDiscountError = (ErrorResponse | {
|
|
52426
|
+
error?: string;
|
|
52427
|
+
} | unknown);
|
|
52428
|
+
|
|
52429
|
+
export type DeleteCommerceDiscountData = {
|
|
52430
|
+
path: {
|
|
52431
|
+
/**
|
|
52432
|
+
* Platform-native id.
|
|
52433
|
+
*/
|
|
52434
|
+
discountId: string;
|
|
52435
|
+
};
|
|
52436
|
+
query: {
|
|
52437
|
+
/**
|
|
52438
|
+
* Connected store SocialAccount id.
|
|
52439
|
+
*/
|
|
52440
|
+
accountId: string;
|
|
52441
|
+
};
|
|
52442
|
+
};
|
|
52443
|
+
|
|
52444
|
+
export type DeleteCommerceDiscountResponse = ({
|
|
52445
|
+
deleted?: boolean;
|
|
52446
|
+
discountId?: string;
|
|
52447
|
+
});
|
|
52448
|
+
|
|
52449
|
+
export type DeleteCommerceDiscountError = (ErrorResponse | {
|
|
52450
|
+
error?: string;
|
|
52451
|
+
} | unknown);
|
|
52452
|
+
|
|
52453
|
+
export type SetCommerceDiscountActiveData = {
|
|
52454
|
+
body: {
|
|
52455
|
+
accountId: string;
|
|
52456
|
+
active: boolean;
|
|
52457
|
+
};
|
|
52458
|
+
path: {
|
|
52459
|
+
/**
|
|
52460
|
+
* Platform-native id.
|
|
52461
|
+
*/
|
|
52462
|
+
discountId: string;
|
|
52463
|
+
};
|
|
52464
|
+
};
|
|
52465
|
+
|
|
52466
|
+
export type SetCommerceDiscountActiveResponse = ({
|
|
52467
|
+
discount?: CommerceDiscount;
|
|
52468
|
+
});
|
|
52469
|
+
|
|
52470
|
+
export type SetCommerceDiscountActiveError = (ErrorResponse | {
|
|
52471
|
+
error?: string;
|
|
52472
|
+
} | unknown);
|
|
52473
|
+
|
|
52474
|
+
export type AddCommerceDiscountCodesData = {
|
|
52475
|
+
body: {
|
|
52476
|
+
accountId: string;
|
|
52477
|
+
codes: Array<(string)>;
|
|
52478
|
+
};
|
|
52479
|
+
path: {
|
|
52480
|
+
/**
|
|
52481
|
+
* Platform-native id.
|
|
52482
|
+
*/
|
|
52483
|
+
discountId: string;
|
|
52484
|
+
};
|
|
52485
|
+
};
|
|
52486
|
+
|
|
52487
|
+
export type AddCommerceDiscountCodesResponse = ({
|
|
52488
|
+
pending?: boolean;
|
|
52489
|
+
});
|
|
52490
|
+
|
|
52491
|
+
export type AddCommerceDiscountCodesError = (ErrorResponse | {
|
|
52492
|
+
error?: string;
|
|
52493
|
+
} | unknown);
|
|
52494
|
+
|
|
52495
|
+
export type ListCommerceRedirectsData = {
|
|
52496
|
+
query: {
|
|
52497
|
+
/**
|
|
52498
|
+
* Connected store SocialAccount id.
|
|
52499
|
+
*/
|
|
52500
|
+
accountId: string;
|
|
52501
|
+
cursor?: string;
|
|
52502
|
+
limit?: number;
|
|
52503
|
+
/**
|
|
52504
|
+
* Platform search syntax, passed through.
|
|
52505
|
+
*/
|
|
52506
|
+
query?: string;
|
|
52507
|
+
};
|
|
52508
|
+
};
|
|
52509
|
+
|
|
52510
|
+
export type ListCommerceRedirectsResponse = ({
|
|
52511
|
+
redirects?: Array<CommerceRedirect>;
|
|
52512
|
+
nextCursor?: (string) | null;
|
|
52513
|
+
});
|
|
52514
|
+
|
|
52515
|
+
export type ListCommerceRedirectsError = (ErrorResponse | {
|
|
52516
|
+
error?: string;
|
|
52517
|
+
} | unknown);
|
|
52518
|
+
|
|
52519
|
+
export type CreateCommerceRedirectData = {
|
|
52520
|
+
body: {
|
|
52521
|
+
accountId: string;
|
|
52522
|
+
/**
|
|
52523
|
+
* The old path, starting with /.
|
|
52524
|
+
*/
|
|
52525
|
+
path: string;
|
|
52526
|
+
/**
|
|
52527
|
+
* Where to send visitors: a path or a full URL.
|
|
52528
|
+
*/
|
|
52529
|
+
target: string;
|
|
52530
|
+
};
|
|
52531
|
+
};
|
|
52532
|
+
|
|
52533
|
+
export type CreateCommerceRedirectResponse = ({
|
|
52534
|
+
redirect?: CommerceRedirect;
|
|
52535
|
+
});
|
|
52536
|
+
|
|
52537
|
+
export type CreateCommerceRedirectError = (ErrorResponse | {
|
|
52538
|
+
error?: string;
|
|
52539
|
+
} | unknown);
|
|
52540
|
+
|
|
52541
|
+
export type UpdateCommerceRedirectData = {
|
|
52542
|
+
body: {
|
|
52543
|
+
accountId: string;
|
|
52544
|
+
path?: string;
|
|
52545
|
+
target?: string;
|
|
52546
|
+
};
|
|
52547
|
+
path: {
|
|
52548
|
+
/**
|
|
52549
|
+
* Platform-native id.
|
|
52550
|
+
*/
|
|
52551
|
+
redirectId: string;
|
|
52552
|
+
};
|
|
52553
|
+
};
|
|
52554
|
+
|
|
52555
|
+
export type UpdateCommerceRedirectResponse = ({
|
|
52556
|
+
redirect?: CommerceRedirect;
|
|
52557
|
+
});
|
|
52558
|
+
|
|
52559
|
+
export type UpdateCommerceRedirectError = (ErrorResponse | {
|
|
52560
|
+
error?: string;
|
|
52561
|
+
} | unknown);
|
|
52562
|
+
|
|
52563
|
+
export type DeleteCommerceRedirectData = {
|
|
52564
|
+
path: {
|
|
52565
|
+
/**
|
|
52566
|
+
* Platform-native id.
|
|
52567
|
+
*/
|
|
52568
|
+
redirectId: string;
|
|
52569
|
+
};
|
|
52570
|
+
query: {
|
|
52571
|
+
/**
|
|
52572
|
+
* Connected store SocialAccount id.
|
|
52573
|
+
*/
|
|
52574
|
+
accountId: string;
|
|
52575
|
+
};
|
|
52576
|
+
};
|
|
52577
|
+
|
|
52578
|
+
export type DeleteCommerceRedirectResponse = ({
|
|
52579
|
+
deleted?: boolean;
|
|
52580
|
+
redirectId?: string;
|
|
52581
|
+
});
|
|
52582
|
+
|
|
52583
|
+
export type DeleteCommerceRedirectError = (ErrorResponse | {
|
|
52584
|
+
error?: string;
|
|
52585
|
+
} | unknown);
|
|
52586
|
+
|
|
52587
|
+
export type ListCommerceMenusData = {
|
|
52588
|
+
query: {
|
|
52589
|
+
/**
|
|
52590
|
+
* Connected store SocialAccount id.
|
|
52591
|
+
*/
|
|
52592
|
+
accountId: string;
|
|
52593
|
+
};
|
|
52594
|
+
};
|
|
52595
|
+
|
|
52596
|
+
export type ListCommerceMenusResponse = ({
|
|
52597
|
+
menus?: Array<CommerceMenu>;
|
|
52598
|
+
});
|
|
52599
|
+
|
|
52600
|
+
export type ListCommerceMenusError = (ErrorResponse | {
|
|
52601
|
+
error?: string;
|
|
52602
|
+
} | unknown);
|
|
52603
|
+
|
|
52604
|
+
export type CreateCommerceMenuData = {
|
|
52605
|
+
body: {
|
|
52606
|
+
accountId: string;
|
|
52607
|
+
title: string;
|
|
52608
|
+
handle: string;
|
|
52609
|
+
items: Array<CommerceMenuItemInput>;
|
|
52610
|
+
};
|
|
52611
|
+
};
|
|
52612
|
+
|
|
52613
|
+
export type CreateCommerceMenuResponse = ({
|
|
52614
|
+
menu?: CommerceMenu;
|
|
52615
|
+
});
|
|
52616
|
+
|
|
52617
|
+
export type CreateCommerceMenuError = (ErrorResponse | {
|
|
52618
|
+
error?: string;
|
|
52619
|
+
} | unknown);
|
|
52620
|
+
|
|
52621
|
+
export type GetCommerceMenuData = {
|
|
52622
|
+
path: {
|
|
52623
|
+
/**
|
|
52624
|
+
* Platform-native id.
|
|
52625
|
+
*/
|
|
52626
|
+
menuId: string;
|
|
52627
|
+
};
|
|
52628
|
+
query: {
|
|
52629
|
+
/**
|
|
52630
|
+
* Connected store SocialAccount id.
|
|
52631
|
+
*/
|
|
52632
|
+
accountId: string;
|
|
52633
|
+
};
|
|
52634
|
+
};
|
|
52635
|
+
|
|
52636
|
+
export type GetCommerceMenuResponse = ({
|
|
52637
|
+
menu?: CommerceMenu;
|
|
52638
|
+
});
|
|
52639
|
+
|
|
52640
|
+
export type GetCommerceMenuError = (ErrorResponse | {
|
|
52641
|
+
error?: string;
|
|
52642
|
+
} | unknown);
|
|
52643
|
+
|
|
52644
|
+
export type UpdateCommerceMenuData = {
|
|
52645
|
+
body: {
|
|
52646
|
+
accountId: string;
|
|
52647
|
+
title: string;
|
|
52648
|
+
handle?: string;
|
|
52649
|
+
items: Array<CommerceMenuItemInput>;
|
|
52650
|
+
};
|
|
52651
|
+
path: {
|
|
52652
|
+
/**
|
|
52653
|
+
* Platform-native id.
|
|
52654
|
+
*/
|
|
52655
|
+
menuId: string;
|
|
52656
|
+
};
|
|
52657
|
+
};
|
|
52658
|
+
|
|
52659
|
+
export type UpdateCommerceMenuResponse = ({
|
|
52660
|
+
menu?: CommerceMenu;
|
|
52661
|
+
});
|
|
52662
|
+
|
|
52663
|
+
export type UpdateCommerceMenuError = (ErrorResponse | {
|
|
52664
|
+
error?: string;
|
|
52665
|
+
} | unknown);
|
|
52666
|
+
|
|
52667
|
+
export type DeleteCommerceMenuData = {
|
|
52668
|
+
path: {
|
|
52669
|
+
/**
|
|
52670
|
+
* Platform-native id.
|
|
52671
|
+
*/
|
|
52672
|
+
menuId: string;
|
|
52673
|
+
};
|
|
52674
|
+
query: {
|
|
52675
|
+
/**
|
|
52676
|
+
* Connected store SocialAccount id.
|
|
52677
|
+
*/
|
|
52678
|
+
accountId: string;
|
|
52679
|
+
};
|
|
52680
|
+
};
|
|
52681
|
+
|
|
52682
|
+
export type DeleteCommerceMenuResponse = ({
|
|
52683
|
+
deleted?: boolean;
|
|
52684
|
+
menuId?: string;
|
|
52685
|
+
});
|
|
52686
|
+
|
|
52687
|
+
export type DeleteCommerceMenuError = (ErrorResponse | {
|
|
52688
|
+
error?: string;
|
|
52689
|
+
} | unknown);
|
|
52690
|
+
|
|
52691
|
+
export type ListCommerceMetaobjectDefinitionsData = {
|
|
52692
|
+
query: {
|
|
52693
|
+
/**
|
|
52694
|
+
* Connected store SocialAccount id.
|
|
52695
|
+
*/
|
|
52696
|
+
accountId: string;
|
|
52697
|
+
};
|
|
52698
|
+
};
|
|
52699
|
+
|
|
52700
|
+
export type ListCommerceMetaobjectDefinitionsResponse = ({
|
|
52701
|
+
definitions?: Array<CommerceMetaobjectDefinition>;
|
|
52702
|
+
});
|
|
52703
|
+
|
|
52704
|
+
export type ListCommerceMetaobjectDefinitionsError = (ErrorResponse | {
|
|
52705
|
+
error?: string;
|
|
52706
|
+
} | unknown);
|
|
52707
|
+
|
|
52708
|
+
export type ListCommerceMetaobjectsData = {
|
|
52709
|
+
query: {
|
|
52710
|
+
/**
|
|
52711
|
+
* Connected store SocialAccount id.
|
|
52712
|
+
*/
|
|
52713
|
+
accountId: string;
|
|
52714
|
+
cursor?: string;
|
|
52715
|
+
limit?: number;
|
|
52716
|
+
/**
|
|
52717
|
+
* Definition type from GET /v1/commerce/metaobject-definitions.
|
|
52718
|
+
*/
|
|
52719
|
+
type: string;
|
|
52720
|
+
};
|
|
52721
|
+
};
|
|
52722
|
+
|
|
52723
|
+
export type ListCommerceMetaobjectsResponse = ({
|
|
52724
|
+
metaobjects?: Array<CommerceMetaobject>;
|
|
52725
|
+
nextCursor?: (string) | null;
|
|
52726
|
+
});
|
|
52727
|
+
|
|
52728
|
+
export type ListCommerceMetaobjectsError = (ErrorResponse | {
|
|
52729
|
+
error?: string;
|
|
52730
|
+
} | unknown);
|
|
52731
|
+
|
|
52732
|
+
export type CreateCommerceMetaobjectData = {
|
|
52733
|
+
body: {
|
|
52734
|
+
accountId: string;
|
|
52735
|
+
type: string;
|
|
52736
|
+
handle?: string;
|
|
52737
|
+
fields: Array<{
|
|
52738
|
+
key: string;
|
|
52739
|
+
value: string;
|
|
52740
|
+
}>;
|
|
52741
|
+
};
|
|
52742
|
+
};
|
|
52743
|
+
|
|
52744
|
+
export type CreateCommerceMetaobjectResponse = ({
|
|
52745
|
+
metaobject?: CommerceMetaobject;
|
|
52746
|
+
});
|
|
52747
|
+
|
|
52748
|
+
export type CreateCommerceMetaobjectError = (ErrorResponse | {
|
|
52749
|
+
error?: string;
|
|
52750
|
+
} | unknown);
|
|
52751
|
+
|
|
52752
|
+
export type GetCommerceMetaobjectData = {
|
|
52753
|
+
path: {
|
|
52754
|
+
/**
|
|
52755
|
+
* Platform-native id.
|
|
52756
|
+
*/
|
|
52757
|
+
metaobjectId: string;
|
|
52758
|
+
};
|
|
52759
|
+
query: {
|
|
52760
|
+
/**
|
|
52761
|
+
* Connected store SocialAccount id.
|
|
52762
|
+
*/
|
|
52763
|
+
accountId: string;
|
|
52764
|
+
};
|
|
52765
|
+
};
|
|
52766
|
+
|
|
52767
|
+
export type GetCommerceMetaobjectResponse = ({
|
|
52768
|
+
metaobject?: CommerceMetaobject;
|
|
52769
|
+
});
|
|
52770
|
+
|
|
52771
|
+
export type GetCommerceMetaobjectError = (ErrorResponse | {
|
|
52772
|
+
error?: string;
|
|
52773
|
+
} | unknown);
|
|
52774
|
+
|
|
52775
|
+
export type UpdateCommerceMetaobjectData = {
|
|
52776
|
+
body: {
|
|
52777
|
+
accountId: string;
|
|
52778
|
+
handle?: string;
|
|
52779
|
+
fields: Array<{
|
|
52780
|
+
key: string;
|
|
52781
|
+
value: string;
|
|
52782
|
+
}>;
|
|
52783
|
+
};
|
|
52784
|
+
path: {
|
|
52785
|
+
/**
|
|
52786
|
+
* Platform-native id.
|
|
52787
|
+
*/
|
|
52788
|
+
metaobjectId: string;
|
|
52789
|
+
};
|
|
52790
|
+
};
|
|
52791
|
+
|
|
52792
|
+
export type UpdateCommerceMetaobjectResponse = ({
|
|
52793
|
+
metaobject?: CommerceMetaobject;
|
|
52794
|
+
});
|
|
52795
|
+
|
|
52796
|
+
export type UpdateCommerceMetaobjectError = (ErrorResponse | {
|
|
52797
|
+
error?: string;
|
|
52798
|
+
} | unknown);
|
|
52799
|
+
|
|
52800
|
+
export type DeleteCommerceMetaobjectData = {
|
|
52801
|
+
path: {
|
|
52802
|
+
/**
|
|
52803
|
+
* Platform-native id.
|
|
52804
|
+
*/
|
|
52805
|
+
metaobjectId: string;
|
|
52806
|
+
};
|
|
52807
|
+
query: {
|
|
52808
|
+
/**
|
|
52809
|
+
* Connected store SocialAccount id.
|
|
52810
|
+
*/
|
|
52811
|
+
accountId: string;
|
|
52812
|
+
};
|
|
52813
|
+
};
|
|
52814
|
+
|
|
52815
|
+
export type DeleteCommerceMetaobjectResponse = ({
|
|
52816
|
+
deleted?: boolean;
|
|
52817
|
+
metaobjectId?: string;
|
|
52818
|
+
});
|
|
52819
|
+
|
|
52820
|
+
export type DeleteCommerceMetaobjectError = (ErrorResponse | {
|
|
52821
|
+
error?: string;
|
|
52822
|
+
} | unknown);
|
|
52823
|
+
|
|
52824
|
+
export type ListCommerceMarketsData = {
|
|
52825
|
+
query: {
|
|
52826
|
+
/**
|
|
52827
|
+
* Connected store SocialAccount id.
|
|
52828
|
+
*/
|
|
52829
|
+
accountId: string;
|
|
52830
|
+
};
|
|
52831
|
+
};
|
|
52832
|
+
|
|
52833
|
+
export type ListCommerceMarketsResponse = ({
|
|
52834
|
+
markets?: Array<CommerceMarket>;
|
|
52835
|
+
});
|
|
52836
|
+
|
|
52837
|
+
export type ListCommerceMarketsError = (ErrorResponse | {
|
|
52838
|
+
error?: string;
|
|
52839
|
+
} | unknown);
|
|
52840
|
+
|
|
52841
|
+
export type ListCommercePriceListsData = {
|
|
52842
|
+
query: {
|
|
52843
|
+
/**
|
|
52844
|
+
* Connected store SocialAccount id.
|
|
52845
|
+
*/
|
|
52846
|
+
accountId: string;
|
|
52847
|
+
};
|
|
52848
|
+
};
|
|
52849
|
+
|
|
52850
|
+
export type ListCommercePriceListsResponse = ({
|
|
52851
|
+
priceLists?: Array<CommercePriceList>;
|
|
52852
|
+
});
|
|
52853
|
+
|
|
52854
|
+
export type ListCommercePriceListsError = (ErrorResponse | {
|
|
52855
|
+
error?: string;
|
|
52856
|
+
} | unknown);
|
|
52857
|
+
|
|
52858
|
+
export type SetCommercePriceListPricesData = {
|
|
52859
|
+
body: {
|
|
52860
|
+
accountId: string;
|
|
52861
|
+
prices: Array<{
|
|
52862
|
+
variantId: string;
|
|
52863
|
+
/**
|
|
52864
|
+
* Decimal in the price list currency.
|
|
52865
|
+
*/
|
|
52866
|
+
price: string;
|
|
52867
|
+
compareAtPrice?: (string) | null;
|
|
52868
|
+
}>;
|
|
52869
|
+
};
|
|
52870
|
+
path: {
|
|
52871
|
+
/**
|
|
52872
|
+
* Platform-native id.
|
|
52873
|
+
*/
|
|
52874
|
+
priceListId: string;
|
|
52875
|
+
};
|
|
52876
|
+
};
|
|
52877
|
+
|
|
52878
|
+
export type SetCommercePriceListPricesResponse = ({
|
|
52879
|
+
priceListId?: string;
|
|
52880
|
+
updated?: number;
|
|
52881
|
+
});
|
|
52882
|
+
|
|
52883
|
+
export type SetCommercePriceListPricesError = (ErrorResponse | {
|
|
52884
|
+
error?: string;
|
|
52885
|
+
} | unknown);
|
|
52886
|
+
|
|
52887
|
+
export type DeleteCommercePriceListPricesData = {
|
|
52888
|
+
path: {
|
|
52889
|
+
/**
|
|
52890
|
+
* Platform-native id.
|
|
52891
|
+
*/
|
|
52892
|
+
priceListId: string;
|
|
52893
|
+
};
|
|
52894
|
+
query: {
|
|
52895
|
+
/**
|
|
52896
|
+
* Connected store SocialAccount id.
|
|
52897
|
+
*/
|
|
52898
|
+
accountId: string;
|
|
52899
|
+
/**
|
|
52900
|
+
* Comma-separated ids.
|
|
52901
|
+
*/
|
|
52902
|
+
variantIds: string;
|
|
52903
|
+
};
|
|
52904
|
+
};
|
|
52905
|
+
|
|
52906
|
+
export type DeleteCommercePriceListPricesResponse = ({
|
|
52907
|
+
priceListId?: string;
|
|
52908
|
+
deleted?: number;
|
|
52909
|
+
});
|
|
52910
|
+
|
|
52911
|
+
export type DeleteCommercePriceListPricesError = (ErrorResponse | {
|
|
52912
|
+
error?: string;
|
|
52913
|
+
} | unknown);
|
|
52914
|
+
|
|
52915
|
+
export type UpsertCommerceMarketingActivityData = {
|
|
52916
|
+
body: {
|
|
52917
|
+
accountId: string;
|
|
52918
|
+
remoteId: string;
|
|
52919
|
+
title: string;
|
|
52920
|
+
url: string;
|
|
52921
|
+
previewImageUrl?: string;
|
|
52922
|
+
utm?: {
|
|
52923
|
+
campaign: string;
|
|
52924
|
+
source: string;
|
|
52925
|
+
medium: string;
|
|
52926
|
+
};
|
|
52927
|
+
tactic: 'ad' | 'post' | 'message' | 'newsletter' | 'link' | 'affiliate' | 'retargeting' | 'loyalty' | 'seo';
|
|
52928
|
+
channel: 'social' | 'search' | 'display' | 'email' | 'referral';
|
|
52929
|
+
status: 'active' | 'inactive' | 'paused' | 'scheduled';
|
|
52930
|
+
budget?: {
|
|
52931
|
+
type: 'daily' | 'lifetime';
|
|
52932
|
+
/**
|
|
52933
|
+
* Decimal in the store currency.
|
|
52934
|
+
*/
|
|
52935
|
+
amount: string;
|
|
52936
|
+
};
|
|
52937
|
+
/**
|
|
52938
|
+
* Decimal in the store currency.
|
|
52939
|
+
*/
|
|
52940
|
+
adSpend?: string;
|
|
52941
|
+
startedAt?: string;
|
|
52942
|
+
endedAt?: string;
|
|
52943
|
+
};
|
|
52944
|
+
};
|
|
52945
|
+
|
|
52946
|
+
export type UpsertCommerceMarketingActivityResponse = ({
|
|
52947
|
+
marketingActivity?: {
|
|
52948
|
+
id?: string;
|
|
52949
|
+
remoteId?: string;
|
|
52950
|
+
};
|
|
52951
|
+
});
|
|
52952
|
+
|
|
52953
|
+
export type UpsertCommerceMarketingActivityError = (ErrorResponse | {
|
|
52954
|
+
error?: string;
|
|
52955
|
+
} | unknown);
|
|
52956
|
+
|
|
52957
|
+
export type DeleteCommerceMarketingActivityData = {
|
|
52958
|
+
path: {
|
|
52959
|
+
/**
|
|
52960
|
+
* The remoteId given when recording it.
|
|
52961
|
+
*/
|
|
52962
|
+
remoteId: string;
|
|
52963
|
+
};
|
|
52964
|
+
query: {
|
|
52965
|
+
/**
|
|
52966
|
+
* Connected store SocialAccount id.
|
|
52967
|
+
*/
|
|
52968
|
+
accountId: string;
|
|
52969
|
+
};
|
|
52970
|
+
};
|
|
52971
|
+
|
|
52972
|
+
export type DeleteCommerceMarketingActivityResponse = ({
|
|
52973
|
+
deleted?: boolean;
|
|
52974
|
+
remoteId?: string;
|
|
52975
|
+
});
|
|
52976
|
+
|
|
52977
|
+
export type DeleteCommerceMarketingActivityError = (ErrorResponse | {
|
|
52978
|
+
error?: string;
|
|
52979
|
+
} | unknown);
|
|
52980
|
+
|
|
52981
|
+
export type AddCommerceMarketingEngagementData = {
|
|
52982
|
+
body: {
|
|
52983
|
+
accountId: string;
|
|
52984
|
+
date: string;
|
|
52985
|
+
impressions?: number;
|
|
52986
|
+
views?: number;
|
|
52987
|
+
clicks?: number;
|
|
52988
|
+
shares?: number;
|
|
52989
|
+
likes?: number;
|
|
52990
|
+
comments?: number;
|
|
52991
|
+
/**
|
|
52992
|
+
* Decimal in the store currency.
|
|
52993
|
+
*/
|
|
52994
|
+
adSpend?: string;
|
|
52995
|
+
};
|
|
52996
|
+
path: {
|
|
52997
|
+
/**
|
|
52998
|
+
* The remoteId given when recording it.
|
|
52999
|
+
*/
|
|
53000
|
+
remoteId: string;
|
|
53001
|
+
};
|
|
53002
|
+
};
|
|
53003
|
+
|
|
53004
|
+
export type AddCommerceMarketingEngagementResponse = ({
|
|
53005
|
+
remoteId?: string;
|
|
53006
|
+
recorded?: boolean;
|
|
53007
|
+
});
|
|
53008
|
+
|
|
53009
|
+
export type AddCommerceMarketingEngagementError = (ErrorResponse | {
|
|
53010
|
+
error?: string;
|
|
53011
|
+
} | unknown);
|
|
53012
|
+
|
|
53013
|
+
export type ListCommerceCatalogSyncsData = {
|
|
53014
|
+
query: {
|
|
53015
|
+
/**
|
|
53016
|
+
* Connected store SocialAccount id.
|
|
53017
|
+
*/
|
|
53018
|
+
accountId: string;
|
|
53019
|
+
};
|
|
53020
|
+
};
|
|
53021
|
+
|
|
53022
|
+
export type ListCommerceCatalogSyncsResponse = ({
|
|
53023
|
+
catalogSyncs?: Array<CommerceCatalogSync>;
|
|
53024
|
+
});
|
|
53025
|
+
|
|
53026
|
+
export type ListCommerceCatalogSyncsError = (ErrorResponse | {
|
|
53027
|
+
error?: string;
|
|
53028
|
+
} | unknown);
|
|
53029
|
+
|
|
53030
|
+
export type CreateCommerceCatalogSyncData = {
|
|
53031
|
+
body: {
|
|
53032
|
+
/**
|
|
53033
|
+
* The store SocialAccount id.
|
|
53034
|
+
*/
|
|
53035
|
+
accountId: string;
|
|
53036
|
+
catalogAccountId: string;
|
|
53037
|
+
/**
|
|
53038
|
+
* Meta product catalog id.
|
|
53039
|
+
*/
|
|
53040
|
+
catalogId: string;
|
|
53041
|
+
};
|
|
53042
|
+
};
|
|
53043
|
+
|
|
53044
|
+
export type CreateCommerceCatalogSyncResponse = ({
|
|
53045
|
+
catalogSync?: CommerceCatalogSync;
|
|
53046
|
+
});
|
|
53047
|
+
|
|
53048
|
+
export type CreateCommerceCatalogSyncError = (ErrorResponse | {
|
|
53049
|
+
error?: string;
|
|
53050
|
+
} | unknown);
|
|
53051
|
+
|
|
53052
|
+
export type GetCommerceCatalogSyncData = {
|
|
53053
|
+
path: {
|
|
53054
|
+
syncId: string;
|
|
53055
|
+
};
|
|
53056
|
+
};
|
|
53057
|
+
|
|
53058
|
+
export type GetCommerceCatalogSyncResponse = ({
|
|
53059
|
+
catalogSync?: CommerceCatalogSync;
|
|
53060
|
+
});
|
|
53061
|
+
|
|
53062
|
+
export type GetCommerceCatalogSyncError = (ErrorResponse | {
|
|
53063
|
+
error?: string;
|
|
53064
|
+
} | unknown);
|
|
53065
|
+
|
|
53066
|
+
export type DeleteCommerceCatalogSyncData = {
|
|
53067
|
+
path: {
|
|
53068
|
+
syncId: string;
|
|
53069
|
+
};
|
|
53070
|
+
};
|
|
53071
|
+
|
|
53072
|
+
export type DeleteCommerceCatalogSyncResponse = ({
|
|
53073
|
+
deleted?: boolean;
|
|
53074
|
+
syncId?: string;
|
|
53075
|
+
});
|
|
53076
|
+
|
|
53077
|
+
export type DeleteCommerceCatalogSyncError = (ErrorResponse | {
|
|
53078
|
+
error?: string;
|
|
53079
|
+
} | unknown);
|
|
53080
|
+
|
|
53081
|
+
export type RunCommerceCatalogSyncData = {
|
|
53082
|
+
path: {
|
|
53083
|
+
syncId: string;
|
|
53084
|
+
};
|
|
53085
|
+
};
|
|
53086
|
+
|
|
53087
|
+
export type RunCommerceCatalogSyncResponse = ({
|
|
53088
|
+
catalogSync?: CommerceCatalogSync;
|
|
53089
|
+
});
|
|
53090
|
+
|
|
53091
|
+
export type RunCommerceCatalogSyncError = (ErrorResponse | {
|
|
53092
|
+
error?: string;
|
|
53093
|
+
} | unknown);
|
|
53094
|
+
|
|
50792
53095
|
export type CreateVerificationData = {
|
|
50793
53096
|
body: {
|
|
50794
53097
|
/**
|